Skip to main content
API docs by Redocly

Infrastructure API (v1alpha1)

Download OpenAPI specification:Download

The regional API for Fluidstack

Projects

Create a project

Authorizations:
bearerAuth
Request Body schema: application/json
required

Details of the project to create

name
required
string

Name of the project

object

Tags for the project. Tag keys must be 1–63 characters, start and end with alphanumerics, and may include -, _, and ..

Responses

Request samples

Content type
application/json
{
  • "name": "project-1",
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "project-1",
  • "state": "active",
  • "tags": {
    }
}

List all projects

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a project

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the project

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "project-1",
  • "state": "active",
  • "tags": {
    }
}

Delete a project

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the project to delete

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Instances

Create a machine instance

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Details of the instance to create

name
required
string

Name of the instance

type
required
string

Instance type

image
string
Default: "image://ubuntu22.04"

Operating system image for the instance

preemptible
boolean
Default: false

Whether the instance is preemptible

ephemeral
boolean
Default: false

Whether the instance is ephemeral

userData
string or null <byte>
Default: null

Base64-encoded cloud-init user data for instance initialization

filesystems
Array of strings <uuid> [ items <uuid > ]

List of filesystem UUIDs attached to the instance

object

Tags for the instance. Tag keys must be 1–63 characters, start and end with alphanumerics, and may include -, _, and ..

Responses

Request samples

Content type
application/json
{
  • "name": "instance-1",
  • "type": "h100.8x",
  • "image": "image://ubuntu22.04",
  • "preemptible": false,
  • "ephemeral": false,
  • "userData": "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIG5naW54\n",
  • "filesystems": [
    ],
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "instance-1",
  • "type": "h100.8x",
  • "ip": "10.0.0.2",
  • "state": "running",
  • "image": "ubuntu22.04",
  • "preemptible": false,
  • "ephemeral": false,
  • "userData": "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIG5naW54\n",
  • "filesystems": [
    ],
  • "tags": {
    }
}

List all machine instances

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a machine instance

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the instance

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "instance-1",
  • "type": "h100.8x",
  • "ip": "10.0.0.2",
  • "state": "running",
  • "image": "ubuntu22.04",
  • "preemptible": false,
  • "ephemeral": false,
  • "userData": "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIG5naW54\n",
  • "filesystems": [
    ],
  • "tags": {
    }
}

Delete a machine instance

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the instance

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Start a machine instance

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the instance

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Stop a machine instance

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the instance

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Instance Types

List all available instance types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Filesystems

Create a filesystem

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Details of the filesystem to create

name
required
string

Name of the filesystem

size
required
string

Size of the filesystem in GB

Responses

Request samples

Content type
application/json
{
  • "name": "fs-1",
  • "size": "512Gi"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174002",
  • "name": "fs-1",
  • "size": "512Gi"
}

List all filesystems

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a filesystem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the filesystem

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174002",
  • "name": "fs-1",
  • "size": "512Gi"
}

Delete a filesystem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the filesystem

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Kubernetes

List all clusters

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Kubernetes cluster

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Details of the Kubernetes cluster to create

name
required
string

The cluster name.

version
required
string

The cluster version.

podCIDRBlock
required
string
Default: "10.233.0.0/18"

The CIDR block for pod IPs in the cluster.

serviceCIDRBlock
required
string
Default: "10.233.64.0/18"

The CIDR block for service IPs in the cluster.

object

Definition of the default node pool for the cluster

Responses

Request samples

Content type
application/json
{
  • "name": "cluster-01",
  • "version": "1.32.5",
  • "podCIDRBlock": "10.233.0.0/18",
  • "serviceCIDRBlock": "10.233.64.0/18",
  • "defaultNodePool": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "cluster-01",
  • "version": "1.32.1",
  • "endpoint": "https://api.cluster-01.example.com",
  • "certificateAuthorityData": "string",
  • "status": {
    }
}

Get a cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the kubernetes cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "cluster-01",
  • "version": "1.32.1",
  • "endpoint": "https://api.cluster-01.example.com",
  • "certificateAuthorityData": "string",
  • "status": {
    }
}

Update a Kubernetes cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the kubernetes cluster to update

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Updated details of the Kubernetes cluster

version
string^v([0-9]+)\.([0-9]+)(\.([0-9]+))?$

The new cluster version.

Responses

Request samples

Content type
application/json
{
  • "version": "v1.32.5"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "cluster-01",
  • "version": "1.32.1",
  • "endpoint": "https://api.cluster-01.example.com",
  • "certificateAuthorityData": "string",
  • "status": {
    }
}

Delete a Kubernetes cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the kubernetes cluster to delete

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List all node pools for a cluster

Authorizations:
bearerAuth
path Parameters
cluster_id
required
string <uuid>

Unique identifier of the cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a node pool

Authorizations:
bearerAuth
path Parameters
cluster_id
required
string <uuid>

Unique identifier of the cluster

node_pool_id
required
string <uuid>

Unique identifier of the node pool

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "pool-01",
  • "cluster": "cluster-01",
  • "type": "h100.8x",
  • "count": 3,
  • "version": "1.32.1",
  • "nodes": [
    ]
}

Get kubeconfig credentials for a cluster

Authorizations:
bearerAuth
path Parameters
cluster_id
required
string <uuid>

Unique identifier of the kubernetes cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Slurm

List all clusters

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "cluster-01",
  • "version": "24.05.6",
  • "loginNodes": [
    ]
}

List all node pools for a cluster

Authorizations:
bearerAuth
path Parameters
cluster_id
required
string <uuid>

Unique identifier of the cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a node pool

Authorizations:
bearerAuth
path Parameters
cluster_id
required
string <uuid>

Unique identifier of the cluster

node_pool_id
required
string <uuid>

Unique identifier of the node pool

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174003",
  • "name": "pool-01",
  • "type": "h100.8x",
  • "count": 3,
  • "nodes": [
    ]
}

List users on a Slurm cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a user to a Slurm cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Add a user to a Slurm cluster

username
required
string

Username of the user.

sshKeys
required
Array of strings

SSH public keys authorized for the user.

sudo
boolean
Default: false

Whether the user has sudo access. Defaults to false if not specified.

Responses

Request samples

Content type
application/json
{
  • "username": "user01",
  • "sshKeys": [
    ],
  • "sudo": false
}

Response samples

Content type
application/json
{
  • "username": "user01",
  • "sshKeys": [
    ],
  • "sudo": false
}

Get a user on a Slurm cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

username
required
string

Username of the user

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "username": "user01",
  • "sshKeys": [
    ],
  • "sudo": false
}

Update a user's SSH keys on a Slurm cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

username
required
string

Username of the user

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Request Body schema: application/json
required

Updated SSH keys for the user

sshKeys
required
Array of strings

Updated SSH public keys for the user.

sudo
boolean

Whether the user has sudo access. If not provided, the current value is preserved.

Responses

Request samples

Content type
application/json
{
  • "sshKeys": [
    ],
  • "sudo": false
}

Response samples

Content type
application/json
{
  • "username": "user01",
  • "sshKeys": [
    ],
  • "sudo": false
}

Delete a user from a Slurm cluster

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Unique identifier of the cluster

username
required
string

Username of the user

header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Capacity

List available capacity

Authorizations:
bearerAuth
header Parameters
X-PROJECT-ID
required
string <uuid>

Project identifier passed as a header

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Capabilities

List available capabilities

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • "instances:list",
  • "slurm:clusters:list"
]