Create an instance
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.
- application/json
Request Body
Payload for create instances action
- oneOf
- Root Type for create free app instance Payload
- Root Type for onboard instance Payload
app_id string requiredApplication name.
is_eula_accepted boolean requiredSpecify
True
to accept the EULA.region string requiredIdentifies the region where this instance will be provisioned.
support_account_id string requiredThe support account ID used for this free license.
support_account_name string requiredThe support account used for this free license.
Array [allocation object[]
Array [allocation_size stringNumber of license units to allocate.
app_id stringApplication name.
license_type stringLicense SKU.
]allocation_type stringPossible values: [
FULL
,SHARED
]Indicates whether the license allocation is full or shared.
app_id string requiredApplication name.
is_eula_accepted booleanSpecify
True
to accept the EULA.license_id stringThe ID of the license you want to allocate. You can obtain license IDs using GET /subscription/v1/licenses.
platform_region stringIdentifies the region where this instance will be provisioned.
tenant_id stringCIE tenant ID that this tenant will use.
tsg_name stringIdentifies the child TSG to which this license is allocated.
]
- 200
- 400
Successful
- application/json
- Schema
- Example (from schema)
- create_instance_response
- onboard_instance_response
Schema
- oneOf
- Create free instance response
- Onboard instance response
job_id stringstatus stringtenant_id stringtenant_instance_name stringjob_id string
{
"job_id": "string",
"status": "string",
"tenant_id": "string",
"tenant_instance_name": "string"
}
{
"app_id": "directory_sync",
"job_id": "8dcad25f-3629-473b-9964-51bcbed53bb1",
"status": "initializing",
"tenant_id": 123456789,
"tenant_instance_name": "Cloud Identity Engine"
}
{
"job_id": "8dcad25f-3629-473b-9964-51bcbed53bb1"
}
Unsuccessful
- application/json
- Schema
- Example (from schema)
- instance_error_response
Schema
- application_code string
- application_error string
- error string
- message string
- statusCode string
{
"application_code": "string",
"application_error": "string",
"error": "string",
"message": "string",
"statusCode": "string"
}
{
"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
}