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.
- CLI
- API
Use the fluidctl instances create
command to create a new instance. As an example, you can create an instance with the following command:
fluidctl instances create --name example --type cpu.8x
--name
: The name of the instance.--type
: The instance type (e.g.,cpu.8x
,h100-hgx-80gb.8x
).
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
- CLI
- API
Use the fluidctl instances start
command to start an instance. As an example, you can start an instance named test
with the following command:
fluidctl instances start --id <uuid>
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
- CLI
- API
Use the fluidctl instances stop
command to stop an instance. As an example, you can stop an instance named test
with the following command:
fluidctl instances stop --id <uuid>
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.
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.
- CLI
- API
Use the fluidctl instances delete
command to delete an instance. As an example, you can delete an instance named test
with the following command:
fluidctl instances delete --id <uuid>
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>