Skip to main content
POST
/
partner
/
instances
/
create
Create Instances Endpoint
curl --request POST \
  --url https://api.example.com/partner/instances/create \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'instance_type=<string>' \
  --data 'is_consulting=<string>' \
  --data 'parent_instance_id=<string>' \
  --data 'name=<string>' \
  --data 'short_name=<string>' \
  --data 'country=<string>' \
  --data 'email=<string>' \
  --data 'mfa_type=<string>' \
  --data 'tenant_id=<string>' \
  --data 'state=<string>' \
  --data 'city=<string>' \
  --data 'postal=<string>' \
  --data 'street=<string>'
{
  "instance_id": "<string>",
  "agent_key": "<string>"
}

Headers

Authorization
string

Body

application/x-www-form-urlencoded

Request data for creating a new instance.

instance_type
string
required

Type of the instance to be created.

Minimum string length: 1
is_consulting
string
required

Indicates if the instance is for consulting.

Minimum string length: 1
parent_instance_id
string
required

ID of the parent instance.

Minimum string length: 1
name
string
required

Name of the instance.

Minimum string length: 1
short_name
string
required

Short name of the instance.

Minimum string length: 1
country
string
required

Country of the instance.

Minimum string length: 1
email
string
required

Email associated with the instance.

Minimum string length: 1
mfa_type
string | null

Type of multi-factor authentication.

tenant_id
string | null

Tenant ID of the instance.

state
string | null

Phone number associated with the instance.

city
string | null

City of the instance.

postal
string | null

Postal code of the instance.

street
string | null

Street address of the instance.

Response

OK

Represents the JSON structure for creating a new instance.

instance_id
string | null

The unique identifier for the created instance.

agent_key
string | null

The agent key associated with the created instance.