MImicrosandbox
volumes

Get the default volume

Changed on
get/v1/orgs/{slug}/volumes/default

Request

  • Base URL
    https://api.microsandbox.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://api.microsandbox.dev/v1/orgs/{slug}/volumes/default
  • Auth
    HTTP bearer

Path parameters

slugstring required

Organization slug

Response

Get the default volume

capacity_bytesinteger nullable

The volume's configured per-volume storage cap in bytes, or null when no cap is set (#496). Derived from the stored capacity_gib (the user's configured intent) — the effective ceiling is min(this, org cap).

created_atstring date-time required
idstring uuid required
kind'host' | 'managed' required

Volume role: the organization's shared host volume or a named managed volume.

labelsobject required

User-defined labels (empty object when none set).

namestring nullable

User-facing name. null for the host volume (it has no name; it's identified by kind).

status'active' | 'deleting' required

Lifecycle status of a volume.

storage'block' required

How a volume is physically backed — distinct from [VolumeKind] (ownership). Every volume is Block today; the enum exists so future backings can be added (and reported to the SDK) without another schema change.

updated_atstring date-time required
used_bytesinteger nullable

Bytes currently used under this volume's subtree. null when usage is unavailable — the usage service is disabled or unreachable (list degrades gracefully rather than failing) — or on create/delete, which don't sample it.

Changes

  • 1cdd89b0fe30Revision changes
    • breaking

      added the new path request parameter slug

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • 23f2a45cb09bRevision changes
    • info

      endpoint added