Skip to content
Cloudflare API
Start here
API Reference
Containers

Registries

Get the list of configured registries in the account
client.containers.registries.list(RegistryListParams { account_id } params, RequestOptionsoptions?): SinglePage<RegistryListResponse { created_at, domain, kind, public_key } >
GET/accounts/{account_id}/containers/registries
Configure a private external image registry
client.containers.registries.create(RegistryCreateParams { account_id, auth, domain, 2 more } params, RequestOptionsoptions?): RegistryCreateResponse { created_at, domain, kind, public_key }
POST/accounts/{account_id}/containers/registries
Delete a registry from the account
client.containers.registries.delete(stringdomain, RegistryDeleteParams { account_id } params, RequestOptionsoptions?): RegistryDeleteResponse { domain }
DELETE/accounts/{account_id}/containers/registries/{domain}
ModelsExpand Collapse
RegistryListResponse { 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?: "ECR" | "DockerHub" | "GAR" | "default"

The type of registry that is being configured.

One of the following:
"ECR"
"DockerHub"
"GAR"
"default"
public_key?: 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 { 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?: "ECR" | "DockerHub" | "GAR" | "default"

The type of registry that is being configured.

One of the following:
"ECR"
"DockerHub"
"GAR"
"default"
public_key?: 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 { 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.
client.containers.registries.credentials.generate(stringdomain, CredentialGenerateParams { account_id, expiration_minutes, permissions } params, RequestOptionsoptions?): CredentialGenerateResponse { account_id, password, registry_host, username }
POST/accounts/{account_id}/containers/registries/{domain}/credentials
ModelsExpand Collapse
CredentialGenerateResponse { 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.