API by router
Provision api
Provision Instance Api
Provision a new instance via API key.
Enforces:
- Rate limiting (5 per 5 min per user)
- Active subscription check
- Trial expiry check
- Per-customer instance quota
- Idempotency
"Yippee-ki-yay, motherf—" — John McClane, Die Hard (about deploying instances programmatically)
Header Parameters
X-Api-Key?X-Api-Key
display_name?Display Name
Human-readable name for the instance
end_user_id?End User Id
Optional end-user identifier for tracking
idempotency_key?Idempotency Key
Idempotency key to prevent duplicate provisions
preset_idPreset Id
Template preset ID (e.g. 'personal_assistant')
region_idRegion Id
Target region (e.g. 'eu-central')
tier_idTier Id
Product tier UUID
Response Body
curl -X POST "https://loading/v2/provision" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "preset_id": "string", "region_id": "string", "tier_id": "string" }'{
"idempotency_key": "string",
"instance_id": "string",
"message": "string",
"status": "string",
"task_id": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Provision Status
Check provisioning status of an instance.
"Are we there yet?" — Every kid on a road trip (about checking if provisioning is done)
Path Parameters
instance_idInstance Id
Format
uuidHeader Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v2/provision/497f6eca-6276-4993-bfeb-53cbbbba6f08/status" \ -H "X-Api-Key: string"{
"created_at": "2019-08-24T14:15:22Z",
"hostname": "string",
"instance_id": "string",
"ip_address": "string",
"status": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}