Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

GetImagePullSpec returns short-lived pull material through registry-transfer support.

GET/v1/images/{image}/pull-spec

GetImagePullSpec returns short-lived pull material through registry-transfer support. Action: the pull spec is derived material about the image, not a sub-resource of it.

Returns unimplemented when this operation is unavailable. Support does not grant permission.

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

image path Required

The image id.

Type: string

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

Request and responses

Response 200

Success

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "const": "no-store",
    "type": "string"
  }
}

Schema: ImagePullSpec

Response 501

This operation is not available on this service.

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

unimplemented

{
  "code": "unimplemented",
  "message": "This operation is not available on this service."
}

Response default

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

application/json

Headers

Cache-Control

{
  "required": true,
  "schema": {
    "enum": [
      "no-store"
    ],
    "type": "string"
  }
}

Schema: Error

Schema example

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

Referenced schemas

#/components/schemas/Error

#/components/schemas/ImagePullSpec

Complete operation contract
{
  "description": "GetImagePullSpec returns short-lived pull material through registry-transfer support.\nAction: the pull spec is derived material about the image, not a sub-resource of it.\n\nReturns unimplemented when this operation is unavailable. Support does not grant permission.",
  "operationId": "getImagePullSpec",
  "parameters": [
    {
      "description": "The image id.",
      "in": "path",
      "name": "image",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ImagePullSpec"
          }
        }
      },
      "description": "Success",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "const": "no-store",
            "type": "string"
          }
        }
      }
    },
    "501": {
      "content": {
        "application/json": {
          "examples": {
            "unimplemented": {
              "summary": "This operation is not available on this service.",
              "value": {
                "code": "unimplemented",
                "message": "This operation is not available on this service."
              }
            }
          },
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "This operation is not available on this service.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    },
    "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.",
      "headers": {
        "Cache-Control": {
          "required": true,
          "schema": {
            "enum": [
              "no-store"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "GetImagePullSpec returns short-lived pull material through registry-transfer support.",
  "tags": [
    "Images"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-error-responses": [
    {
      "code": "UNIMPLEMENTED",
      "description": "This operation is not available on this service."
    }
  ],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "imagesPull"
  ],
  "x-sbx-serving-surface": "management"
}