Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

GetSnapshot reads one snapshot by its resource name.

GET/v1/snapshots/{snapshot}
GetSnapshot reads one snapshot by its resource name.

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

snapshot path Required

The snapshot id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

If-None-Match header

A quoted entity-tag or comma-separated list, compared weakly with the current resource etag. A match, including a weak form or wildcard *, answers 304 without a body after authorization. Malformed input is treated as no match.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

Request and responses

Response 200

Success

application/json

Headers

ETag

The etag of the resource this response carries, which the next mutation of it sends as If-Match.

{
  "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
  "schema": {
    "type": "string"
  }
}

Schema: Snapshot

Response 304

The resource's etag equals the If-None-Match value, so this response carries no body.

No response content is declared.

Response 404

The target is absent or not visible within the caller's scope.

application/json

Schema: Error

notFound

{
  "code": "notFound",
  "message": "The target is absent or not visible within the caller's scope."
}

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/Snapshot

Complete operation contract
{
  "description": "GetSnapshot reads one snapshot by its resource name.",
  "operationId": "getSnapshot",
  "parameters": [
    {
      "description": "The snapshot id.",
      "in": "path",
      "name": "snapshot",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "A quoted entity-tag or comma-separated list, compared weakly with the current resource etag. A match, including a weak form or wildcard *, answers 304 without a body after authorization. Malformed input is treated as no match.",
      "in": "header",
      "name": "If-None-Match",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Snapshot"
          }
        }
      },
      "description": "Success",
      "headers": {
        "ETag": {
          "description": "The etag of the resource this response carries, which the next mutation of it sends as If-Match.",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "304": {
      "description": "The resource's etag equals the If-None-Match value, so this response carries no body."
    },
    "404": {
      "content": {
        "application/json": {
          "examples": {
            "notFound": {
              "summary": "The target is absent or not visible within the caller's scope.",
              "value": {
                "code": "notFound",
                "message": "The target is absent or not visible within the caller's scope."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The target is absent or not visible within the caller's scope."
    },
    "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": "GetSnapshot reads one snapshot by its resource name.",
  "tags": [
    "Snapshots"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "NOT_FOUND",
      "description": "The target is absent or not visible within the caller's scope."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "snapshotsRead"
  ],
  "x-sbx-serving-surface": "management"
}