Sign in
Snapshots

`GET /v1/sandbox-snapshots/storage-summary`

get/v1/sandbox-snapshots/storage-summary

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/sandbox-snapshots/storage-summary
  • Auth: HTTP bearer

Response

Storage usage summary

available_disk_bytesinteger nullable

Available bytes on the snapshots filesystem, or null when the platform check is not yet implemented (deferred — see available_disk_space()). API consumers MUST treat null as "unknown" rather than "zero bytes available". A Some(0) would incorrectly block snapshot creation.

quota_bytesinteger required

Per-user quota in bytes.

snapshot_countinteger required

Number of ready snapshots.

total_bytesinteger required

Total bytes used by all ready snapshots for this user.

Changes

No recorded changes to this operation across all 50 revisions of this API.