Management API

• Regions
  • getGet a list of regions
• Clusters
  • getGet a list of clusters
• Organizations
  • getGet a list of organizations
• Members
  • getGet a list of members
  • patchUpdate a member
  • delDelete a member
• Invitations
  • postInvite a user to an organization
  • getGet invitations for an organization
  • delDelete an invitation
• Instances
  • getList all instances
  • getGet an instance
• User
  • getList public SSH keys registered for the authenticated user.
  • postRegister a public SSH key for the authenticated user.
  • delDeregister an SSH key for the authorized user.

API docs by Redocly

Management API (v1alpha1)

Download OpenAPI specification:Download

The global API for Fluidstack

Regions

Get a list of regions

Returns a list of regions with their details.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/regions

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "url": "string"

  }

]

Clusters

Get a list of clusters

Returns a list of clusters belonging to the user's organization.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/clusters

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "region": "string",
  • "type": "kubernetes",
  • "project_id": "string",
  • "health": "healthy",
  • "updated_at": "2019-08-24T14:15:22Z"

  }

]

Organizations

Get a list of organizations

Returns a list of organizations with their details.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/organizations

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "display_name": "string"

  }

]

Members

Get a list of members

Returns a list of members in the current organization.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/members

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "email": "string",
  • "role": "string"

  }

]

Update a member

Updates the a member in the current organization.

Authorizations:

bearerAuth

path Parameters

id required

string The unique identifier of the member to update.

Request Body schema: application/json

required

role	string Enum: "admin" "editor" "viewer" The new role to assign to the member (e.g., admin, member, viewer).

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/members/{id}

Request samples

• Payload

Content type

application/json

{

• "role": "admin"

}

Response samples

• 400
• 401
• 404
• 500

Content type

application/json

{

• "message": "string"

}

Delete a member

Deletes a member from the current organization by their unique identifier.

Authorizations:

bearerAuth

path Parameters

id required

string The unique identifier of the member to delete.

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/members/{id}

Response samples

• 401
• 404
• 500

Content type

application/json

{

• "message": "string"

}

Invitations

Invite a user to an organization

Sends an invitation to a user to join the current organization.

Authorizations:

bearerAuth

Request Body schema: application/json

required

email required	string The email address of the user to invite.
role	string The role to assign to the user (e.g., admin, member, viewer).

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/invitations

Request samples

• Payload

Content type

application/json

{

• "email": "string",
• "role": "string"

}

Response samples

• 400
• 401
• 500

Content type

application/json

{

• "message": "string"

}

Get invitations for an organization

Retrieves a list of invitations for the current organization.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/invitations

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "email": "string",
  • "role": "string"

  }

]

Delete an invitation

Deletes an invitation by its unique identifier.

Authorizations:

bearerAuth

path Parameters

id required

string The unique identifier of the invitation to delete.

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/invitations/{id}

Response samples

• 401
• 404
• 500

Content type

application/json

{

• "message": "string"

}

Instances

List all instances

Returns a list of all instances belonging to the user's organization. Optionally filter by project.

Authorizations:

bearerAuth

header Parameters

X-PROJECT-ID

string <uuid> Filter instances by project ID

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/instances

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "string",
  • "state": "creating",
  • "ip": "string",
  • "image": "string",
  • "preemptible": true,
  • "ephemeral": true,
  • "tags": {

    • "property1": "string",
    • "property2": "string"

    },
  • "project_id": "string",
  • "region": "string",
  • "health": "healthy",
  • "updated_at": "2019-08-24T14:15:22Z"

  }

]

Get an instance

Returns details of a specific instance.

Authorizations:

bearerAuth

path Parameters

id required

string <uuid> Unique identifier of the instance

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/instances/{id}

Response samples

• 200
• 401
• 404
• 500

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "string",
• "type": "string",
• "state": "creating",
• "ip": "string",
• "image": "string",
• "preemptible": true,
• "ephemeral": true,
• "tags": {

  • "property1": "string",
  • "property2": "string"

  },
• "project_id": "string",
• "region": "string",
• "health": "healthy",
• "updated_at": "2019-08-24T14:15:22Z"

}

User

List public SSH keys registered for the authenticated user.

Authorizations:

bearerAuth

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/user/keys

Response samples

• 200
• 401
• 500

Content type

application/json

[

• {

  • "name": "key-1",
  • "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEaSkijEWFbnjixzWRw3u2spZZaeVeWO5/ymySevCvXh"

  }

]

Register a public SSH key for the authenticated user.

Authorizations:

bearerAuth

Request Body schema: application/json

required

name required	string The name of the key.
key required	string The key.

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/user/keys

Request samples

• Payload

Content type

application/json

{

• "name": "key-1",
• "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIEaSkijEWFbnjixzWRw3u2spZZaeVeWO5/ymySevCvXh"

}

Response samples

• 401
• 409
• 500

Content type

application/json

{

• "message": "string"

}

Deregister an SSH key for the authorized user.

Authorizations:

bearerAuth

path Parameters

name required

string Name of the key

Responses

https://api.atlas.fluidstack.io/api/v1alpha1/user/keys/{name}

Response samples

• 401
• 404
• 500

Content type

application/json

{

• "message": "string"

}