Create an instance

POST 
/subscription/v1/instances

Create an instance that is a child of the TSG identified in the access token used to authorize this request. That is, use this API to allocate a license to a child tenant.

Before you can allocate a license using this call, you must first manually claim or activate the license. How you do this is determined by whether you are a multitenant or single tenant user.

This API is asynchronous. It creates a provisioning job. You cannot configure your instance until the provisioning is complete. Use GET /subscription/v1/instances to check the instance's provisioning status.

Request

application/json

Body

Payload for create instances action

oneOf
Root Type for create free app instance Payload
app_id stringrequired
Application name.
is_eula_accepted booleanrequired
Specify True to accept the EULA.
region stringrequired
Identifies the region where this instance will be provisioned.
support_account_id stringrequired
The support account ID used for this free license.
support_account_name stringrequired
The support account used for this free license.
Root Type for onboard instance Payload
Array [
allocation object[]
Array [
allocation_size string
Number of license units to allocate.
app_id string
Application name.
license_type string
License SKU.
]
allocation_type string
Possible values: [FULL, SHARED]
Indicates whether the license allocation is full or shared.
app_id stringrequired
Application name.
is_eula_accepted boolean
Specify True to accept the EULA.
license_id string
The ID of the license you want to allocate. You can obtain license IDs using GET /subscription/v1/licenses.
platform_region string
Identifies the region where this instance will be provisioned.
tenant_id string
CIE tenant ID that this tenant will use.
tsg_name string
Identifies the child TSG to which this license is allocated.
]

Responses

200

Successful

application/json

Schema

Schema

oneOf
Create free instance response
job_id string
status string
tenant_id string
tenant_instance_name string
Onboard instance response
job_id string

Example (from schema)

{}

create_instance_response

{
  "app_id": "directory_sync",
  "job_id": "8dcad25f-3629-473b-9964-51bcbed53bb1",
  "status": "initializing",
  "tenant_id": 123456789,
  "tenant_instance_name": "Cloud Identity Engine"
}

onboard_instance_response

{
  "job_id": "8dcad25f-3629-473b-9964-51bcbed53bb1"
}

400

Unsuccessful

application/json

Schema

Schema

application_code string
application_error string
error string
message string
statusCode string

Example (from schema)

{
  "application_code": "string",
  "application_error": "string",
  "error": "string",
  "message": "string",
  "statusCode": "string"
}

instance_error_response

{
  "application_code": "SUB_SERVICE_1004",
  "application_error": "license_not_found_in_db",
  "error": "Bad Request",
  "message": "SUB_SERVICE_1004:license_not_found_in_db",
  "statusCode": 400
}

Loading...