swagger: '2.0'
info:
  title: Docker Engine Config Image 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. It is the API the\nDocker client uses to communicate with the Engine, so everything the Docker\nclient can do can be done with the API.\n\nMost of the client's commands map directly to API endpoints (e.g. `docker ps`\nis `GET /containers/json`). The notable exception is running containers,\nwhich consists of several API calls.\n\n# Errors\n\nThe API uses standard HTTP status codes to indicate the success or failure\nof the API call. The body of the response will be JSON in the following\nformat:\n\n```\n{\n  \"message\": \"page not found\"\n}\n```\n\n# Versioning\n\nThe API is usually changed in each release, so API calls are versioned to\nensure that clients don't break. To lock to a specific version of the API,\nyou prefix the URL with its version, for example, call `/v1.30/info` to use\nthe v1.30 version of the `/info` endpoint. If the API version specified in\nthe URL is not supported by the daemon, a HTTP `400 Bad Request` error message\nis returned.\n\nIf you omit the version-prefix, the current version of the API (v1.50) is used.\nFor example, calling `/info` is the same as calling `/v1.52/info`. Using the\nAPI without a version-prefix is deprecated and will be removed in a future release.\n\nEngine releases in the near future should support this version of the API,\nso your client will continue to work even if it is talking to a newer Engine.\n\nThe API uses an open schema model, which means the server may add extra properties\nto responses. Likewise, the server will ignore any extra query parameters and\nrequest body properties. When you write clients, you need to ignore additional\nproperties in responses to ensure they do not break when talking to newer\ndaemons.\n\n\n# Authentication\n\nAuthentication for registries is handled client side. The client has to send\nauthentication details to various endpoints that need to communicate with\nregistries, such as `POST /images/(name)/push`. These are sent as\n`X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)\n(JSON) string with the following structure:\n\n```\n{\n  \"username\": \"string\",\n  \"password\": \"string\",\n  \"serveraddress\": \"string\"\n}\n```\n\nThe `serveraddress` is a domain/IP without a protocol. Throughout this\nstructure, double quotes are required.\n\nIf you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),\nyou can just pass this instead of credentials:\n\n```\n{\n  \"identitytoken\": \"9cbaf023786cd7...\"\n}\n```\n"
basePath: /v1.54
schemes:
- http
- https
consumes:
- application/json
- text/plain
produces:
- application/json
- text/plain
tags:
- name: Image
  x-displayName: Images
