Skip to main content

List Instances

Retrieve all Ubuntu VPS instances created through the API for your account.

Example Request

Response (200 OK)

Returns an array of instance objects, sorted by creation date (newest first).
This endpoint only returns instances created through the API (those with an associated API key). Instances deployed through the web dashboard or AI Deploy are not included.

Instance Statuses


Get Instance Detail

Retrieve detailed information about a specific instance, including live status from the control plane.

Path Parameters

Example Request

Response (200 OK)

The detail endpoint fetches live status from the control plane, so status reflects the current server state (not just the last-known DB state).

Error Responses


Delete Instance

Permanently destroy a VPS instance and release its IPv4 address.

Path Parameters

Example Request

Response (200 OK)

The job_id can be used to track deletion progress if needed. The instance is removed from the database immediately.
Deletion is irreversible. All data on the server, including snapshots, is permanently removed.

Error Responses