Volumes

Named-volume management under a stack — inspect, backup/restore, scheduled backup config, and seed (upload / inline / file write).

List stack volumes

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes

auth_token (cookie)

Bearer

List the named volumes discovered for the stack, each with its backup configuration when set.

List stack volumes › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

List stack volumes › Responses

List of volumes

object[]

Get a stack volume

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}

auth_token (cookie)

Bearer

Returns metadata for a single named volume, including its backup configuration.

Get a stack volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Get a stack volume › Responses

Volume metadata

List a volume's file tree

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/tree

auth_token (cookie)

Bearer

Returns the directory tree of the volume's contents on the VM. The stack must have been deployed.

List a volume's file tree › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

List a volume's file tree › Responses

File tree

Set the scheduled-backup config for a volume

PUT

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/backup-config

auth_token (cookie)

Bearer

Enable/disable and schedule automatic backups for the volume.

Set the scheduled-backup config for a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Set the scheduled-backup config for a volume › Request Body

preset

string · enum · required

Enum values:

hourly

daily

weekly

retention

integer · min: 1 · max: 365 · required

Number of backups to retain

enabled

boolean

at_time

string

"HH:MM" UTC — optional for hourly

Set the scheduled-backup config for a volume › Responses

Backup config saved

Trigger a volume backup now

POST

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/backup

auth_token (cookie)

Bearer

Starts an on-demand backup of the volume to S3. Returns the backup job handle. The stack must have been deployed.

Trigger a volume backup now › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Trigger a volume backup now › Responses

Backup job started

Delete a stored backup

DELETE

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/backup

auth_token (cookie)

Bearer

Permanently deletes a single backup archive, identified by its key in the request body (the key contains slashes, hence not a path param).

Delete a stored backup › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Delete a stored backup › Request Body

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/backups/jobs

auth_token (cookie)

Bearer

Lists the recent asynchronous backup and restore jobs for this volume.

List backup/restore jobs for a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

Job status

List restore jobs for a volume

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/restore-jobs

auth_token (cookie)

Bearer

Returns the recent restore jobs recorded for this volume, newest first.

List restore jobs for a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

List restore jobs for a volume › query Parameters

limit

integer · min: 1 · max: 200

Max number of rows to return. Capped at 200.

Default: 50

List restore jobs for a volume › Responses

List of restore jobs (empty array if none)

object[]

Get a restore job

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/restore-jobs/{jobId}

auth_token (cookie)

Bearer

Returns the status of a single restore job. Polls the backbone and write-through updates the stored job when it is still in progress.

Get a restore job › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

jobId

string · uuid · required

Restore job identifier

Get a restore job › Responses

Restore job status

Issue a presigned upload URL for seeding

POST

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/seed/upload-url

auth_token (cookie)

Bearer

Returns a presigned S3 URL the client uploads a .tar archive to, before calling seed/apply. The stack must have been deployed.

Issue a presigned upload URL for seeding › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Issue a presigned upload URL for seeding › Responses

Presigned upload URL (and object key)

Apply a previously-uploaded seed archive

POST

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/seed/apply

auth_token (cookie)

Bearer

Extracts the .tar archive (referenced by its upload key) into the volume's path on the VM. Journaled as a seed stack activity.

Apply a previously-uploaded seed archive › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Apply a previously-uploaded seed archive › Request Body

key

string · required

Object key returned by seed/upload-url

Apply a previously-uploaded seed archive › Responses

Seed applied

Seed a single inline file

POST

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/seed/inline

auth_token (cookie)

Bearer

Writes one small file directly into the volume, content passed inline (no upload round-trip). Journaled as a seed stack activity.

Seed a single inline file › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Seed a single inline file › Request Body

filename

string · maxLength: 255 · required

content

string

mode

integer

Optional unix mode (e.g. 420 for 0644); 0 falls back to 0644

Seed a single inline file › Responses

File written

Read a file from a volume

GET

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/file

auth_token (cookie)

Bearer

Returns the contents of a single file inside the volume. The stack must have been deployed.

Read a file from a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Read a file from a volume › query Parameters

path

string · required

File path within the volume

Read a file from a volume › Responses

File contents

Write a file to a volume

PUT

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/file

auth_token (cookie)

Bearer

Creates or overwrites a single file inside the volume. The stack must have been deployed.

Write a file to a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Write a file to a volume › Request Body

path

string · required

content

string

mode

string

Optional unix mode, e.g. "0644"

encoding

string

Optional content encoding (e.g. base64)

Write a file to a volume › Responses

File written

Delete a file from a volume

DELETE

/api/v1

/projects/{projectId}/stacks/{stackId}/volumes/{volumeName}/file

auth_token (cookie)

Bearer

Removes a single file inside the volume, path passed in the body. The stack must have been deployed.

Delete a file from a volume › path Parameters

projectId

string · uuid · required

Project unique identifier

stackId

string · uuid · required

Stack unique identifier

volumeName

string · required

Named volume identifier (as declared in the stack's docker compose)

Delete a file from a volume › Request Body

path

string · required

Delete a file from a volume › Responses

File deleted

No data returned

Billing Domain Zones