Skip to main content

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 a status 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 until status changes from pending/Deploying to Online:
Typical provisioning takes 2–5 minutes. Once status is Online and ipv4 is populated, the server is ready for SSH connections.

Available Flavors

The s-1vcpu-1gb flavor ($3/month) is not available for VPS instances. It is reserved for Container Apps only.

Error Responses

Connecting to Your Instance

Once the instance status is Online:
Use the root password from the deploy response, or the SSH key you provided/received.