Amazon Elastic Container Registry
Amazon Elastic Container Registry Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Elastic Container Registry
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the
familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR
provides a secure, scalable, and reliable registry for your Docker or Open Container
Initiative (OCI) images. Amazon ECR supports private repositories with resource-based
permissions using IAM so that specific users or Amazon EC2 instances can access
repositories and images.
Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the
Amazon Web Services General Reference .
Endpoints 62
- POSTBatch check layer availability
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailabilityChecks the availability of one or more image layers in a repository. When an image is pushed to a repository, each image layer is checked to verify if it has… - POSTBatch delete image
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchDeleteImageDeletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest . You can remove a tag from an image by… - POSTBatch get image
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchGetImageGets detailed information for an image. Images are specified with either an imageTag or imageDigest . When an image is pulled, the BatchGetImage API is called… - POSTBatch get repository scanning configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchGetRepositoryScanningConfigurationGets the scanning configuration for one or more repositories. - POSTComplete layer upload
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CompleteLayerUploadInforms Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256… - POSTCreate pull through cache rule
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CreatePullThroughCacheRuleCreates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private… - POSTCreate repository
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CreateRepositoryCreates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide . - POSTCreate repository creation template
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CreateRepositoryCreationTemplateCreates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example,… - POSTDelete lifecycle policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteLifecyclePolicyDeletes the lifecycle policy associated with the specified repository. - POSTDelete pull through cache rule
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeletePullThroughCacheRuleDeletes a pull through cache rule. - POSTDelete registry policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRegistryPolicyDeletes the registry permissions policy. - POSTDelete repository
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryDeletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository… - POSTDelete repository creation template
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryCreationTemplateDeletes a repository creation template. - POSTDelete repository policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryPolicyDeletes the repository policy associated with the specified repository. - POSTDelete signing configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteSigningConfigurationDeletes the registry's signing configuration. Images pushed after deletion of the signing configuration will no longer be automatically signed. For more… - POSTDeregister pull time update exclusion
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeregisterPullTimeUpdateExclusionRemoves a principal from the pull time update exclusion list for a registry. Once removed, Amazon ECR will resume updating the pull time if the specified… - POSTDescribe image replication status
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImageReplicationStatusReturns the replication status for a specified image. - POSTDescribe image scan findings
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImageScanFindingsReturns the scan findings for the specified image. - POSTDescribe image signing status
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImageSigningStatusReturns the signing status for a specified image. If the image matched signing rules that reference different signing profiles, a status is returned for each… - POSTDescribe images
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImagesReturns metadata about the images in a repository. Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2… - POSTDescribe pull through cache rules
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribePullThroughCacheRulesReturns the pull through cache rules for a registry. - POSTDescribe registry
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeRegistryDescribes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action. - POSTDescribe replication backfill results
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeReplicationBackfillResultsReturns the status, progress, and per-image results for a replication backfill. The backfill to describe is identified by the replicationBackfillId returned… - POSTDescribe repositories
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeRepositoriesDescribes image repositories in a registry. - POSTDescribe repository creation templates
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeRepositoryCreationTemplatesReturns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific… - POSTGet account setting
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetAccountSettingRetrieves the account setting value for the specified setting name. - POSTGet authorization token
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetAuthorizationTokenRetrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that… - POSTGet download url for layer
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetDownloadUrlForLayerRetrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. When… - POSTGet lifecycle policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyRetrieves the lifecycle policy for the specified repository. - POSTGet lifecycle policy preview
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyPreviewRetrieves the results of the lifecycle policy preview request for the specified repository. - POSTGet registry policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetRegistryPolicyRetrieves the permissions policy for a registry. - POSTGet registry scanning configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetRegistryScanningConfigurationRetrieves the scanning configuration for a registry. - POSTGet repository policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetRepositoryPolicyRetrieves the repository policy for the specified repository. - POSTGet signing configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetSigningConfigurationRetrieves the registry's signing configuration, which defines rules for automatically signing images using Amazon Web Services Signer. For more information,… - POSTInitiate layer upload
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.InitiateLayerUploadNotifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not… - POSTList image referrers
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListImageReferrersLists the artifacts associated with a specified subject image. The IAM principal invoking this operation must have the ecr:BatchGetImage permission. - POSTList images
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListImagesLists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and… - POSTList pull time update exclusions
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListPullTimeUpdateExclusionsLists the IAM principals that are excluded from having their image pull times recorded. - POSTList replication backfills
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListReplicationBackfillsLists the replication backfills for a registry, including their status and progress. Replication backfills that have reached a terminal status are retained… - POSTList tags for resource
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListTagsForResourceList the tags for an Amazon ECR resource. - POSTPut account setting
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutAccountSettingAllows you to change the basic scan type version or registry policy scope. - POSTPut image
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImageCreates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API… - POSTPut image scanning configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImageScanningConfigurationThe PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more… - POSTPut image tag mutability
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImageTagMutabilityUpdates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container… - POSTPut lifecycle policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutLifecyclePolicyCreates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template . - POSTPut registry policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutRegistryPolicyCreates or updates the permissions policy for your registry. A registry policy is used to specify permissions for another Amazon Web Services account and is… - POSTPut registry scanning configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutRegistryScanningConfigurationCreates or updates the scanning configuration for your private registry. - POSTPut replication configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutReplicationConfigurationCreates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the… - POSTPut signing configuration
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutSigningConfigurationCreates or updates the registry's signing configuration, which defines rules for automatically signing images with Amazon Web Services Signer. For more… - POSTRegister pull time update exclusion
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.RegisterPullTimeUpdateExclusionAdds an IAM principal to the pull time update exclusion list for a registry. Amazon ECR will not record the pull time if an excluded principal pulls an image. - POSTSet repository policy
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.SetRepositoryPolicyApplies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon… - POSTStart image scan
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StartImageScanStarts a basic image vulnerability scan. A basic image scan can only be started once per 24 hours on an individual image. This limit includes if an image was… - POSTStart lifecycle policy preview
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StartLifecyclePolicyPreviewStarts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the… - POSTStart replication backfill
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StartReplicationBackfillStarts a replication backfill for a registry. A replication backfill replicates a registry's existing images that match its replication configuration to the… - POSTStop replication backfill
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StopReplicationBackfillStops an in progress replication backfill for a registry. The backfill to stop is identified by the replicationBackfillId returned by the… - POSTTag resource
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.TagResourceAdds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. - POSTUntag resource
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UntagResourceDeletes specified tags from a resource. - POSTUpdate image storage class
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UpdateImageStorageClassTransitions an image between storage classes. You can transition images from Amazon ECR standard storage class to Amazon ECR archival storage class for… - POSTUpdate pull through cache rule
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UpdatePullThroughCacheRuleUpdates an existing pull through cache rule. - POSTUpdate repository creation template
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UpdateRepositoryCreationTemplateUpdates an existing repository creation template. - POSTUpload layer part
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UploadLayerPartUploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can… - POSTValidate pull through cache rule
/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ValidatePullThroughCacheRuleValidates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web…
API details
- Base URL
https://api.ecr.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 62 operations on 62 pathsPOST 62
- Description format
- AWS Smithy model, API version
2015-09-21 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Elastic Container Registry in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Elastic Container Registry collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch check layer availability” (POST /#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailability), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Elastic Container Registry?
Amazon Elastic Container Registry Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar… It is listed under Developer tools and has 62 endpoints.
Who publishes the Amazon Elastic Container Registry?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Elastic Container Registry?
Requests go to https://api.ecr.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Elastic Container Registry?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Elastic Container Registry have?
62 operations on 62 paths (62 POST).
Is forking the Amazon Elastic Container Registry free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.