Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

ListSnapshots lists snapshots in the caller's owner scope.

GET/v1/snapshots
ListSnapshots lists snapshots in the caller's owner scope.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

sandbox query

(OPTIONAL) sandbox is the complete resource name, in the form sandboxes/{sandbox}.

Type: string

All schema constraints and annotations
{
  "pattern": "^(?:sandboxes/[^/]+)?$",
  "title": "sandbox",
  "type": "string"
}

pageSize query

page_size is an optional page size.

Omitted or zero uses the backend default. Unless the operation states otherwise, page-size limits and handling of larger requests are backend-specific; use the backend support guide. Continue with nextPageToken until it is empty.

Type: integer

All schema constraints and annotations
{
  "title": "page_size",
  "type": "integer"
}

pageToken query

page_token is an opaque continuation token.

Type: string

All schema constraints and annotations
{
  "title": "page_token",
  "type": "string"
}

filter query

filter is comma-separated exact-match field=value terms; the portable fields are name, display_name and uid.

Type: string

All schema constraints and annotations
{
  "title": "filter",
  "type": "string"
}

orderBy query

order_by is a single order field with optional direction; the portable fields are created_at and name.

Type: string

All schema constraints and annotations
{
  "title": "order_by",
  "type": "string"
}

Request and responses

Response 200

Success

application/json

Schema: ListSnapshotsResponse

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/Error

#/components/schemas/ListSnapshotsResponse

Complete operation contract
{
  "description": "ListSnapshots lists snapshots in the caller's owner scope.",
  "operationId": "listSnapshots",
  "parameters": [
    {
      "description": "(OPTIONAL) sandbox is the complete resource name, in the form sandboxes/{sandbox}.",
      "in": "query",
      "name": "sandbox",
      "required": false,
      "schema": {
        "pattern": "^(?:sandboxes/[^/]+)?$",
        "title": "sandbox",
        "type": "string"
      }
    },
    {
      "description": "page_size is an optional page size.\n\nOmitted or zero uses the backend default. Unless the operation states otherwise, page-size limits and handling of larger requests are backend-specific; use the backend support guide. Continue with nextPageToken until it is empty.",
      "in": "query",
      "name": "pageSize",
      "required": false,
      "schema": {
        "title": "page_size",
        "type": "integer"
      }
    },
    {
      "description": "page_token is an opaque continuation token.",
      "in": "query",
      "name": "pageToken",
      "required": false,
      "schema": {
        "title": "page_token",
        "type": "string"
      }
    },
    {
      "description": "filter is comma-separated exact-match field=value terms; the portable fields are\nname, display_name and uid.",
      "in": "query",
      "name": "filter",
      "required": false,
      "schema": {
        "title": "filter",
        "type": "string"
      }
    },
    {
      "description": "order_by is a single order field with optional direction; the portable fields are\ncreated_at and name.",
      "in": "query",
      "name": "orderBy",
      "required": false,
      "schema": {
        "title": "order_by",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListSnapshotsResponse"
          }
        }
      },
      "description": "Success"
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "ListSnapshots lists snapshots in the caller's owner scope.",
  "tags": [
    "Snapshots"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "snapshotsRead"
  ],
  "x-sbx-serving-surface": "management"
}