Skip to main content

Manage Instances

This guide provides an overview of how to create, update, and delete instances.

Create an Instance​

The region must support the instances:create capability in order to create an instance.

To create an instance via the REST API, send a POST request to the /instances endpoint:

POST /instances HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>
Content-Type: application/json

{
  "name": "example",
  "type": "cpu.8x",
}

Start an Instance​

To start an instance via the REST API, send a POST request to the /instances/{id}/actions/start endpoint:

POST /instances/<uuid>/actions/start HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>

Stop an Instance​

To stop an instance via the REST API, send a POST request to the /instances/{id}/actions/stop endpoint:

POST /instances/<uuid>/actions/stop HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>

Delete an Instance​

The region must support the instances:delete capability in order to delete an instance.

caution

Deleting an instance is irreversible. Any data stored on the instance's boot disk will be permanently lost and cannot be recovered. Ensure you back up any important data before proceeding.

To delete an instance via the REST API, send a DELETE request to the /instances/{id} endpoint:

DELETE /instances/<uuid> HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>