Manage Projects

This guide provides an overview of how to manage projects.

List Projects

CLI

Use the fluidctl projects list command to list all projects:

fluidctl projects list --region <region>

API

To list all projects via the REST API, send a GET request to the /projects endpoint:

GET /projects HTTP/1.1
Host: <region>.atlas.fluidstack.io
Authorization: Bearer <token>

Get Project Details

CLI

Use the fluidctl projects describe command to get details of a specific project:

fluidctl projects describe --region <region> --id <project-id>

API

To get project details via the REST API, send a GET request to the /projects/{id} endpoint:

GET /projects/<project-id> HTTP/1.1
Host: <region>.atlas.fluidstack.io
Authorization: Bearer <token>

Create a Project

CLI

Use the fluidctl projects create command to create a project:

fluidctl projects create --region <region> --name "project-1"

info

The region must support the projects:create capability in order to create a project.

API

To create a project via the REST API, send a POST request to the /projects endpoint:

POST /projects HTTP/1.1
Host: <region>.atlas.fluidstack.io
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "project-1"
}

Delete a Project

The region must support the projects:delete capability in order to delete a project.

caution

Deleting a project is irreversible. Any associated resources will also be deleted. Ensure you back up any important data before proceeding.

CLI

Use the fluidctl projects delete command to delete a project:

fluidctl projects delete --region <region> --id <uuid>

API

To delete a project via the REST API, send a DELETE request to the /projects/{id} endpoint:

DELETE /projects/<uuid> HTTP/1.1
Host: <region>.atlas.fluidstack.io
Authorization: Bearer <token>