Docker Distribution API

openapi: 3.2.0
info:
  title: Docker Engine Distribution API
  version: '1.54'
  x-logo:
    url: https://docs.docker.com/assets/images/logo-docker-main.png
  description: The Engine API is an HTTP API served by Docker Engine.
servers:
- url: /v1.54
tags:
- name: Distribution
paths:
  /distribution/{name}/json:
    get:
      summary: Get image information from the registry
      description: Return image digest and platform information by contacting the registry.
      operationId: DistributionInspect
      responses:
        200:
          description: descriptor and platform information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributionInspect'
        401:
          description: Failed authentication or no image found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: 'No such image: someimage (tag: latest)'
        500:
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or id
        required: true
        schema:
          type: string
      tags:
      - Distribution
components:
  schemas:
    ErrorResponse:
      description: Represents an error.
      type: object
      required:
      - message
      properties:
        message:
          description: The error message.
          type: string
      example:
        message: Something went wrong.
    OCIDescriptor:
      type: object
      x-go-name: Descriptor
      description: 'A descriptor struct containing digest, media type, and size, as defined in

        the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).

        '
      properties:
        mediaType:
          description: 'The media type of the object this schema refers to.

            '
          type: string
          example: application/vnd.oci.image.manifest.v1+json
        digest:
          description: 'The digest of the targeted content.

            '
          type: string
          example: sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96
        size:
          description: 'The size in bytes of the blob.

            '
          type: integer
          format: int64
          example: 424
        urls:
          description: List of URLs from which this object MAY be downloaded.
          type:
          - array
          - 'null'
          items:
            type: string
            format: uri
        annotations:
          description: Arbitrary metadata relating to the targeted content.
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          example:
            com.docker.official-images.bashbrew.arch: amd64
            org.opencontainers.image.base.digest: sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8
            org.opencontainers.image.base.name: scratch
            org.opencontainers.image.created: '2025-01-27T00:00:00Z'
            org.opencontainers.image.revision: 9fabb4bad5138435b01857e2fe9363e2dc5f6a79
            org.opencontainers.image.source: https://git.launchpad.net/cloud-images/+oci/ubuntu-base
            org.opencontainers.image.url: https://hub.docker.com/_/ubuntu
            org.opencontainers.image.version: '24.04'
        data:
          type:
          - string
          - 'null'
          description: 'Data is an embedding of the targeted content. This is encoded as a base64

            string when marshalled to JSON (automatically, by encoding/json). If

            present, Data can be used directly to avoid fetching the targeted content.'
          example: null
        platform:
          $ref: '#/components/schemas/OCIPlatform'
        artifactType:
          description: ArtifactType is the IANA media type of this artifact.
          type:
          - string
          - 'null'
          example: null
    DistributionInspect:
      type: object
      x-go-name: DistributionInspect
      title: DistributionInspectResponse
      required:
      - Descriptor
      - Platforms
      description: 'Describes the result obtained from contacting the registry to retrieve

        image metadata.

        '
      properties:
        Descriptor:
          $ref: '#/components/schemas/OCIDescriptor'
        Platforms:
          type: array
          description: 'An array containing all platforms supported by the image.

            '
          items:
            $ref: '#/components/schemas/OCIPlatform'
    OCIPlatform:
      type:
      - object
      - 'null'
      x-go-name: Platform
      description: 'Describes the platform which the image in the manifest runs on, as defined

        in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).

        '
      properties:
        architecture:
          description: 'The CPU architecture, for example `amd64` or `ppc64`.

            '
          type: string
          example: arm
        os:
          description: 'The operating system, for example `linux` or `windows`.

            '
          type: string
          example: windows
        os.version:
          description: 'Optional field specifying the operating system version, for example on

            Windows `10.0.19041.1165`.

            '
          type: string
          example: 10.0.19041.1165
        os.features:
          description: 'Optional field specifying an array of strings, each listing a required

            OS feature (for example on Windows `win32k`).

            '
          type: array
          items:
            type: string
          example:
          - win32k
        variant:
          description: 'Optional field specifying a variant of the CPU, for example `v7` to

            specify ARMv7 when architecture is `arm`.

            '
          type: string
          example: v7