Export an image Run in API Explorer

GET /images/{name}/get

Get a tarball containing all images and metadata for a repository.

If 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.

Image tarball format

An image tarball contains Content as defined in the OCI Image Layout Specification.

Additionally, includes the manifest.json file associated with a backwards compatible docker save format.

If 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.

{
  "hello-world": {
    "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1"
  }
}

Path parameters

  • name string Required

    Image name or ID

Query parameters

  • platform string

    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"}

Responses

  • 200 application/x-tar

    no error
  • 500 application/x-tar

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /images/{name}/get 
curl \
 --request GET 'http://api.example.com/v1.49/images/{name}/get'
Response examples (500) 
{
  "message": "Something went wrong."
}