API by router
Provision api
POST
X-Api-Key?string|nullapplication/json- body
Self-provisioning request from a PaaS customer's application.
"I need your clothes, your boots, and your motorcycle." — T-800 (about what we need to provision an instance)
display_name?|Human-readable name for the instance
end_user_id?|Optional end-user identifier for tracking
idempotency_key?|Idempotency key to prevent duplicate provisions
preset_id*Preset IdTemplate preset ID (e.g. 'personal_assistant')
region_id*Region IdTarget region (e.g. 'eu-central')
tier_id*Tier IdProduct tier UUID
Successful Response
application/json- response
Provisioning result.
idempotency_key*Idempotency Keyinstance_id*Instance Idmessage*Messagestatus*Statustask_id*Task Idcurl -X POST 'https://example.com/v2/provision' \ -H 'Content-Type: application/json' \ -d '{ "preset_id": "string", "region_id": "string", "tier_id": "string"}'Example Response
{ "idempotency_key": "string", "instance_id": "string", "message": "string", "status": "string", "task_id": "string"}GET
instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Quick status check for a provisioned instance.
created_at*Created AtFormat
date-timehostname?string|nullinstance_id*Instance Idip_address?string|nullstatus*Statuscurl -X GET 'https://example.com/v2/provision/497f6eca-6276-4993-bfeb-53cbbbba6f08/status'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "hostname": "string", "instance_id": "string", "ip_address": "string", "status": "string"}