Skip to main content
API docs by Redocly

Admin API (v1alpha1)

Download OpenAPI specification:Download

Fluidstack Atlas Admin API

Regions

Get a list of regions

Returns a list of regions with their details.

Authorizations:
bearerAuth
header Parameters
X-ORG-ID
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organizations

Get a list of organizations

Returns a list of organizations with their details.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new organization

Creates a new organization with the provided details.

Authorizations:
bearerAuth
Request Body schema: application/json
required
display_name
required
string

The human readable name of the organization.

Responses

Request samples

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

Response samples

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
header Parameters
X-ORG-ID
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a member's role

Updates the role of a member in the current organization.

Authorizations:
bearerAuth
path Parameters
id
required
string

The unique identifier of the member to update.

header Parameters
X-ORG-ID
string
Request Body schema: application/json
required
role
string

The new role to assign to the member (e.g., admin, member, viewer).

Responses

Request samples

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

Response samples

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.

header Parameters
X-ORG-ID
string

Responses

Response samples

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
header Parameters
X-ORG-ID
string
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

Request samples

Content type
application/json
{
  • "email": "string",
  • "role": "string"
}

Response samples

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

Get invitations for an organization

Retrieves a list of invitations for the current organization.

Authorizations:
bearerAuth
header Parameters
X-ORG-ID
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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.

header Parameters
X-ORG-ID
string

Responses

Response samples

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

Usage

Query usage data

Query usage data aggregated by project and resource.

Authorizations:
bearerAuth
query Parameters
region
required
string

Region to query usage from.

start_time
required
string <date-time>

Start time in RFC 3339 format.

end_time
required
string <date-time>

End time in RFC 3339 format.

header Parameters
X-ORG-ID
string

Unique identifier for the organization.

Responses

Response samples

Content type
application/json
[
  • {
    }
]