Skip to content
StratumStratum Docs

List snapshots in a project.

GET
/v1/projects/{projectId}/compute/snapshots
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/compute/snapshots \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Query Parameters

Section titled “Query Parameters”
sourceVolumeId
string
/^vol-[a-z0-9-]+$/

Filter to snapshots taken from this volume.

Responses

Section titled “Responses”

200

Section titled “200”

Snapshots.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
/^snap-[a-z0-9-]+$/
projectId
required
string
/^p-[a-z0-9-]+$/
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
required
string
>= 1 characters <= 100 characters
description
string
sourceVolumeId
required
string
/^vol-[a-z0-9-]+$/
sizeBytes
required

Logical size — equal to the source volume’s size at snapshot time.

integer format: int64
actualBytes

Physical bytes consumed in the thin pool. CoW means this grows over time as the source diverges. Populated by the driver after the snapshot completes.

integer format: int64
storageClass
required
string
driver
string
Allowed values: lvm-thin ceph-rbd
pool
string
region
required
string
availabilityZone
required
string
state
required
string
Allowed values: creating available deleting deleted error
quiesced
required

True when the snapshot was taken after a successful filesystem quiesce via the guest agent. integration; v1 best-effort.

boolean
tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object
<= 50 properties
key
additional properties
string
<= 256 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deletedAt
string format: date-time
nullable
createdBy
required
string
nextPageToken
string
isTruncated

True when the server had more rows than it returned. The response is a valid prefix of the result, not the whole of it.

Without this flag a client at the server’s row ceiling receives a full page and no nextPageToken, which means “this is the complete set” — so data it never saw would be indistinguishable from data that does not exist.

It does not imply a cursor exists. These queries do not all sort on a total order, so a resumable token cannot be minted for them yet. The remedy is to narrow the request (a filter, or a tighter scope), not to page.

boolean

Example 

{
  "items": [
    {
      "driver": "lvm-thin",
      "state": "creating"
    }
  ]
}