Registries

Get the list of configured registries in the account

GET/accounts/{account_id}/containers/registries

Configure a private external image registry

POST/accounts/{account_id}/containers/registries

Delete a registry from the account

DELETE/accounts/{account_id}/containers/registries/{domain}

ModelsExpand Collapse

RegistryListResponse object { created_at, domain, kind, public_key }

An image registry added in a customer account.

created_at: string

UTC timestamp string in ISO 8601 format.

domain: string

A string representation of a domain name. See RFC-1034 (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name is min 3 and max 253 ASCII characters.

kind: optional "ECR" or "DockerHub" or "GAR" or "default"

The type of registry that is being configured.

One of the following:

"ECR"

"DockerHub"

"GAR"

"default"

public_key: optional string

Public component of the registry credentials. For managed registries this is a base64-encoded public key; for external registries the format depends on the registry provider.

RegistryCreateResponse object { created_at, domain, kind, public_key }

An image registry added in a customer account.

created_at: string

UTC timestamp string in ISO 8601 format.

domain: string

A string representation of a domain name. See RFC-1034 (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name is min 3 and max 253 ASCII characters.

kind: optional "ECR" or "DockerHub" or "GAR" or "default"

The type of registry that is being configured.

One of the following:

"ECR"

"DockerHub"

"GAR"

"default"

public_key: optional string

Public component of the registry credentials. For managed registries this is a base64-encoded public key; for external registries the format depends on the registry provider.

RegistryDeleteResponse object { domain }

Result of deleting an image registry from a Containers account.

domain: string

A string representation of a domain name. See RFC-1034 (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name is min 3 and max 253 ASCII characters.

RegistriesCredentials

Generate a JWT to interact with the specified image registry.

POST/accounts/{account_id}/containers/registries/{domain}/credentials

ModelsExpand Collapse

CredentialGenerateResponse object { account_id, password, registry_host, username }

Credentials returned for an authenticated registry configured on a Containers account.

account_id: string

A unique identifier for the user’s account.

password: string

The password to use when authenticating to the image registry.

registry_host: string

The domain of the image registry these credentials target.

username: string

The username to use when authenticating to the image registry.