v4

latestSwagger 2.02026-08-0343714211.7 MB

snapshots

Snapshots

List Snapshots

get/snapshots

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

Response

A list of Snapshots objects.

idinteger

The snapshot's unique ID.

expires_atstring date-time

When the snapshot expires.

finalized_atstring date-time

When the snapshot was finalized.

namestring

A name for the snapshot.

user_idinteger

The user that created this snapshot, if applicable.

bundle_idinteger

The bundle using this snapshot, if applicable.

workspace_idinteger

Workspace ID. 0 means the default workspace.

Example response

[
  {
    "id": 1,
    "expires_at": "2000-01-01T01:00:00Z",
    "finalized_at": "2000-01-01T01:00:00Z",
    "name": "My Snapshot",
    "user_id": 1,
    "bundle_id": 1
  }
]