paths:
  /images/json:
    get:
      summary: List Images
      description: Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
      operationId: ImageList
      produces:
      - application/json
      responses:
        200:
          description: Summary image data for the images matching the query
          schema:
            type: array
            items:
              $ref: '#/definitions/ImageSummary'
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: all
        in: query
        description: Show all images. Only images from a final layer (no children) are shown by default.
        type: boolean
        default: false
      - name: filters
        in: query
        description: 'A JSON encoded value of the filters (a `map[string][]string`) to

          process on the images list.


          Available filters:


          - `before`=(`<image-name>[:<tag>]`,  `<image id>` or `<image@digest>`)

          - `dangling=true`

          - `label=key` or `label="key=value"` of an image label

          - `reference`=(`<image-name>[:<tag>]`)

          - `since`=(`<image-name>[:<tag>]`,  `<image id>` or `<image@digest>`)

          - `until=<timestamp>`

          '
        type: string
      - name: shared-size
        in: query
        description: Compute and show shared size as a `SharedSize` field on each image.
        type: boolean
        default: false
      - name: digests
        in: query
        description: Show digest information as a `RepoDigests` field on each image.
        type: boolean
        default: false
      - name: manifests
        in: query
        description: Include `Manifests` in the image summary.
        type: boolean
        default: false
      - name: identity
        in: query
        description: Include `Identity` in each manifest summary. Requires `manifests=1`.
        type: boolean
        default: false
      tags:
      - Image
  /build:
    post:
      summary: Build an image
      description: 'Build an image from a tar archive with a `Dockerfile` in it.


        The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive''s root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).


        The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.


        The build is canceled if the client drops the connection by quitting or being killed.

        '
      operationId: ImageBuild
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - name: inputStream
        in: body
        description: 'A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.'
        schema:
          type: string
          format: binary
      - name: dockerfile
        in: query
        description: Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.
        type: string
        default: Dockerfile
      - name: t
        in: query
        description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.
        type: string
      - name: extrahosts
        in: query
        description: Extra hosts to add to /etc/hosts
        type: string
      - name: remote
        in: query
        description: A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.
        type: string
      - name: q
        in: query
        description: Suppress verbose build output.
        type: boolean
        default: false
      - name: nocache
        in: query
        description: Do not use the cache when building the image.
        type: boolean
        default: false
      - name: cachefrom
        in: query
        description: JSON array of images used for build cache resolution.
        type: string
      - name: pull
        in: query
        description: Attempt to pull the image even if an older image exists locally.
        type: string
      - name: rm
        in: query
        description: Remove intermediate containers after a successful build.
        type: boolean
        default: true
      - name: forcerm
        in: query
        description: Always remove intermediate containers, even upon failure.
        type: boolean
        default: false
      - name: memory
        in: query
        description: Set memory limit for build.
        type: integer
      - name: memswap
        in: query
        description: Total memory (memory + swap). Set as `-1` to disable swap.
        type: integer
      - name: cpushares
        in: query
        description: CPU shares (relative weight).
        type: integer
      - name: cpusetcpus
        in: query
        description: CPUs in which to allow execution (e.g., `0-3`, `0,1`).
        type: string
      - name: cpuperiod
        in: query
        description: The length of a CPU period in microseconds.
        type: integer
      - name: cpuquota
        in: query
        description: Microseconds of CPU time that the container can get in a CPU period.
        type: integer
      - name: buildargs
        in: query
        description: 'JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.


          For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This would result in the query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded.


          [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)

          '
        type: string
      - name: shmsize
        in: query
        description: Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
        type: integer
      - name: squash
        in: query
        description: Squash the resulting images layers into a single layer. *(Experimental release only.)*
        type: boolean
      - name: labels
        in: query
        description: Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
        type: string
      - name: networkmode
        in: query
        description: 'Sets the networking mode for the run commands during build. Supported

          standard values are: `bridge`, `host`, `none`, and `container:<name|id>`.

          Any other value is taken as a custom network''s name or ID to which this

          container should connect to.

          '
        type: string
      - name: Content-type
        in: header
        type: string
        enum:
        - application/x-tar
        default: application/x-tar
      - name: X-Registry-Config
        in: header
        description: "This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.\n\nThe key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:\n\n```\n{\n  \"docker.example.com\": {\n    \"username\": \"janedoe\",\n    \"password\": \"hunter2\"\n  },\n  \"https://index.docker.io/v1/\": {\n    \"username\": \"mobydock\",\n    \"password\": \"conta1n3rize14\"\n  }\n}\n```\n\nOnly the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.\n"
        type: string
      - name: platform
        in: query
        description: Platform in the format os[/arch[/variant]]
        type: string
        default: ''
      - name: target
        in: query
        description: Target build stage
        type: string
        default: ''
      - name: outputs
        in: query
        description: 'BuildKit output configuration in the format of a stringified JSON array of objects.

          Each object must have two top-level properties: `Type` and `Attrs`.

          The `Type` property must be set to ''moby''.

          The `Attrs` property is a map of attributes for the BuildKit output configuration.

          See https://docs.docker.com/build/exporters/oci-docker/ for more information.


          Example:


          ```

          [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}]

          ```

          '
        type: string
        default: ''
      - name: version
        in: query
        type: string
        default: '1'
        enum:
        - '1'
        - '2'
        description: 'Version of the builder backend to use.


          - `1` is the first generation classic (deprecated) builder in the Docker daemon (default)

          - `2` is [BuildKit](https://github.com/moby/buildkit)

          '
      responses:
        200:
          description: no error
        400:
          description: Bad parameter
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Image
  /build/prune:
    post:
      summary: Delete builder cache
      produces:
      - application/json
      operationId: BuildPrune
      parameters:
      - name: reserved-space
        in: query
        description: Amount of disk space in bytes to keep for cache
        type: integer
        format: int64
      - name: max-used-space
        in: query
        description: Maximum amount of disk space allowed to keep for cache
        type: integer
        format: int64
      - name: min-free-space
        in: query
        description: Target amount of free disk space after pruning
        type: integer
        format: int64
      - name: all
        in: query
        type: boolean
        description: Remove all types of build cache
      - name: filters
        in: query
        type: string
        description: 'A JSON encoded value of the filters (a `map[string][]string`) to

          process on the list of build cache objects.


          Available filters:


          - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon''s local time.

          - `id=<id>`

          - `parent=<id>`

          - `type=<string>`

          - `description=<string>`

          - `inuse`

          - `shared`

          - `private`

          '
      responses:
        200:
          description: No error
          schema:
            type: object
            title: BuildPruneResponse
            properties:
              CachesDeleted:
                type: array
                items:
                  description: ID of build cache object
                  type: string
              SpaceReclaimed:
                description: Disk space reclaimed in bytes
                type: integer
                format: int64
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Image
  /images/create:
    post:
      summary: Create an image
      description: Pull or import an image.
      operationId: ImageCreate
      consumes:
      - text/plain
      - application/octet-stream
      produces:
      - application/json
      responses:
        200:
          description: no error
        404:
          description: repository does not exist or no read access
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: fromImage
        in: query
        description: 'Name of the image to pull. If the name includes a tag or digest, specific behavior applies:


          - If only `fromImage` includes a tag, that tag is used.

          - If both `fromImage` and `tag` are provided, `tag` takes precedence.

          - If `fromImage` includes a digest, the image is pulled by digest, and `tag` is ignored.

          - If neither a tag nor digest is specified, all tags are pulled.

          '
        type: string
      - name: fromSrc
        in: query
        description: Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.
        type: string
      - name: repo
        in: query
        description: Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.
        type: string
      - name: tag
        in: query
        description: Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.
        type: string
      - name: message
        in: query
        description: Set commit message for imported image.
        type: string
      - name: inputImage
        in: body
        description: Image content if the value `-` has been specified in fromSrc query parameter
        schema:
          type: string
        required: false
      - name: X-Registry-Auth
        in: header
        description: 'A base64url-encoded auth configuration.


          Refer to the [authentication section](#section/Authentication) for

          details.

          '
        type: string
      - name: changes
        in: query
        description: 'Apply `Dockerfile` instructions to the image that is created,

          for example: `changes=ENV DEBUG=true`.

          Note that `ENV DEBUG=true` should be URI component encoded.


          Supported `Dockerfile` instructions:

          `CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`

          '
        type: array
        items:
          type: string
      - name: platform
        in: query
        description: 'Platform in the format os[/arch[/variant]].


          When used in combination with the `fromImage` option, the daemon checks

          if the given image is present in the local image cache with the given

          OS and Architecture, and otherwise attempts to pull the image. If the

          option is not set, the host''s native OS and Architecture are used.

          If the given image does not exist in the local image cache, the daemon

          attempts to pull the image with the host''s native OS and Architecture.

          If the given image does exists in the local image cache, but its OS or

          architecture does not match, a warning is produced.


          When used with the `fromSrc` option to import an image from an archive,

          this option sets the platform information for the imported image. If

          the option is not set, the host''s native OS and Architecture are used

          for the imported image.

          '
        type: string
        default: ''
      tags:
      - Image
  /images/{name}/json:
    get:
      summary: Inspect an image
      description: Return low-level information about an image.
      operationId: ImageInspect
      produces:
      - application/json
      responses:
        200:
          description: No error
          schema:
            $ref: '#/definitions/ImageInspect'
        404:
          description: No such image
          schema:
            $ref: '#/definitions/ErrorResponse'
          examples:
            application/json:
              message: 'No such image: someimage (tag: latest)'
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or id
        type: string
        required: true
      - name: manifests
        in: query
        description: 'Include Manifests in the image summary.


          The `manifests` and `platform` options are mutually exclusive, and

          an error is produced if both are set.'
        type: boolean
        default: false
        required: false
      - name: platform
        type: string
        in: query
        description: 'JSON-encoded OCI platform to select the platform-variant.

          If omitted, it defaults to any locally available platform,

          prioritizing the daemon''s host platform.


          If the daemon provides a multi-platform image store, this selects

          the platform-variant to show inspect. If the image is

          a single-platform image, or if the multi-platform image does not

          provide a variant matching the given platform, an error is returned.


          The `platform` and `manifests` options are mutually exclusive, and

          an error is produced if both are set.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`'
      tags:
      - Image
  /images/{name}/history:
    get:
      summary: Get the history of an image
      description: Return parent layers of an image.
      operationId: ImageHistory
      produces:
      - application/json
      responses:
        200:
          description: List of image layers
          schema:
            type: array
            items:
              $ref: '#/definitions/ImageHistoryResponseItem'
          examples:
            application/json:
            - Id: 3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710
              Created: 1398108230
              CreatedBy: '/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /'
              Tags:
              - ubuntu:lucid
              - ubuntu:10.04
              Size: 182964289
              Comment: ''
            - Id: 6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8
              Created: 1398108222
              CreatedBy: '/bin/sh -c #(nop) MAINTAINER Tianon Gravi <admwiggin@gmail.com> - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/'
              Tags: []
              Size: 0
              Comment: ''
            - Id: 511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158
              Created: 1371157430
              CreatedBy: ''
              Tags:
              - scratch12:latest
              - scratch:latest
              Size: 0
              Comment: Imported from -
        404:
          description: No such image
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or ID
        type: string
        required: true
      - name: platform
        type: string
        in: query
        description: 'JSON-encoded OCI platform to select the platform-variant.

          If omitted, it defaults to any locally available platform,

          prioritizing the daemon''s host platform.


          If the daemon provides a multi-platform image store, this selects

          the platform-variant to show the history for. If the image is

          a single-platform image, or if the multi-platform image does not

          provide a variant matching the given platform, an error is returned.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`

          '
      tags:
      - Image
  /images/{name}/push:
    post:
      summary: Push an image
      description: 'Push an image to a registry.


        If you wish to push an image on to a private registry, that image must

        already have a tag which references the registry. For example,

        `registry.example.com/myimage:latest`.


        The push is cancelled if the HTTP connection is closed.

        '
      operationId: ImagePush
      consumes:
      - application/octet-stream
      responses:
        200:
          description: No error
        404:
          description: No such image
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: 'Name of the image to push. For example, `registry.example.com/myimage`.

          The image must be present in the local image store with the same name.


          The name should be provided without tag; if a tag is provided, it

          is ignored. For example, `registry.example.com/myimage:latest` is

          considered equivalent to `registry.example.com/myimage`.


          Use the `tag` parameter to specify the tag to push.

          '
        type: string
        required: true
      - name: tag
        in: query
        description: 'Tag of the image to push. For example, `latest`. If no tag is provided,

          all tags of the given image that are present in the local image store

          are pushed.

          '
        type: string
      - name: platform
        type: string
        in: query
        description: 'JSON-encoded OCI platform to select the platform-variant to push.

          If not provided, all available variants will attempt to be pushed.


          If the daemon provides a multi-platform image store, this selects

          the platform-variant to push to the registry. If the image is

          a single-platform image, or if the multi-platform image does not

          provide a variant matching the given platform, an error is returned.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`

          '
      - name: X-Registry-Auth
        in: header
        description: 'A base64url-encoded auth configuration.


          Refer to the [authentication section](#section/Authentication) for

          details.

          '
        type: string
        required: true
      tags:
      - Image
  /images/{name}/tag:
    post:
      summary: Tag an image
      description: 'Create a tag that refers to a source image.


        This creates an additional reference (tag) to the source image. The tag

        can include a different repository name and/or tag. If the repository

        or tag already exists, it will be overwritten.

        '
      operationId: ImageTag
      responses:
        201:
          description: No error
        400:
          description: Bad parameter
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: No such image
          schema:
            $ref: '#/definitions/ErrorResponse'
        409:
          description: Conflict
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or ID to tag.
        type: string
        required: true
      - name: repo
        in: query
        description: The repository to tag in. For example, `someuser/someimage`.
        type: string
      - name: tag
        in: query
        description: The name of the new tag.
        type: string
      tags:
      - Image
  /images/{name}:
    delete:
      summary: Remove an image
      description: 'Remove an image, along with any untagged parent images that were

        referenced by that image.


        Images can''t be removed if they have descendant images, are being

        used by a running container or are being used by a build.

        '
      operationId: ImageDelete
      produces:
      - application/json
      responses:
        200:
          description: The image was deleted successfully
          schema:
            type: array
            items:
              $ref: '#/definitions/ImageDeleteResponseItem'
          examples:
            application/json:
            - Untagged: 3e2f21a89f
            - Deleted: 3e2f21a89f
            - Deleted: 53b4f83ac9
        404:
          description: No such image
          schema:
            $ref: '#/definitions/ErrorResponse'
        409:
          description: Conflict
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or ID
        type: string
        required: true
      - name: force
        in: query
        description: Remove the image even if it is being used by stopped containers or has other tags
        type: boolean
        default: false
      - name: noprune
        in: query
        description: Do not delete untagged parent images
        type: boolean
        default: false
      - name: platforms
        in: query
        description: 'Select platform-specific content to delete.

          Multiple values are accepted.

          Each platform is a OCI platform encoded as a JSON string.

          '
        type: array
        items:
          type: string
      tags:
      - Image
  /images/search:
    get:
      summary: Search images
      description: Search for an image on Docker Hub.
      operationId: ImageSearch
      produces:
      - application/json
      responses:
        200:
          description: No error
          schema:
            type: array
            items:
              type: object
              title: ImageSearchResponseItem
              properties:
                description:
                  type: string
                is_official:
                  type: boolean
                is_automated:
                  description: 'Whether this repository has automated builds enabled.


                    <p><br /></p>


                    > **Deprecated**: This field is deprecated and will always be "false".

                    '
                  type: boolean
                  example: false
                name:
                  type: string
                star_count:
                  type: integer
          examples:
            application/json:
            - description: A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!
              is_official: true
              is_automated: false
              name: alpine
              star_count: 10093
            - description: Busybox base image.
              is_official: true
              is_automated: false
              name: Busybox base image.
              star_count: 3037
            - description: The PostgreSQL object-relational database system provides reliability and data integrity.
              is_official: true
              is_automated: false
              name: postgres
              star_count: 12408
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: term
        in: query
        description: Term to search
        type: string
        required: true
      - name: limit
        in: query
        description: Maximum number of results to return
        type: integer
      - name: filters
        in: query
        description: 'A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:


          - `is-official=(true|false)`

          - `stars=<number>` Matches images that has at least ''number'' stars.

          '
        type: string
      tags:
      - Image
  /images/prune:
    post:
      summary: Delete unused images
      produces:
      - application/json
      operationId: ImagePrune
      parameters:
      - name: filters
        in: query
        description: "Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:\n\n- `dangling=<boolean>` When set to `true` (or `1`), prune only\n   unused *and* untagged images. When set to `false`\n   (or `0`), all unused images are pruned.\n- `until=<string>` Prune images created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is used) the specified labels.\n"
        type: string
      responses:
        200:
          description: No error
          schema:
            type: object
            title: ImagePruneResponse
            properties:
              ImagesDeleted:
                description: Images that were deleted
                type: array
                items:
                  $ref: '#/definitions/ImageDeleteResponseItem'
              SpaceReclaimed:
                description: Disk space reclaimed in bytes
                type: integer
                format: int64
        500:
          description: Server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Image
  /commit:
    post:
      summary: Create a new image from a container
      operationId: ImageCommit
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        201:
          description: no error
          schema:
            $ref: '#/definitions/IDResponse'
        404:
          description: no such container
          schema:
            $ref: '#/definitions/ErrorResponse'
          examples:
            application/json:
              message: 'No such container: c2ada9df5af8'
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: containerConfig
        in: body
        description: The container configuration
        schema:
          $ref: '#/definitions/ContainerConfig'
      - name: container
        in: query
        description: The ID or name of the container to commit
        type: string
      - name: repo
        in: query
        description: Repository name for the created image
        type: string
      - name: tag
        in: query
        description: Tag name for the create image
        type: string
      - name: comment
        in: query
        description: Commit message
        type: string
      - name: author
        in: query
        description: Author of the image (e.g., `John Hannibal Smith <hannibal@a-team.com>`)
        type: string
      - name: pause
        in: query
        description: Whether to pause the container before committing
        type: boolean
        default: true
      - name: changes
        in: query
        description: '`Dockerfile` instructions to apply while committing'
        type: string
      tags:
      - Image
  /images/{name}/get:
    get:
      summary: Export an image
      description: "Get a tarball containing all images and metadata for a repository.\n\nIf `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced.\n\n### Image tarball format\n\nAn image tarball contains [Content as defined in the OCI Image Layout Specification](https://github.com/opencontainers/image-spec/blob/v1.1.1/image-layout.md#content).\n\nAdditionally, includes the manifest.json file associated with a backwards compatible docker save format.\n\nIf the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs.\n\n```json\n{\n  \"hello-world\": {\n    \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\"\n  }\n}\n```\n"
      operationId: ImageGet
      produces:
      - application/x-tar
      responses:
        200:
          description: no error
          schema:
            type: string
            format: binary
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: name
        in: path
        description: Image name or ID
        type: string
        required: true
      - name: platform
        type: array
        items:
          type: string
        collectionFormat: multi
        in: query
        description: 'JSON encoded OCI platform describing a platform which will be used

          to select a platform-specific image to be saved if the image is

          multi-platform.

          If not provided, the full multi-platform image will be saved.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`

          '
      tags:
      - Image
  /images/get:
    get:
      summary: Export several images
      description: 'Get a tarball containing all images and metadata for several image

        repositories.


        For each value of the `names` parameter: if it is a specific name and

        tag (e.g. `ubuntu:latest`), then only that image (and its parents) are

        returned; if it is an image ID, similarly only that image (and its parents)

        are returned and there would be no names referenced in the ''repositories''

        file for this image ID.


        For details on the format, see the [export image endpoint](#operation/ImageGet).

        '
      operationId: ImageGetAll
      produces:
      - application/x-tar
      responses:
        200:
          description: no error
          schema:
            type: string
            format: binary
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: names
        in: query
        description: Image names to filter by
        type: array
        items:
          type: string
      - name: platform
        type: array
        items:
          type: string
        collectionFormat: multi
        in: query
        description: 'JSON encoded OCI platform(s) which will be used to select the

          platform-specific image(s) to be saved if the image is

          multi-platform. If not provided, the full multi-platform image

          will be saved.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`

          '
      tags:
      - Image
  /images/load:
    post:
      summary: Import images
      description: 'Load a set of images and tags into a repository.


        For details on the format, see the [export image endpoint](#operation/ImageGet).

        '
      operationId: ImageLoad
      consumes:
      - application/x-tar
      produces:
      - application/json
      responses:
        200:
          description: no error
        500:
          description: server error
          schema:
            $ref: '#/definitions/ErrorResponse'
      parameters:
      - name: imagesTarball
        in: body
        description: Tar archive containing images
        schema:
          type: string
          format: binary
      - name: quiet
        in: query
        description: Suppress progress details during load.
        type: boolean
        default: false
      - name: platform
        type: array
        items:
          type: string
        collectionFormat: multi
        in: query
        description: 'JSON encoded OCI platform(s) which will be used to select the

          platform-specific image(s) to load if the image is

          multi-platform. If not provided, the full multi-platform image

          will be loaded.


          Example: `{"os": "linux", "architecture": "arm", "variant": "v5"}`

          '
      tags:
      - Image
definitions:
  SignatureType:
    description: SignatureType is the type of signature format.
    type: string
    enum:
    - bundle-v0.3
    - simplesigning-v1
  ImageDeleteResponseItem:
    type: object
    x-go-name: DeleteResponse
    properties:
      Untagged:
        description: The image ID of an image that was untagged
        type: string
      Deleted:
        description: The image ID of an image that was deleted
        type: string
  DriverData:
    description: 'Information about the storage driver used to store the container''s and

      image''s filesystem.

      '
    type: object
    required:
    - Name
    - Data
    properties:
      Name:
        description: Name of the storage driver.
        type: string
        x-nullable: false
        example: overlay2
      Data:
        description: 'Low-level storage metadata, provided as key/value pairs.


          This information is driver-specific, and depends on the storage-driver

          in use, and should be used for informational purposes only.

          '
        type: object
        x-nullable: false
        additionalProperties:
          type: string
        example:
          MergedDir: /var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged
          UpperDir: /var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff
          WorkDir: /var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work
  ImageSummary:
    type: object
    x-go-name: Summary
    required:
    - Id
    - ParentId
    - RepoTags
    - RepoDigests
    - Created
    - Size
    - SharedSize
    - Labels
    - Containers
    properties:
      Id:
        description: 'ID is the content-addressable ID of an image.


          This identifier is a content-addressable digest calculated from the

          image''s configuration (which includes the digests of layers used by

          the image).


          Note that this digest differs from the `RepoDigests` below, which

          holds digests of image manifests that reference the image.

          '
        type: string
        x-nullable: false
        example: sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710
      ParentId:
        description: 'ID of the parent image.


          Depending on how the image was created, this field may be empty and

          is only set for images that were built/created locally. This field

          is empty if the image was pulled from an image registry.

          '
        type: string
        x-nullable: false
        example: ''
      RepoTags:
        description: 'List of image names/tags in the local image cache that reference this

          image.


          Multiple image tags can refer to the same image, and this list may be

          empty if no tags reference the image, in which case the image is

          "untagged", in which case it can still be referenced by its ID.

          '
        type: array
        x-nullable: false
        items:
          type: string
        example:
        - example:1.0
        - example:latest
        - example:stable
        - internal.registry.example.com:5000/example:1.0
      RepoDigests:
        description: 'List of content-addressable digests of locally available image manifests

          that the image is referenced from. Multiple manifests can refer to the

          same image.


          These digests are usually only available if the image was either pulled

          from a registry, or if the image was pushed to a registry, which is when

          the manifest is generated and its digest calculated.

          '
        type: array
        x-nullable: false
        items:
          type: string
        example:
        - example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb
        - internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578
      Created:
        description: 'Date and time at which the image was created as a Unix timestamp

          (number of seconds since EPOCH).

          '
        type: integer
        x-nullable: false
        example: '1644009612'
      Size:
        description: 'Total size of the image including all layers it is composed of.

          '
        type: integer
        format: int64
        x-nullable: false
        example: 172064416
      SharedSize:
        description: 'Total size of image layers that are shared between this image and other

          images.


          This size is not calculated by default. `-1` indicates that the value

          has not been set / calculated.

          '
        type: integer
        format: int64
        x-nullable: false
        example: 1239828
      Labels:
        description: User-defined key/value metadata.
        type: object
        x-nullable: false
        additionalProperties:
          type: string
        example:
          com.example.some-label: some-value
          com.example.some-other-label: some-other-value
      Containers:
        description: 'Number of containers using this image. Includes both stopped and running

          containers.


          `-1` indicates that the value has not been set / calculated.

          '
        x-nullable: false
        type: integer
        example: 2
      Manifests:
        description: 'Manifests is a list of manifests available in this image.

          It provides a more detailed view of the platform-specific image manifests

          or other image-attached data like build attestations.


          WARNING: This is experimental and may change at any time without any backward

          compatibility.

          '
        type: array
        x-nullable: false
        x-omitempty: true
        items:
          $ref: '#/definitions/ImageManifestSummary'
      Descriptor:
        description: 'Descriptor is an OCI descriptor of the image target.

          In case of a multi-platform image, this descriptor points to the OCI index

          or a manifest list.


          This field is only present if the daemon provides a multi-platform image store.


          WARNING: This is experimental and may change at any time without any backward

          compatibility.

          '
        x-nullable: true
        $ref: '#/definitions/OCIDescriptor'
  SignatureTimestampType:
    description: SignatureTimestampType is the type of timestamp used in the signature.
    type: string
    enum:
    - Tlog
    - TimestampAuthority
  HealthConfig:
    description: 'A test to perform to check that the container is healthy.

      Healthcheck commands should be side-effect free.

      '
    type: object
    properties:
      Test:
        description: 'The test to perform. Possible values are:


          - `[]` inherit healthcheck from image or parent image

          - `["NONE"]` disable healthcheck

          - `["CMD", args...]` exec arguments directly

          - `["CMD-SHELL", command]` run command with system''s default shell


          A non-zero exit code indicates a failed healthcheck:

          - `0` healthy

          - `1` unhealthy

          - `2` reserved (treated as unhealthy)

          - other values: error running probe

          '
        type: array
        items:
          type: string
      Interval:
        description: 'The time to wait between checks in nanoseconds. It should be 0 or at

          least 1000000 (1 ms). 0 means inherit.

          '
        type: integer
        format: int64
      Timeout:
        description: 'The time to wait before considering the check to have hung. It should

          be 0 or at least 1000000 (1 ms). 0 means inherit.


          If the health check command does not complete within this timeout,

          the check is considered failed and the health check process is

          forcibly terminated without a graceful shutdown.

          '
        type: integer
        format: int64
      Retries:
        description: 'The number of consecutive failures needed to consider a container as

          unhealthy. 0 means inherit.

          '
        type: integer
      StartPeriod:
        description: 'Start period for the container to initialize before starting

          health-retries countdown in nanoseconds. It should be 0 or at least

          1000000 (1 ms). 0 means inherit.

          '
        type: integer
        format: int64
      StartInterval:
        description: 'The time to wait between checks in nanoseconds during the start period.

          It should be 0 or at least 1000000 (1 ms). 0 means inherit.

          '
        type: integer
        format: int64
  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
        items:
          type: string
          format: uri
        x-nullable: true
      annotations:
        description: Arbitrary metadata relating to the targeted content.
        type: object
        x-nullable: true
        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
        x-nullable: true
        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: '#/definitions/OCIPlatform'
      artifactType:
        description: ArtifactType is the IANA media type of this artifact.
        type: string
        x-nullable: true
        example: null
  ImageConfig:
    description: 'Configuration of the image. These fields are used as defaults

      when starting a container from the image.

      '
    type: object
    properties:
      User:
        description: The user that commands are run as inside the container.
        type: string
        example: web:web
      ExposedPorts:
        description: 'An object mapping ports to an empty object in the form:


          `{"<port>/<tcp|udp|sctp>": {}}`

          '
        type: object
        x-nullable: true
        additionalProperties:
          type: object
          enum:
          - {}
          default: {}
        example:
          80/tcp: {}
          443/tcp: {}
      Env:
        description: 'A list of environment variables to set inside the container in the

          form `["VAR=value", ...]`. A variable without `=` is removed from the

          environment, rather than to have an empty value.

          '
        type: array
        items:
          type: string
        example:
        - PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
      Cmd:
        description: 'Command to run specified as a string or an array of strings.

          '
        type: array
        items:
          type: string
        example:
        - /bin/sh
      Healthcheck:
        $ref: '#/definitions/HealthConfig'
      ArgsEscaped:
        description: Command is already escaped (Windows only)
        type: boolean
        default: false
        example: false
        x-nullable: true
      Volumes:
        description: 'An object mapping mount point paths inside the container to empty

          objects.

          '
        type: object
        additionalProperties:
          type: object
          enum:
          - {}
          default: {}
        example:
          /app/data: {}
          /app/config: {}
      WorkingDir:
        description: The working directory for commands to run in.
        type: string
        example: /public/
      Entrypoint:
        description: 'The entry point for the container as a string or an array of strings.


          If the array consists of exactly one empty string (`[""]`) then the

          entry point is reset to system default (i.e., the entry point used by

          docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).

          '
        type: array
        items:
          type: string
        example: []
      OnBuild:
        description: '`ONBUILD` metadata that were defined in the image''s `Dockerfile`.

          '
        type: array
        x-nullable: true
        items:
          type: string
        example: []
      Labels:
        description: User-defined key/value metadata.
        type: object
        additionalProperties:
          type: string
        example:
          com.example.some-label: some-value
          com.example.some-other-label: some-other-value
      StopSignal:
        description: 'Signal to stop a container as a string or unsigned integer.

          '
        type: string
        example: SIGTERM
        x-nullable: true
      Shell:
        description: 'Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

          '
        type: array
        x-nullable: true
        items:
          type: string
        example:
        - /bin/sh
        - -c
  KnownSignerIdentity:
    description: KnownSignerIdentity is an identifier for a special signer identity that is known to the implementation.
    type: string
    enum:
    - DHI
  ImageHistoryResponseItem:
    type: object
    x-go-name: HistoryResponseItem
    title: HistoryResponseItem
    description: individual image layer information in response to ImageHistory operation
    required:
    - Id
    - Created
    - CreatedBy
    - Tags
    - Size
    - Comment
    properties:
      Id:
        type: string
        x-nullable: false
      Created:
        type: integer
        format: int64
        x-nullable: false
      CreatedBy:
        type: string
        x-nullable: false
      Tags:
        type: array
        items:
          type: string
      Size:
        type: integer
        format: int64
        x-nullable: false
      Comment:
        type: string
        x-nullable: false
  ImageManifestSummary:
    x-go-name: ManifestSummary
    description: 'ImageManifestSummary represents a summary of an image manifest.

      '
    type: object
    required:
    - ID
    - Descriptor
    - Available
    - Size
    - Kind
    properties:
      ID:
        description: 'ID is the content-addressable ID of an image and is the same as the

          digest of the image manifest.

          '
        type: string
        example: sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f
      Descriptor:
        $ref: '#/definitions/OCIDescriptor'
      Available:
        description: Indicates whether all the child content (image config, layers) is fully available locally.
        type: boolean
        example: true
      Size:
        type: object
        x-nullable: false
        required:
        - Content
        - Total
        properties:
          Total:
            type: integer
            format: int64
            example: 8213251
            description: 'Total is the total size (in bytes) of all the locally present

              data (both distributable and non-distributable) that''s related to

              this manifest and its children.

              This equal to the sum of [Content] size AND all the sizes in the

              [Size] struct present in the Kind-specific data struct.

              For example, for an image kind (Kind == "image")

              this would include the size of the image content and unpacked

              image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).

              '
          Content:
            description: 'Content is the size (in bytes) of all the locally present

              content in the content store (e.g. image config, layers)

              referenced by this manifest and its children.

              This only includes blobs in the content store.

              '
            type: integer
            format: int64
            example: 3987495
      Kind:
        type: string
        example: image
        enum:
        - image
        - attestation
        - unknown
        description: 'The kind of the manifest.


          kind         | description

          -------------|-----------------------------------------------------------

          image        | Image manifest that can be used to start a container.

          attestation  | Attestation manifest produced by the Buildkit builder for a specific image manifest.

          '
      ImageData:
        description: 'The image data for the image manifest.

          This field is only populated when Kind is "image".

          '
        type: object
        x-nullable: true
        x-omitempty: true
        required:
        - Platform
        - Containers
        - Size
        - UnpackedSize
        properties:
          Platform:
            $ref: '#/definitions/OCIPlatform'
            description: 'OCI platform of the image. This will be the platform specified in the

              manifest descriptor from the index/manifest list.

              If it''s not available, it will be obtained from the image config.

              '
          Identity:
            description: 'Identity holds information about the identity and origin of this image.

              For image list responses, this can duplicate Build/Pull fields across

              image manifests, because those parts are image-level metadata.

              '
            x-nullable: true
            $ref: '#/definitions/Identity'
          Containers:
            description: 'The IDs of the containers that are using this image.

              '
            type: array
            items:
              type: string
            example:
            - ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430
            - abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e
          Size:
            type: object
            x-nullable: false
            required:
            - Unpacked
            properties:
              Unpacked:
                type: integer
                format: int64
                example: 3987495
                description: 'Unpacked is the size (in bytes) of the locally unpacked

                  (uncompressed) image content that''s directly usable by the containers

                  running this image.

                  It''s independent of the distributable content - e.g.

                  the image might still have an unpacked data that''s still used by

                  some container even when the distributable/compressed content is

                  already gone.

                  '
      AttestationData:
        description: 'The image data for the attestation manifest.

          This field is only populated when Kind is "attestation".

          '
        type: object
        x-nullable: true
        x-omitempty: true
        required:
        - For
        properties:
          For:
            description: 'The digest of the image manifest that this attestation is for.

              '
            type: string
            example: sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f
  Identity:
    description: 'Identity holds information about the identity and origin of the image.

      This is trusted information verified by the daemon and cannot be modified

      by tagging an image to a different name.'
    type: object
    properties:
      Signature:
        description: Signature contains the properties of verified signatures for the image.
        type: array
        items:
          $ref: '#/definitions/SignatureIdentity'
      Pull:
        description: 'Pull contains remote location information if image was created via pull.

          If image was pulled via mirror, this contains the original repository location.

          After successful push this images also contains the pushed repository location.'
        type: array
        items:
          $ref: '#/definitions/PullIdentity'
      Build:
        description: Build contains build reference information if image was created via build.
        type: array
        items:
          $ref: '#/definitions/BuildIdentity'
  SignatureIdentity:
    description: SignatureIdentity contains the properties of verified signatures for the image.
    type: object
    properties:
      Name:
        description: Name is a textual description summarizing the type of signature.
        type: string
      Timestamps:
        description: Timestamps contains a list of verified signed timestamps for the signature.
        type: array
        items:
          $ref: '#/definitions/SignatureTimestamp'
      KnownSigner:
        description: KnownSigner is an identifier for a special signer identity that is known to the implementation.
        $ref: '#/definitions/KnownSignerIdentity'
      DockerReference:
        description: 'DockerReference is the Docker image reference associated with the signature.

          This is an optional field only present in older hashedrecord signatures.'
        type: string
      Signer:
        description: Signer contains information about the signer certificate used to sign the image.
        $ref: '#/definitions/SignerIdentity'
      SignatureType:
        description: SignatureType is the type of signature format. E.g. "bundle-v0.3" or "hashedrecord".
        $ref: '#/definitions/SignatureType'
      Error:
        description: 'Error contains error information if signature verification failed.

          Other fields will be empty in this case.'
        type: string
      Warnings:
        description: 'Warnings contains any warnings that occurred during signature verification.

          For example, if there was no internet connectivity and cached trust roots were used.

          Warning does not indicate a failed verification but may point to configuration issues.'
        type: array
        items:
          type: string
  SignatureTimestamp:
    description: SignatureTimestamp contains information about a verified signed timestamp for an image signature.
    type: object
    properties:
      Type:
        $ref: '#/definitions/SignatureTimestampType'
      URI:
        type: string
      Timestamp:
        type: string
        format: date-time
  IDResponse:
    description: Response to an API call that returns just an Id
    type: object
    x-go-name: IDResponse
    required:
    - Id
    properties:
      Id:
        description: The id of the newly created object.
        type: string
        x-nullable: false
  ImageInspect:
    description: 'Information about an image in the local image cache.

      '
    type: object
    properties:
      Id:
        description: 'ID is the content-addressable ID of an image.


          This identifier is a content-addressable digest calculated from the

          image''s configuration (which includes the digests of layers used by

          the image).


          Note that this digest differs from the `RepoDigests` below, which

          holds digests of image manifests that reference the image.

          '
        type: string
        x-nullable: false
        example: sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710
      Descriptor:
        description: 'Descriptor is an OCI descriptor of the image target.

          In case of a multi-platform image, this descriptor points to the OCI index

          or a manifest list.


          This field is only present if the daemon provides a multi-platform image store.


          WARNING: This is experimental and may change at any time without any backward

          compatibility.

          '
        x-nullable: true
        $ref: '#/definitions/OCIDescriptor'
      Identity:
        description: 'Identity holds information about the identity and origin of the image.

          This is trusted information verified by the daemon and cannot be modified

          by tagging an image to a different name.'
        x-nullable: true
        $ref: '#/definitions/Identity'
      Manifests:
        description: 'Manifests is a list of image manifests available in this image. It

          provides a more detailed view of the platform-specific image manifests or

          other image-attached data like build attestations.


          Only available if the daemon provides a multi-platform image store

          and the `manifests` option is set in the inspect request.


          WARNING: This is experimental and may change at any time without any backward

          compatibility.

          '
        type: array
        x-nullable: true
        items:
          $ref: '#/definitions/ImageManifestSummary'
      RepoTags:
        description: 'List of image names/tags in the local image cache that reference this

          image.


          Multiple image tags can refer to the same image, and this list may be

          empty if no tags reference the image, in which case the image is

          "untagged", in which case it can still be referenced by its ID.

          '
        type: array
        items:
          type: string
        example:
        - example:1.0
        - example:latest
        - example:stable
        - internal.registry.example.com:5000/example:1.0
      RepoDigests:
        description: 'List of content-addressable digests of locally available image manifests

          that the image is referenced from. Multiple manifests can refer to the

          same image.


          These digests are usually only available if the image was either pulled

          from a registry, or if the image was pushed to a registry, which is when

          the manifest is generated and its digest calculated.

          '
        type: array
        items:
          type: string
        example:
        - example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb
        - internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578
      Comment:
        description: 'Optional message that was set when committing or importing the image.

          '
        type: string
        x-nullable: true
        example: ''
      Created:
        description: 'Date and time at which the image was created, formatted in

          [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.


          This information is only available if present in the image,

          and omitted otherwise.

          '
        type: string
        format: dateTime
        x-nullable: true
        example: '2022-02-04T21:20:12.497794809Z'
      Author:
        description: 'Name of the author that was specified when committing the image, or as

          specified through MAINTAINER (deprecated) in the Dockerfile.

          '
        type: string
        x-nullable: true
        example: ''
      Config:
        $ref: '#/definitions/ImageConfig'
      Architecture:
        description: 'Hardware CPU architecture that the image runs on.

          '
        type: string
        x-nullable: false
        example: arm
      Variant:
        description: 'CPU architecture variant (presently ARM-only).

          '
        type: string
        x-nullable: true
        example: v7
      Os:
        description: 'Operating System the image is built to run on.

          '
        type: string
        x-nullable: false
        example: linux
      OsVersion:
        description: 'Operating System version the image is built to run on (especially

          for Windows).

          '
        type: string
        example: ''
        x-nullable: true
      Size:
        description: 'Total size of the image including all layers it is composed of.

          '
        type: integer
        format: int64
        x-nullable: false
        example: 1239828
      GraphDriver:
        x-nullable: true
        $ref: '#/definitions/DriverData'
      RootFS:
        description: 'Information about the image''s RootFS, including the layer IDs.

          '
        type: object
        required:
        - Type
        properties:
          Type:
            type: string
            x-nullable: false
            example: layers
          Layers:
            type: array
            items:
              type: string
            example:
            - sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6
            - sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef
      Metadata:
        description: 'Additional metadata of the image in the local cache. This information

          is local to the daemon, and not part of the image itself.

          '
        type: object
        properties:
          LastTagTime:
            description: 'Date and time at which the image was last tagged in

              [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.


              This information is only available if the image was tagged locally,

              and omitted otherwise.

              '
            type: string
            format: dateTime
            example: '2022-02-28T14:40:02.623929178Z'
            x-nullable: true
  ContainerConfig:
    description: 'Configuration for a container that is portable between hosts.

      '
    type: object
    properties:
      Hostname:
        description: 'The hostname to use for the container, as a valid RFC 1123 hostname.

          '
        type: string
        example: 439f4e91bd1d
      Domainname:
        description: 'The domain name to use for the container.

          '
        type: string
      User:
        description: 'Commands run as this user inside the container. If omitted, commands

          run as the user specified in the image the container was started from.


          Can be either user-name or UID, and optional group-name or GID,

          separated by a colon (`<user-name|UID>[<:group-name|GID>]`).'
        type: string
        example: 123:456
      AttachStdin:
        description: Whether to attach to `stdin`.
        type: boolean
        default: false
      AttachStdout:
        description: Whether to attach to `stdout`.
        type: boolean
        default: true
      AttachStderr:
        description: Whether to attach to `stderr`.
        type: boolean
        default: true
      ExposedPorts:
        description: 'An object mapping ports to an empty object in the form:


          `{"<port>/<tcp|udp|sctp>": {}}`

          '
        type: object
        x-nullable: true
        additionalProperties:
          type: object
          enum:
          - {}
          default: {}
        example:
          80/tcp: {}
          443/tcp: {}
      Tty:
        description: 'Attach standard streams to a TTY, including `stdin` if it is not closed.

          '
        type: boolean
        default: false
      OpenStdin:
        description: Open `stdin`
        type: boolean
        default: false
      StdinOnce:
        description: Close `stdin` after one attached client disconnects
        type: boolean
        default: false
      Env:
        description: 'A list of environment variables to set inside the container in the

          form `["VAR=value", ...]`. A variable without `=` is removed from the

          environment, rather than to have an empty value.

          '
        type: array
        items:
          type: string
        example:
        - PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
      Cmd:
        description: 'Command to run specified as a string or an array of strings.

          '
        type: array
        items:
          type: string
        example:
        - /bin/sh
      Healthcheck:
        $ref: '#/definitions/HealthConfig'
      ArgsEscaped:
        description: Command is already escaped (Windows only)
        type: boolean
        default: false
        example: false
        x-nullable: true
      Image:
        description: 'The name (or reference) of the image to use when creating the container,

          or which was used when the container was created.

          '
        type: string
        example: example-image:1.0
      Volumes:
        description: 'An object mapping mount point paths inside the container to empty

          objects.

          '
        type: object
        additionalProperties:
          type: object
          enum:
          - {}
          default: {}
      WorkingDir:
        description: The working directory for commands to run in.
        type: string
        example: /public/
      Entrypoint:
        description: 'The entry point for the container as a string or an array of strings.


          If the array consists of exactly one empty string (`[""]`) then the

          entry point is reset to system default (i.e., the entry point used by

          docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).

          '
        type: array
        items:
          type: string
        example: []
      NetworkDisabled:
        description: Disable networking for the container.
        type: boolean
        x-nullable: true
      OnBuild:
        description: '`ONBUILD` metadata that were defined in the image''s `Dockerfile`.

          '
        type: array
        x-nullable: true
        items:
          type: string
        example: []
      Labels:
        description: User-defined key/value metadata.
        type: object
        additionalProperties:
          type: string
        example:
          com.example.some-label: some-value
          com.example.some-other-label: some-other-value
      StopSignal:
        description: 'Signal to stop a container as a string or unsigned integer.

          '
        type: string
        example: SIGTERM
        x-nullable: true
      StopTimeout:
        description: Timeout to stop a container in seconds.
        type: integer
        default: 10
        x-nullable: true
      Shell:
        description: 'Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.

          '
        type: array
        x-nullable: true
        items:
          type: string
        example:
        - /bin/sh
        - -c
  OCIPlatform:
    type: object
    x-go-name: Platform
    x-nullable: true
    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
  SignerIdentity:
    description: SignerIdentity contains information about the signer certificate used to sign the image.
    type: object
    properties:
      CertificateIssuer:
        type: string
        description: CertificateIssuer is the certificate issuer.
      SubjectAlternativeName:
        type: string
        description: SubjectAlternativeName is the certificate subject alternative name.
      Issuer:
        type: string
        description: 'The OIDC issuer. Should match `iss` claim of ID token or, in the case of

          a federated login like Dex it should match the issuer URL of the

          upstream issuer. The issuer is not set the extensions are invalid and

          will fail to render.'
      BuildSignerURI:
        type: string
        description: Reference to specific build instructions that are responsible for signing.
      BuildSignerDigest:
        type: string
        description: Immutable reference to the specific version of the build instructions that is responsible for signing.
      RunnerEnvironment:
        type: string
        description: Specifies whether the build took place in platform-hosted cloud infrastructure or customer/self-hosted infrastructure.
      SourceRepositoryURI:
        type: string
        description: Source repository URL that the build was based on.
      SourceRepositoryDigest:
        type: string
        description: Immutable reference to a specific version of the source code that the build was based upon.
      SourceRepositoryRef:
        type: string
        description: Source Repository Ref that the build run was based upon.
      SourceRepositoryIdentifier:
        type: string
        description: Immutable identifier for the source repository the workflow was based upon.
      SourceRepositoryOwnerURI:
        type: string
        description: Source repository owner URL of the owner of the source repository that the build was based on.
      SourceRepositoryOwnerIdentifier:
        type: string
        description: Immutable identifier for the owner of the source repository that the workflow was based upon.
      BuildConfigURI:
        type: string
        description: Build Config URL to the top-level/initiating build instructions.
      BuildConfigDigest:
        type: string
        description: Immutable reference to the specific version of the top-level/initiating build instructions.
      BuildTrigger:
        type: string
        description: Event or action that initiated the build.
      RunInvocationURI:
        type: string
        description: Run Invocation URL to uniquely identify the build execution.
      SourceRepositoryVisibilityAtSigning:
        type: string
        description: Source repository visibility at the time of signing the certificate.
  BuildIdentity:
    description: BuildIdentity contains build reference information if image was created via build.
    type: object
    properties:
      Ref:
        description: 'Ref is the identifier for the build request. This reference can be used to

          look up the build details in BuildKit history API.'
        type: string
      CreatedAt:
        description: CreatedAt is the time when the build ran.
        type: string
        format: date-time
  PullIdentity:
    description: 'PullIdentity contains remote location information if image was created via pull.

      If image was pulled via mirror, this contains the original repository location.'
    type: object
    properties:
      Repository:
        description: Repository is the remote repository location the image was pulled from.
        type: string
  ErrorResponse:
    description: Represents an error.
    type: object
    required:
    - message
    properties:
      message:
        description: The error message.
        type: string
        x-nullable: false
    example:
      message: Something went wrong.