v14

latestOpenAPI 3.0.32026-08-04377889.4 MB

sandboxes

List snapshots

Retrieves a paginated list of snapshots for a specific project.

get/v2/sandboxes/snapshots

Query parameters

projectstring

The unique identifier or name of the project to list snapshots for.

Example:prj_abc123

The unique identifier or name of the project to list snapshots for.

namestring

Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).

Example:my-sandbox

Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).

limitnumber

Maximum number of snapshots to return in the response. Used for pagination.

Example:20

Maximum number of snapshots to return in the response. Used for pagination.

cursorstring

Opaque pagination cursor from a previous response.

sortOrder'asc' | 'desc'

Sort direction for results by creation time.

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

object required

Example response

{
  "snapshots": [
    {
      "id": "snap_123a6c5209bc3778245d011443644c8d27dc2c50",
      "sourceSessionId": "sbx_123a6c5209bc3778245d011443644c8d27dc2c50",
      "region": "iad1",
      "status": "created",
      "sizeBytes": 104857600,
      "expiresAt": 1750344501629,
      "createdAt": 1750344501629,
      "updatedAt": 1750344501629,
      "lastUsedAt": 1750344501629,
      "creationMethod": "manual",
      "parentId": "snap_parent123"
    }
  ]
}