IBM Cloud Container Registry API

IBM Cloud Container Registry API Introduction IBM Cloud® Container Registry provides a multi-tenant, highly available, and scalable private image registry that is hosted and managed by IBM. You can use the private registry by setting up your own image namespace and pushing container images to your namespace. For more information about IBM Cloud Container Registry, see About IBM Cloud Container Registryhttps://cloud.ibm.com/docs/Registry?topic=Registry-registryoverviewregistryoverview. For more information about IBM Cloud Kubernetes Service, see Getting started with IBM Cloud Kubernetes Servicehttps://cloud.ibm.com/docs/containers?topic=containers-getting-started. SDKs SDKs for Java, Node, Python, and Go are available for this API. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries. The code examples on this tab use the client library that is provided for Node.js. bash npm install @ibm-cloud/ibm-container-registry GitHub https://github.com/IBM/container-registry-node-sdk The code examples on this tab use the client library that is provided for Go. bash go get -u github.com/IBM/container-registry-go-sdk GitHub https://github.com/IBM/container-registry-go-sdk The code examples on this tab use the client library that is provided for Python. bash pip install --upgrade "ibm-container-registry" GitHub https://github.com/IBM/container-registry-python-sdk The code examples on this tab use the client library that is provided for Java. Gradle groovy compile group: 'com.ibm.cloud', name: 'container-registry', version: '1.+' Maven Maven installation instructionshttps://github.com/IBM/container-registry-java-sdk/maven GitHub https://github.com/IBM/container-registry-java-sdk Endpoint URL The endpoint for the IBM Cloud Container Registry API is in the format: https://

MethodPathSummary
GET/api/v1/authGet authorization options
PATCH/api/v1/authUpdate authorization options
GET/api/v1/imagesList images
POST/api/v1/images/bulkdeleteBulk delete images
POST/api/v1/images/digestsList images by digest
POST/api/v1/images/tagsCreate tag
DELETE/api/v1/images/{image}Delete image
GET/api/v1/images/{image}/jsonInspect an image
GET/api/v1/images/{image}/manifestGet image manifest
GET/api/v1/messagesGet messages
GET/api/v1/namespacesList namespaces
GET/api/v1/namespaces/detailsDetailed namespace list
PUT/api/v1/namespaces/{name}Create namespace
PATCH/api/v1/namespaces/{name}Assign namespace
DELETE/api/v1/namespaces/{name}Delete namespace
GET/api/v1/plansGet plans
PATCH/api/v1/plansUpdate plans
GET/api/v1/quotasGet quotas
PATCH/api/v1/quotasUpdate quotas
GET/api/v1/retentionsList retention policies
POST/api/v1/retentionsSet retention policy
POST/api/v1/retentions/analyzeAnalyze retention policy
GET/api/v1/retentions/{namespace}Get retention policy
GET/api/v1/settingsGet account settings
PATCH/api/v1/settingsUpdate account settings
DELETE/api/v1/tags/{image}Delete tag
GET/api/v1/trashList deleted images
POST/api/v1/trash/{digest}/restoretagsRestore a digest and all associated tags
POST/api/v1/trash/{image}/restoreRestore deleted image