Deploy a New Instance
The API deploys Ubuntu VPS instances only. For other VPS templates (Coolify, Dokploy, etc.), use AI Deploy or the web dashboard.
Request Body
Example Request
Response (202 Accepted)
The instance is created asynchronously. The response includes connection credentials and astatus field that starts as pending.
The
ssh_key.private_key field is only included when you do not provide your own ssh_public_key. Store it securely — it is not retrievable later.Polling for Readiness
After deploying, poll the instance detail endpoint untilstatus changes from pending/Deploying to Online:
status is Online and ipv4 is populated, the server is ready for SSH connections.
Available Flavors
Error Responses
Connecting to Your Instance
Once the instance status isOnline:
