Amazon Elastic Container Registry Public
  1. Root
Amazon Elastic Container Registry Public
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Creates or updates the image manifest and tags that are associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "registryId": "string",
    "repositoryName": "string",
    "imageManifest": "string",
    "imageManifestMediaType": "string",
    "imageTag": "string",
    "imageDigest": "string"
}'
Response Response Example
200 - Example 1
{
    "image": {
        "registryId": "string",
        "repositoryName": "string",
        "imageId": {
            "imageDigest": "string",
            "imageTag": "string"
        },
        "imageManifest": "string",
        "imageManifestMediaType": "string"
    }
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
registryId
string 
optional
The Amazon Web Services account ID, or registry alias, that's associated with the public registry that contains the repository where the image is put. If you do not specify a registry, the default public registry is assumed.
>= 2 characters<= 50 characters
repositoryName
string 
required
The name of the repository where the image is put.
>= 2 characters<= 205 characters
Match pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
imageManifest
string 
required
The image manifest that corresponds to the image to be uploaded.
>= 1 characters<= 4194304 characters
imageManifestMediaType
string 
optional
The media type of the image manifest. If you push an image manifest that doesn't contain the mediaType field, you must specify the imageManifestMediaType in the request.
imageTag
string 
optional
The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.
>= 1 characters<= 300 characters
imageDigest
string 
optional
The image digest of the image manifest that corresponds to the image.
Examples

Responses

🟢200Success
application/json
Body
image
object 
optional
Details of the image uploaded.
registryId
string 
optional
The Amazon Web Services account ID that's associated with the registry containing the image.
>= 2 characters<= 50 characters
repositoryName
string 
optional
The name of the repository that's associated with the image.
>= 2 characters<= 205 characters
Match pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
imageId
object 
optional
An object that contains the image tag and image digest associated with an image.
imageManifest
string 
optional
The image manifest that's associated with the image.
>= 1 characters<= 4194304 characters
imageManifestMediaType
string 
optional
The manifest media type of the image.
🟠480ServerException
🟠481InvalidParameterException
🟠482RepositoryNotFoundException
🟠483ImageAlreadyExistsException
🟠484LayersNotFoundException
🟠485ReferencedImagesNotFoundException
🟠486LimitExceededException
🟠487ImageTagAlreadyExistsException
🟠488ImageDigestDoesNotMatchException
🟠489RegistryNotFoundException
🟠490UnsupportedCommandException
Previous
/
Next
/
Built with