Container Registry
Container Registry is a managed OCI-compatible container image registry service.
The Container Registry API allows the creation, configuration, and deletion of container registry services, as well as user management, image repository browsing, and network peering configuration.
API follows JSON Merge Patch semantics for PATCH operations.
List registry services
Returns the list of container registry services for the authenticated account.
query Parameters
region_nameFilter by region name. Same value as region_name on the service, and as region on create.
Region identifier for the service
operational_stateFilter by operational state.
Customer-facing operational state of the service
configured_statusFilter by configured status.
Desired status configured by the user
tierFilter by service tier.
Service tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
List registry services › Responses
Success
List of service summaries
Create registry service
Creates a new managed container registry service.
Create registry service › Request Body
name^[a-z0-9]([a-z0-9-]*… · requiredDNS-1123 compliant name. Capped at 46 so the derived private hostname label {name}-{uuid8}-private stays within the 63-char DNS label limit.
tierService tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
regionRegion identifier for the service
Key/value labels for organising and filtering services.
Customer-facing typed config block. Feature toggles land here as they ship; mirrors the same object returned by GET.
Customer SDN networks to peer to this service's private gateway. Non-empty list implies private access (dual mode).
Create registry service › Responses
Service created
uuidUnique identifier for the entity
name^[a-z0-9]([a-z0-9-]*… · requiredDNS-1123 compliant name. Capped at 46 so the derived private hostname label {name}-{uuid8}-private stays within the 63-char DNS label limit.
tierService tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
region_nameRegion identifier for the service
operational_stateCustomer-facing operational state of the service
configured_statusDesired status configured by the user
registry_urlURL of the container registry endpoint
created_atTimestamp when the service was created
updated_atTimestamp when the service was last updated
access_modeNetwork access mode for the service
storage_used_bytesStorage currently used, in bytes
total_reposNumber of repositories in the registry
repo_limitMaximum number of repositories allowed by the plan. 0 means unlimited.
Customer-facing service configuration.
Public endpoint plus any attached private (SDN) networks
Error-level messages describing the current state
Summary of repeated provisioning failures, omitted when healthy
Labels assigned to the service
deleted_atTimestamp when the service was deleted, null if active
List regions
Returns the regions a container registry can be created in. The name is the value to send as region on create; it is not interchangeable with a zone.
List regions › Responses
Success
List plans
Returns the plans a container registry can be created on and what each allows. The name is the value to send as tier on create.
List plans › Responses
Success
Get registry service details
Returns details of a container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Get registry service details › Responses
Success
uuidUnique identifier for the entity
name^[a-z0-9]([a-z0-9-]*… · requiredDNS-1123 compliant name. Capped at 46 so the derived private hostname label {name}-{uuid8}-private stays within the 63-char DNS label limit.
tierService tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
region_nameRegion identifier for the service
operational_stateCustomer-facing operational state of the service
configured_statusDesired status configured by the user
registry_urlURL of the container registry endpoint
created_atTimestamp when the service was created
updated_atTimestamp when the service was last updated
access_modeNetwork access mode for the service
storage_used_bytesStorage currently used, in bytes
total_reposNumber of repositories in the registry
repo_limitMaximum number of repositories allowed by the plan. 0 means unlimited.
Customer-facing service configuration.
Public endpoint plus any attached private (SDN) networks
Error-level messages describing the current state
Summary of repeated provisioning failures, omitted when healthy
Labels assigned to the service
deleted_atTimestamp when the service was deleted, null if active
Delete registry service
Deletes an existing container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Delete registry service › Responses
No Content
Modify registry service
Modifies an existing container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Modify registry service › Request Body
tierService tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
Replace the labels list. Send an empty array to clear all labels.
Patch the typed config block. Omit inner fields to keep their current value.
Reconcile customer SDN peerings. Adding triggers peering creation; removal goes through DELETE /networks/{peering_uuid}.
Modify registry service › Responses
Service updated
uuidUnique identifier for the entity
name^[a-z0-9]([a-z0-9-]*… · requiredDNS-1123 compliant name. Capped at 46 so the derived private hostname label {name}-{uuid8}-private stays within the 63-char DNS label limit.
tierService tier. Which of these are currently available is decided by the plan catalogue; an unavailable tier is rejected at validation.
region_nameRegion identifier for the service
operational_stateCustomer-facing operational state of the service
configured_statusDesired status configured by the user
registry_urlURL of the container registry endpoint
created_atTimestamp when the service was created
updated_atTimestamp when the service was last updated
access_modeNetwork access mode for the service
storage_used_bytesStorage currently used, in bytes
total_reposNumber of repositories in the registry
repo_limitMaximum number of repositories allowed by the plan. 0 means unlimited.
Customer-facing service configuration.
Public endpoint plus any attached private (SDN) networks
Error-level messages describing the current state
Summary of repeated provisioning failures, omitted when healthy
Labels assigned to the service
deleted_atTimestamp when the service was deleted, null if active
Get provisioning progress
Returns the provisioning phase and state for a container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Get provisioning progress › Responses
Success
uuidService UUID
phaseCurrent high-level provisioning phase
stateGranular provisioning state
retry_countNumber of retry attempts for the current state
last_errorPresent when provisioning last failed. Says which part of the registry failed (storage, certificate, DNS, private access, and so on) and whether it is still being retried. The underlying failure is internal and is not reported here; state_messages carries the step it failed at.
Get registry metrics
Returns usage metrics for a container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
query Parameters
fromStart of the window. Defaults to 24 hours before to.
RFC3339 timestamp.
toEnd of the window. Defaults to now.
RFC3339 timestamp.
resolutionBucket width.
Bucket width. auto uses 5m up to 24 hours, 1h up to 7 days, and 1d after that.
Get registry metrics › Responses
Success
Time-series metric data points
Get registry network-traffic metrics
Returns network traffic (ingress/egress bytes) for a container registry service as a bucketed series plus totals. Supports year-long windows.
path Parameters
uuidService UUID
Unique identifier for the entity
query Parameters
fromStart of the window. Defaults to 7 days before to.
RFC3339 timestamp.
toEnd of the window. Defaults to now.
RFC3339 timestamp.
resolutionBucket width.
Bucket width. auto uses 1h up to 31 days and 1d after that.
Get registry network-traffic metrics › Responses
Success
resolutionBucket width. auto chooses 1h up to 31 days and 1d after that.
fromtoSync storage usage
Calculates actual storage usage from object storage and updates the service record.
path Parameters
uuidService UUID
Unique identifier for the entity
Sync storage usage › Responses
Storage sync completed
storage_used_bytesStorage measured in the registry, in bytes.
storage_used_gbstorage_used_bytes divided by 1024^3.
List service events
Activity feed for a container registry service: repository, tag and manifest changes, user changes, and auth events. Newest first.
path Parameters
uuidService UUID
Unique identifier for the entity
query Parameters
actionEvent type to keep, such as registry.tag.create or user.create.
actorActor identifier to keep.
statusOutcome to keep.
Outcome of the event.
limitHow many events to return.
How many items to return. Default 100, maximum 1000.
offsetHow many events to skip. The feed is newest first.
How many items to skip. Default 0.
List service events › Responses
Success
totalTotal events matching the filter (pre-pagination).
Get connection info
Returns connection details for a container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Get connection info › Responses
Success
service_uuidUnique identifier for the entity
service_name^[a-z0-9]([a-z0-9-]*… · requiredDNS-1123 compliant name. Capped at 46 so the derived private hostname label {name}-{uuid8}-private stays within the 63-char DNS label limit.
registry_urlURL of the container registry
tls_enabledWhether TLS is configured and active
dns_configuredWhether DNS is configured for the registry
readyWhether the service is ready to accept connections
load_balancer_addressIP address or hostname of the load balancer
connection_stringPre-formatted connection string
instructionsHuman-readable instructions for connecting to the registry
Get registry credentials
Returns admin credentials for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Get registry credentials › Responses
Success
registry_urlURL of the container registry
usernameUsername for registry authentication
passwordPassword for registry authentication
docker_login_commandPre-formatted docker login command
Rotate registry credentials
Generates new admin credentials and revokes the previous ones.
path Parameters
uuidService UUID
Unique identifier for the entity
Rotate registry credentials › Responses
Credential rotation initiated
registry_urlURL of the container registry
usernameUsername for registry authentication
passwordPassword for registry authentication
docker_login_commandPre-formatted docker login command
List users
Returns a list of users for the container registry service by given {uuid}, including the service owner upadmin, which is marked managed.
path Parameters
uuidService UUID
Unique identifier for the entity
List users › Responses
Success
List of users
totalTotal number of users matching the query
Create user
Creates a new user for the container registry service by given {uuid}. Its permissions (read, create, update, delete) apply to every repository; read is the minimum and create, update and delete each require it.
path Parameters
uuidService UUID
Unique identifier for the entity
Create user › Request Body
username^[a-z0-9][a-z0-9._-]… · requiredUsername for authentication. Lowercase alphanumerics with dots, dashes and underscores; must start and end alphanumeric. Names beginning with internal-, and upadmin, are reserved for platform use.
passwordPassword for authentication. At most 72 bytes; the registry stores it as a bcrypt hash, which refuses anything longer.
permissionsRegistry actions the user may take, on every repository of the service. read: pull images and list repositories and tags. create: upload layers, push to a new tag, and so create new repositories. update: move an existing tag to other content, which includes pushing the same tag again. delete: delete tags, manifests and repositories. read is the minimum: create, update and delete each require it, because registry clients read before they write. update also requires create, because docker and helm upload layers on every push. A set that breaks either rule is rejected with 400 naming the set to send. Valid sets: [read], [read, create], [read, delete], [read, create, update], [read, create, delete], [read, create, update, delete]. Responses list permissions in the order read, create, update, delete.
display_nameHuman-readable display name
emailEmail address
descriptionDescription of the user or their purpose
Create user › Responses
User created
service_uuidUnique identifier for the entity
usernameUsername for authentication
permissionsRegistry actions the user may take, on every repository of the service. read: pull images and list repositories and tags. create: upload layers, push to a new tag, and so create new repositories. update: move an existing tag to other content, which includes pushing the same tag again. delete: delete tags, manifests and repositories. read is the minimum: create, update and delete each require it, because registry clients read before they write. update also requires create, because docker and helm upload layers on every push. A set that breaks either rule is rejected with 400 naming the set to send. Valid sets: [read], [read, create], [read, delete], [read, create, update], [read, create, delete], [read, create, update, delete]. Responses list permissions in the order read, create, update, delete.
managedTrue for the service owner the platform creates (upadmin). It holds every permission and cannot be changed or deleted; change its password with POST /users/upadmin/password or rotate it with POST /credentials.
activeWhether the user account is active
created_atTimestamp when the user was created
updated_atTimestamp when the user was last updated
display_nameHuman-readable display name
emailEmail address
descriptionDescription of the user or their purpose
last_login_atTimestamp of the last login, null if never logged in
Get user details
Returns user details by given service {uuid} and {user_id}.
path Parameters
uuidService UUID
Unique identifier for the entity
username^[a-z0-9][a-z0-9._-]… · requiredRegistry user's username.
Username for authentication. Lowercase alphanumerics with dots, dashes and underscores; must start and end alphanumeric. Names beginning with internal-, and upadmin, are reserved for platform use.
Get user details › Responses
Success
service_uuidUnique identifier for the entity
usernameUsername for authentication
permissionsRegistry actions the user may take, on every repository of the service. read: pull images and list repositories and tags. create: upload layers, push to a new tag, and so create new repositories. update: move an existing tag to other content, which includes pushing the same tag again. delete: delete tags, manifests and repositories. read is the minimum: create, update and delete each require it, because registry clients read before they write. update also requires create, because docker and helm upload layers on every push. A set that breaks either rule is rejected with 400 naming the set to send. Valid sets: [read], [read, create], [read, delete], [read, create, update], [read, create, delete], [read, create, update, delete]. Responses list permissions in the order read, create, update, delete.
managedTrue for the service owner the platform creates (upadmin). It holds every permission and cannot be changed or deleted; change its password with POST /users/upadmin/password or rotate it with POST /credentials.
activeWhether the user account is active
created_atTimestamp when the user was created
updated_atTimestamp when the user was last updated
display_nameHuman-readable display name
emailEmail address
descriptionDescription of the user or their purpose
last_login_atTimestamp of the last login, null if never logged in
Delete user
Deletes an existing user by given service {uuid} and {user_id}. The service owner upadmin cannot be deleted.
path Parameters
uuidService UUID
Unique identifier for the entity
username^[a-z0-9][a-z0-9._-]… · requiredRegistry user's username.
Username for authentication. Lowercase alphanumerics with dots, dashes and underscores; must start and end alphanumeric. Names beginning with internal-, and upadmin, are reserved for platform use.
Delete user › Responses
No Content
Modify user
Modifies an existing user by given service {uuid} and {user_id}. Sending permissions replaces the whole set. The service owner upadmin is managed by the platform and cannot be modified.
path Parameters
uuidService UUID
Unique identifier for the entity
username^[a-z0-9][a-z0-9._-]… · requiredRegistry user's username.
Username for authentication. Lowercase alphanumerics with dots, dashes and underscores; must start and end alphanumeric. Names beginning with internal-, and upadmin, are reserved for platform use.
Modify user › Request Body
permissionsRegistry actions the user may take, on every repository of the service. read: pull images and list repositories and tags. create: upload layers, push to a new tag, and so create new repositories. update: move an existing tag to other content, which includes pushing the same tag again. delete: delete tags, manifests and repositories. read is the minimum: create, update and delete each require it, because registry clients read before they write. update also requires create, because docker and helm upload layers on every push. A set that breaks either rule is rejected with 400 naming the set to send. Valid sets: [read], [read, create], [read, delete], [read, create, update], [read, create, delete], [read, create, update, delete]. Responses list permissions in the order read, create, update, delete.
activeWhether the user account is active
display_nameHuman-readable display name
emailEmail address
descriptionDescription of the user or their purpose
Modify user › Responses
User updated
service_uuidUnique identifier for the entity
usernameUsername for authentication
permissionsRegistry actions the user may take, on every repository of the service. read: pull images and list repositories and tags. create: upload layers, push to a new tag, and so create new repositories. update: move an existing tag to other content, which includes pushing the same tag again. delete: delete tags, manifests and repositories. read is the minimum: create, update and delete each require it, because registry clients read before they write. update also requires create, because docker and helm upload layers on every push. A set that breaks either rule is rejected with 400 naming the set to send. Valid sets: [read], [read, create], [read, delete], [read, create, update], [read, create, delete], [read, create, update, delete]. Responses list permissions in the order read, create, update, delete.
managedTrue for the service owner the platform creates (upadmin). It holds every permission and cannot be changed or deleted; change its password with POST /users/upadmin/password or rotate it with POST /credentials.
activeWhether the user account is active
created_atTimestamp when the user was created
updated_atTimestamp when the user was last updated
display_nameHuman-readable display name
emailEmail address
descriptionDescription of the user or their purpose
last_login_atTimestamp of the last login, null if never logged in
Change user password
Changes the password for a user by given service {uuid} and {user_id}. Works for the service owner upadmin too; GET /{uuid}/credentials then returns the new password.
path Parameters
uuidService UUID
Unique identifier for the entity
username^[a-z0-9][a-z0-9._-]… · requiredRegistry user's username.
Username for authentication. Lowercase alphanumerics with dots, dashes and underscores; must start and end alphanumeric. Names beginning with internal-, and upadmin, are reserved for platform use.
Change user password › Request Body
new_passwordAt most 72 bytes; the registry stores it as a bcrypt hash, which refuses anything longer.
Change user password › Responses
Password changed
List network peerings
Returns a list of network peerings for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
List network peerings › Responses
Success
List of network peering connections
Create network peering
Creates a new network peering for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Create network peering › Request Body
network_uuidUnique identifier for the entity
network_cidr^([0-9]{1,3}\.){3}[0… · requiredCIDR block of the customer network
zoneAvailability zone for the peering connection
Create network peering › Responses
Network peering created
uuidUnique identifier for the entity
service_uuidUnique identifier for the entity
customer_network_uuidUnique identifier for the entity
customer_network_cidrCIDR block of the customer network
customer_network_zoneAvailability zone of the customer network
statusState of a private-network peering.
created_atTimestamp when the peering was created
updated_atTimestamp when the peering was last updated
status_messageDetailed message about the peering status
private_hostnamePrivate hostname for accessing the registry via peering
gateway_network_uuidUnique identifier for the entity
gateway_network_cidrCIDR block of the gateway network
Get network peering details
Returns network peering details by given service {uuid} and {peering_uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
peering_uuidNetwork peering UUID
Unique identifier for the entity
Get network peering details › Responses
Success
uuidUnique identifier for the entity
service_uuidUnique identifier for the entity
customer_network_uuidUnique identifier for the entity
customer_network_cidrCIDR block of the customer network
customer_network_zoneAvailability zone of the customer network
statusState of a private-network peering.
created_atTimestamp when the peering was created
updated_atTimestamp when the peering was last updated
status_messageDetailed message about the peering status
private_hostnamePrivate hostname for accessing the registry via peering
gateway_network_uuidUnique identifier for the entity
gateway_network_cidrCIDR block of the gateway network
Delete network peering
Deletes a network peering by given service {uuid} and {peering_uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
peering_uuidNetwork peering UUID
Unique identifier for the entity
Delete network peering › Responses
No Content
Get access mode
Returns the current access mode and network information for the service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Get access mode › Responses
Success
access_modeNetwork access mode for the service
public_endpointPublic endpoint URL when access mode includes public
List of private networks with access
Modify access mode
Updates the access mode for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Modify access mode › Request Body
access_modeDesired network access mode
Modify access mode › Responses
Access mode updated
access_modeNetwork access mode for the service
public_endpointPublic endpoint URL when access mode includes public
List of private networks with access
List IP allowlist
Returns the IP allowlist for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
List IP allowlist › Responses
Success
List of IP allowlist entries
Add IP allowlist entry
Adds an IP CIDR to the allowlist for the container registry service by given {uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
Add IP allowlist entry › Request Body
cidr^([0-9]{1,3}\.){3}[0… · requiredCIDR block to allow
descriptionHuman-readable description of the allowlist entry
Add IP allowlist entry › Responses
Entry added
uuidUnique identifier for the entity
cidrCIDR block that is allowed
created_atTimestamp when the entry was created
descriptionHuman-readable description of the allowlist entry
created_byIdentifier of the user who created the entry
Delete IP allowlist entry
Removes an IP CIDR from the allowlist by given service {uuid} and {entry_uuid}.
path Parameters
uuidService UUID
Unique identifier for the entity
entry_uuidAllowlist entry UUID
Unique identifier for the entity
Delete IP allowlist entry › Responses
No Content
List webhooks
Returns the webhooks configured for the registry. Secrets are not returned.
path Parameters
uuidService UUID
Unique identifier for the entity
List webhooks › Responses
Success
Webhooks configured for the service. Secrets are omitted.
limitMaximum number of webhooks the service's plan allows.
Add webhook
Registers a webhook receiving every registry event. The secret is delivered as a bearer token on each request; requests are not signed. The number of webhooks a service may hold comes from its plan.
path Parameters
uuidService UUID
Unique identifier for the entity
Add webhook › Request Body
nameUnique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
urlhttp or https endpoint we POST to on each event. https is strongly recommended: the secret travels as a bearer token, so plain http exposes it to anyone on the path.
Extra HTTP headers sent with every delivery, for routing or tenancy tags. Do not set Authorization here: the webhook secret is already sent in it, and a second value is appended rather than replacing ours, which most receivers ignore and some reject.
secretShared secret the receiver authenticates deliveries with. Sent as Authorization: Bearer <secret> on every delivery; it is not a signing key and nothing is signed. Optional: omit it, or send an empty string, and a fresh 64-character hex secret is generated. It is returned in the clear only in this response and from rotate-secret, and is stored encrypted.
Add webhook › Responses
Webhook created
nameUnique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
urlEndpoint that receives every registry event.
created_atupdated_atsecretBearer token sent as Authorization on each delivery. Nothing is signed. When create omits secret, this is a generated 64-character hex string. Rotate-secret always generates one. It is not returned again.
Extra headers sent with every delivery.
created_byDelete webhook
Removes a webhook by service {uuid} and webhook {name}.
path Parameters
uuidService UUID
Unique identifier for the entity
nameWebhook name (unique within a service).
Unique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
Delete webhook › Responses
No Content
Update webhook
Updates URL or headers by webhook {name}. Secret rotation has its own endpoint.
path Parameters
uuidService UUID
Unique identifier for the entity
nameWebhook name (unique within a service).
Unique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
Update webhook › Request Body
urlReplaces the existing headers map outright when present. Do not set Authorization here: the webhook secret is already sent in it, and a second value is appended rather than replacing ours.
Update webhook › Responses
Webhook updated
nameUnique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
urlEndpoint that receives every registry event.
created_atupdated_atExtra headers sent with every delivery.
created_byRotate webhook secret
Generates a fresh Bearer-token secret. Returned once in the response; not retrievable later.
path Parameters
uuidService UUID
Unique identifier for the entity
nameWebhook name (unique within a service).
Unique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
Rotate webhook secret › Responses
Secret rotated
nameUnique webhook name within the service. It is the webhook's identity and cannot be changed; delete and recreate to rename.
urlEndpoint that receives every registry event.
created_atupdated_atsecretBearer token sent as Authorization on each delivery. Nothing is signed. When create omits secret, this is a generated 64-character hex string. Rotate-secret always generates one. It is not returned again.
Extra headers sent with every delivery.
created_byList repositories
Returns one alphabetical page of repositories in the container registry identified by {uuid}. When search returns the page, total_count is the number of repositories in the registry, so stop when offset reaches it. Each repository describes its newest tag: kind, artifact_type, media_type, size, last update, and that tag's platforms. repository_size_bytes is the total size of the repository. tag_count is the number of tags in the repository. A repository can hold other kinds under other tags. When search cannot return the page, the first page is names only and total_count is omitted. Passing last uses the OCI catalog, which also omits total_count; follow next_link for the next page.
path Parameters
uuidService UUID
Unique identifier for the entity
query Parameters
nHow many repositories to return.
How many items to return. Default 100, maximum 1000.
offsetHow many repositories to skip. The page is alphabetical. Ignored when last is set.
How many items to skip. Default 0.
lastReturn the OCI catalog page after this repository name. Each entry then carries only its name. Omit it to use the search page selected by n and offset.
List repositories › Responses
Success
Repositories on this page, sorted by name. Each entry describes the newest tag. A repository can hold other kinds under other tags. On the OCI catalog fallback and when search cannot return the page, each entry carries only its name and an empty artifact_type.
total_countNumber of repositories in the registry. Present when search returns the page, including when that number is 0, so a client stops when offset reaches it. Omitted when search is down. The name-only page and the OCI catalog page do not know the registry total, and a page-sized count would end paging after the first page. Follow next_link when the OCI catalog sets it.
next_linkLink to the next page of results
List repository tags
Returns the tags of one repository. Each tag includes digest and size when available, its artifact_type, media_type, and kind, and the OS/CPU platforms the image index covers (os, architecture, optional variant, child-manifest digest, and that platform's size). kind is multi-arch, image, chart, or artifact. multi-arch means two or more distinct os/architecture/variant values after unknown/unknown attestations are left out. An index with one real platform is image. When an index omits artifactType, artifact_type is an empty string. When registry search is unavailable, the list is tag names with an empty artifact_type and no kind, media_type, digest, size, or platforms.
path Parameters
uuidService UUID
Unique identifier for the entity
repo^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name (team-a/myapp), not a path separator. Percent-encode each slash as %2F, so that repository is team-a%2Fmyapp.
OCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
List repository tags › Responses
Success
nameRepository name.
Tags in the repository, with digest, size, and platforms when the registry supports it.
Delete repository
Removes the repository, including every tag and manifest. The response counts the manifests deleted. The bytes stay until garbage collection, which waits 1 hour after they become untagged and then runs every 24 hours, so storage and billing can take up to a day to drop.
path Parameters
uuidService UUID
Unique identifier for the entity
repo^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name (team-a/myapp), not a path separator. Percent-encode each slash as %2F, so that repository is team-a%2Fmyapp.
OCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
Delete repository › Responses
Repository deleted
repository^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
manifests_deletedManifests removed, including ones no tag referenced.
Point a tag at an existing digest
Creates a tag pointing at an already-pushed manifest. Use it to promote a tested digest to latest or prod without re-uploading. The digest must already exist in the same repository.
path Parameters
uuidService UUID
Unique identifier for the entity
repo^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name (team-a/myapp), not a path separator. Percent-encode each slash as %2F, so that repository is team-a%2Fmyapp.
OCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
tag^[A-Za-z0-9_][A-Za-z… · requiredTag name.
Tag name. It does not contain a slash.
Point a tag at an existing digest › Request Body
digest^sha256:[a-f0-9]{64}… · requiredOCI manifest digest the tag should point at. The digest must already exist in the same repository.
Point a tag at an existing digest › Responses
Tag created
repository^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
tag^[A-Za-z0-9_][A-Za-z… · requiredTag name. It does not contain a slash.
digest^sha256:[a-f0-9]{64}… · requiredOCI manifest digest. Percent-encode the colon as %3A when the digest is a path parameter.
Delete tag
Removes one tag. The manifest stays while another tag still points at it. When no tag points at it, the manifest stays untagged until garbage collection. Collection waits 1 hour after the manifest is untagged and then runs every 24 hours, so storage and billing can take up to a day to drop.
path Parameters
uuidService UUID
Unique identifier for the entity
repo^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name (team-a/myapp), not a path separator. Percent-encode each slash as %2F, so that repository is team-a%2Fmyapp.
OCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
tag^[A-Za-z0-9_][A-Za-z… · requiredTag name.
Tag name. It does not contain a slash.
Delete tag › Responses
Tag deleted
Delete manifest
Removes one manifest by digest, whichever tags reference it. The bytes stay until garbage collection, which waits 1 hour after the manifest is untagged and then runs every 24 hours, so storage and billing can take up to a day to drop.
path Parameters
uuidService UUID
Unique identifier for the entity
repo^[a-z0-9]+(?:(?:[._]… · requiredOCI repository name. A slash is part of the name (team-a/myapp), not a path separator. Percent-encode each slash as %2F, so that repository is team-a%2Fmyapp.
OCI repository name. A slash is part of the name. Percent-encode each slash as %2F when the name is a path parameter: team-a/myapp is team-a%2Fmyapp.
digest^sha256:[a-f0-9]{64}… · requiredManifest digest, sha256: followed by 64 lowercase hex characters. Percent-encode the colon as %3A.
OCI manifest digest. Percent-encode the colon as %3A when the digest is a path parameter.
Delete manifest › Responses
Manifest deleted
Restart service
Restarts the container registry service. On a running service this triggers a rolling restart; on a failed service it re-runs reconciliation to recover.
path Parameters
uuidService UUID
Unique identifier for the entity
Restart service › Responses
Restart initiated
messageConfirms the rolling restart was accepted.