Skip to main content
GET
/
api
/
v1
/
workspaces
/
{id}
/
snapshots
Cursor-paginated list of snapshots for one workspace.
curl --request GET \
  --url https://api.rigbox.dev/api/v1/workspaces/{id}/snapshots \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "size_mb": 123,
      "workspace_id": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workspace ID

Query Parameters

​
max_results
integer<int32>

Maximum items to return. Clamped to [1, MAX_LIMIT]. Default 50.

Deserialized leniently from a string: axum's Query (serde_urlencoded) cannot coerce a flattened numeric field, so a struct that #[serde(flatten)]s PageParams (e.g. ListAppsQuery) would otherwise fail with "invalid type: string, expected u32" on ?max_results=50.

Required range: x >= 0
​
cursor
string

Opaque cursor returned by a prior call's next_cursor. Omit on the first page.

Response

200 - application/json

Workspace snapshots page

Paginated response envelope. next_cursor: None ⇒ last page.

​
items
object[]
required
​
next_cursor
string | null