Volumes

Get a shared volume (the project’s own, or an org-shared volume of its organization)

get/v1/projects/{project_id}/volumes/{volume_id}

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/projects/{project_id}/volumes/{volume_id}
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

UUIDv7, lowercase canonical form.

volume_idstring uuid required

UUIDv7, lowercase canonical form.

Response

Default Response

idstring uuid required

UUIDv7, lowercase canonical form.

organization_idstring uuid required

UUIDv7, lowercase canonical form.

project_idstring uuid required

UUIDv7, lowercase canonical form.

namestring required
kind'shared' | 'project_space'

shared: customer storage; project_space: platform-managed conversation storage.

quota_gibinteger required

Requested size limit (GiB). Enforcement of the quota on the file system is the cell’s; usage.quota_exceeded reports it.

org_sharedboolean required

Attachable to workspaces of every project of the organization (otherwise only its own project).

backup_policy'filesystem' required

filesystem: covered by the environment file system’s daily AWS Backup plan; a restore creates a new volume.

state'creating' | 'available' | 'deleting' | 'deleted' | 'failed' required

creating -> available -> deleting -> deleted; failed (see error). Executed by the cell.

state_reasonstring nullable required
live_attachmentsinteger required

Attachments in attaching|attached|detaching.

created_atstring date-time required

RFC 3339 UTC timestamp with Z.

updated_atstring date-time required

RFC 3339 UTC timestamp with Z.

delete_requested_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

deleted_atstring date-time nullable required

RFC 3339 UTC timestamp with Z.

Changes

No recorded changes to this operation across all 1 revision of this API.