Manifests - Get
Get the manifest identified by name
and reference
where reference
can be a tag or digest.
GET {url}/v2/{name}/manifests/{reference}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
name
|
path | True |
string |
Name of the image (including the namespace) |
reference
|
path | True |
string |
A tag or a digest, pointing to a specific image |
url
|
path | True |
string |
Registry login URL |
Request Header
Name | Required | Type | Description |
---|---|---|---|
accept |
string |
Accept header string delimited by comma. For example, application/vnd.docker.distribution.manifest.v2+json |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Returns the requested manifest file in a larger combined group |
|
Other Status Codes |
ACR error response describing why the operation failed. |
Security
registry_auth
Type:
basic
Examples
Get manifest
Sample Request
GET acrapi.azurecr-test.io/v2/hello-world-dangling/manifests/20190628-033033z
Sample Response
{
"schemaVersion": 2,
"mediaType": "application/vnd.docker.distribution.manifest.v2+json",
"config": {
"mediaType": "application/vnd.docker.container.image.v1+json",
"size": 5824,
"digest": "sha256:691fbc2d44fff48357bba69ab0505b9bf12b2b250a925a84a0b8e8e7eed390b2"
},
"layers": [
{
"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
"size": 2014658,
"digest": "sha256:a073c86ecf9e0f29180e80e9638d4c741970695851ea48247276c32c57e40282"
},
{
"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
"size": 19778035,
"digest": "sha256:0e28711eb56d78f1e3dfde1807eba529d1346222bcd07d1cb1e436a18a0388bd"
},
{
"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
"size": 1074044,
"digest": "sha256:e460dd483fddb555911f7ed188c319fd97542c60e36843dcb1c5d753f733e1fa"
},
{
"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
"size": 5827,
"digest": "sha256:6aa301222093bfb8cf424ccb387f59e2c9510c3a30cca7fbcf8c954f88e6600c"
},
{
"mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip",
"size": 568,
"digest": "sha256:9c5d80083a57d565f684e0155707204d497a5ad965279f92927452f15dae17e6"
}
]
}
Definitions
Name | Description |
---|---|
Acr |
Error information |
Acr |
Acr error response describing why the operation failed |
Annotations |
Additional information provided through arbitrary metadata. |
Descriptor |
Docker V2 image layer descriptor including config and layers |
Fs |
Image layer information |
History |
A list of unstructured historical data for v1 compatibility |
Image |
Signature of a signed manifest |
JWK |
A JSON web signature |
JWKHeader |
JSON web key parameter |
Manifest |
|
Manifest |
Returns the requested manifest file |
Platform |
The platform object describes the platform which the image in the manifest runs on. A full list of valid operating system and architecture values are listed in the Go language documentation for $GOOS and $GOARCH |
AcrErrorInfo
Error information
Name | Type | Description |
---|---|---|
code |
string |
Error code |
detail |
object |
Error details |
message |
string |
Error message |
AcrErrors
Acr error response describing why the operation failed
Name | Type | Description |
---|---|---|
errors |
Array of detailed error |
Annotations
Additional information provided through arbitrary metadata.
Name | Type | Description |
---|---|---|
org.opencontainers.image.authors |
string |
Contact details of the people or organization responsible for the image. |
org.opencontainers.image.created |
string |
Date and time on which the image was built (string, date-time as defined by https://tools.ietf.org/html/rfc3339#section-5.6) |
org.opencontainers.image.description |
string |
Human-readable description of the software packaged in the image |
org.opencontainers.image.documentation |
string |
URL to get documentation on the image. |
org.opencontainers.image.licenses |
string |
License(s) under which contained software is distributed as an SPDX License Expression. |
org.opencontainers.image.ref.name |
string |
Name of the reference for a target. |
org.opencontainers.image.revision |
string |
Source control revision identifier for the packaged software. |
org.opencontainers.image.source |
string |
URL to get source code for building the image. |
org.opencontainers.image.title |
string |
Human-readable title of the image |
org.opencontainers.image.url |
string |
URL to find more information on the image. |
org.opencontainers.image.vendor |
string |
Name of the distributing entity, organization or individual. |
org.opencontainers.image.version |
string |
Version of the packaged software. The version MAY match a label or tag in the source code repository, may also be Semantic versioning-compatible |
Descriptor
Docker V2 image layer descriptor including config and layers
Name | Type | Description |
---|---|---|
annotations |
Additional information provided through arbitrary metadata. |
|
digest |
string |
Layer digest |
mediaType |
string |
Layer media type |
size |
integer |
Layer size |
urls |
string[] |
Specifies a list of URIs from which this object may be downloaded. |
FsLayer
Image layer information
Name | Type | Description |
---|---|---|
blobSum |
string |
SHA of an image layer |
History
A list of unstructured historical data for v1 compatibility
Name | Type | Description |
---|---|---|
v1Compatibility |
string |
The raw v1 compatibility information |
ImageSignature
Signature of a signed manifest
Name | Type | Description |
---|---|---|
header |
A JSON web signature |
|
protected |
string |
The signed protected header |
signature |
string |
A signature for the image manifest, signed by a libtrust private key |
JWK
A JSON web signature
Name | Type | Description |
---|---|---|
alg |
string |
The algorithm used to sign or encrypt the JWT |
jwk |
JSON web key parameter |
JWKHeader
JSON web key parameter
Name | Type | Description |
---|---|---|
crv |
string |
crv value |
kid |
string |
kid value |
kty |
string |
kty value |
x |
string |
x value |
y |
string |
y value |
ManifestListAttributes
Name | Type | Description |
---|---|---|
digest |
string |
The digest of the content, as defined by the Registry V2 HTTP API Specification |
mediaType |
string |
The MIME type of the referenced object. This will generally be application/vnd.docker.image.manifest.v2+json, but it could also be application/vnd.docker.image.manifest.v1+json |
platform |
The platform object describes the platform which the image in the manifest runs on. A full list of valid operating system and architecture values are listed in the Go language documentation for $GOOS and $GOARCH |
|
size |
integer |
The size in bytes of the object |
ManifestWrapper
Returns the requested manifest file
Name | Type | Description |
---|---|---|
annotations |
(OCI, OCIIndex) Additional metadata |
|
architecture |
string |
(V1) CPU architecture |
config |
(V2, OCI) Image config descriptor |
|
fsLayers |
Fs |
(V1) List of layer information |
history |
History[] |
(V1) Image history |
layers |
(V2, OCI) List of V2 image layer information |
|
manifests |
(ManifestList, OCIIndex) List of V2 image layer information |
|
mediaType |
string |
Media type for this Manifest |
name |
string |
(V1) Image name |
schemaVersion |
integer |
Schema version |
signatures |
(V1) Image signature |
|
tag |
string |
(V1) Image tag |
Platform
The platform object describes the platform which the image in the manifest runs on. A full list of valid operating system and architecture values are listed in the Go language documentation for $GOOS and $GOARCH
Name | Type | Description |
---|---|---|
architecture |
string |
Specifies the CPU architecture, for example amd64 or ppc64le. |
features |
string[] |
The optional features field specifies an array of strings, each listing a required CPU feature (for example sse4 or aes |
os |
string |
The os field specifies the operating system, for example linux or windows. |
os.features |
string[] |
The optional os.features field specifies an array of strings, each listing a required OS feature (for example on Windows win32k |
os.version |
string |
The optional os.version field specifies the operating system version, for example 10.0.10586. |
variant |
string |
The optional variant field specifies a variant of the CPU, for example armv6l to specify a particular CPU variant of the ARM CPU. |