Create a new instance
Create a new instance with the provided details
Authorization
bearerAuth write:instancesAuthorizationBearer <token>
A JWT verified by the proxy in front of this API, or a Kaiten access token (ksh_...) — send either as Authorization: Bearer <token>. The scopes listed on each operation are the ones the token must carry; write:<module> implies read:<module>, and read:* / write:* are wildcards over every module. x-kaiten-scopes lists every scope such a token can carry, including those enforced by a service in front of this API rather than by one of its operations.
In: header
Scope: write:instances
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://app.kaiten.sh/api/instances" \ -H "Content-Type: application/json" \ -d '{ "customerId": "123e4567-e89b-12d3-a456-426614174003", "description": "This is a sample instance description", "endLicenseDate": "2024-10-01T12:00:00Z", "licenseId": "123e4567-e89b-12d3-a456-426614174004", "name": "My Instance", "startLicenseDate": "2023-10-01T12:00:00Z" }'{
"createdAt": "2023-10-01T12:00:00Z",
"createdBy": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe"
},
"customerId": "123e4567-e89b-12d3-a456-426614174003",
"customerSlug": "acme-corp",
"deploymentZoneId": "123e4567-e89b-12d3-a456-426614174005",
"deploymentZoneSlug": "aws-us-west-2",
"description": "This is a sample instance description",
"endLicenseDate": "2024-10-01T12:00:00Z",
"id": "123e4567-e89b-12d3-a2456-426614174000",
"integrations": {
"property1": {
"external_id": "rec_12345",
"last_error": "string",
"metadata": {
"property1": null,
"property2": null
},
"synced_at": "2019-08-24T14:15:22Z",
"web_url": "https://app.attio.com/w/acme/workspace/rec_12345"
},
"property2": {
"external_id": "rec_12345",
"last_error": "string",
"metadata": {
"property1": null,
"property2": null
},
"synced_at": "2019-08-24T14:15:22Z",
"web_url": "https://app.attio.com/w/acme/workspace/rec_12345"
}
},
"licenseId": "123e4567-e89b-12d3-a456-426614174004",
"licenseSlug": "my-license",
"lifecycleStage": "ACTIVE",
"metadata": {
"key": "value"
},
"name": "My Instance",
"slug": "my-instance",
"startLicenseDate": "2023-10-01T12:00:00Z",
"status": "HEALTHY",
"updatedAt": "2023-10-01T12:00:00Z",
"updatedBy": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe"
}
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}