Skip to main content

Manage Filesystems

This guide provides an overview of how to create, resize, attach, and delete filesystems.

Create a Filesystem​

The region must support the filesystems:create capability in order to create a filesystem.

To create a filesystem via the API, send a POST request to the /filesystems endpoint:

POST /filesystems HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>
Content-Type: application/json

{
  "name": "test",
  "size": "100Gi"
}

Attach a Filesystem​

You can attach a filesystem to an instance during instance creation. This ensures the filesystem is mounted and available for use as soon as the instance is launched.

To attach a filesystem during instance creation via the API, include the filesystems field in the POST request to the /instances endpoint:

POST /instances HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>
Content-Type: application/json

{
  "name": "test",
  "type": "cpu.8x",
  "filesystems": ["<filesystem-id>"]
}

Resize a Filesystem​

info

It is not possible to shrink a filesystem once it has been grown. Ensure you allocate the correct size before resizing.

To resize a filesystem via the API, send a PUT request to the /filesystems/{id} endpoint:

PUT /filesystems/<uuid> HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>
Content-Type: application/json

{
  "name": "test",
  "size": "200Gi"
}

Delete a Filesystem​

The region must support the filesystems:delete capability in order to delete a filesystem.

caution

Deleting a filesystem is irreversible. Any data stored on the filesystem will be permanently lost and cannot be recovered. Ensure you back up any important data before proceeding.

To delete a filesystem via the API, send a DELETE request to the /filesystems/{id} endpoint:

DELETE /filesystems/<uuid> HTTP/1.1
Host: <your-cluster-url>
Authorization: Bearer <your-auth-token>