This endpoint is used to retrieve a list of all instances associated with the authenticated user.

List user instances

Create a new instance

This endpoint is used to retrieve a single instance associated with the authenticated user by its ID.

Fetch a single user instance

This endpoint is used to terminate an existing instance by its ID.

Terminate an instance

This endpoint is used to stop an existing instance by its ID.

Stop an instance

This endpoint is used to start an existing instance by its ID.

Start an instance

Instances

Fetch a list of SSH key names associated with the authenticated user.

List SSH keys

Create an SSH key

Delete an SSH key

SSH Keys

List available configurations including GPU type, GPU count, RAM size, and disk size.

List available configurations

Configurations

List available OS template images

Templates

ConfigurationInstanceResponse

The amount of RAM memory in the configuration.

ConfigurationResponse

The price per GPU hour of the configuration.

The regions the configuration is available in.

CreateInstanceResponse

EntityId

GPUModelResponse

The FluidStack unique name of the GPU model.

GPUType

HTTPValidationError

HealthCheckOutSchema

InstanceResponse

The username used to connect to the instance. For example, to connect to the instance via SSH, use: "ssh -i <path/to/private/key> <username>@<ip_address>".

The SSH port used to connect to the instance.

The names of the SSH keys used to login to the instance.

The name provided when the instance was created.

The current hourly price of the instance per processor based on its current status.

The configuration used to create the instance.

The creation date and time of the instance.

InstanceStatus

ListInstanceResponse

Message

OperatingSystemResponse

The friendly name of the operating system.

The description of the operating system, detailing the pre-installed packages and customisations, if any.

1	curl https://platform.fluidstack.io/list_available_os_templates \
2	-H "api-key: <api-key>"

1	[
2	{
3	"name": "Ubuntu 20.04 LTS (Nvidia)",
4	"description": "Ubuntu 20.04 LTS with Nvidia/CUDA 12 drivers preinstalled",
5	"label": "ubuntu_20_04_lts_nvidia"
6	}
7	]