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 required

  Application name.

• is_eula_accepted boolean required

  Specify True to accept the EULA.

• region string required

  Identifies the region where this instance will be provisioned.

• support_account_id string required

  The support account ID used for this free license.

• support_account_name string required

  The support account used for this free license.

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 string required

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.

]