Registries

Get the list of configured registries in the account

containers.registries.list() -> SyncSinglePage[RegistryListResponse]

GET/accounts/{account_id}/containers/registries

Configure a private external image registry

containers.registries.create() -> RegistryCreateResponse

POST/accounts/{account_id}/containers/registries

Delete a registry from the account

containers.registries.delete(, ) -> RegistryDeleteResponse

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

ModelsExpand Collapse

class RegistryListResponse: …

An image registry added in a customer account.

created_at: str

UTC timestamp string in ISO 8601 format.

domain: str

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[Literal["ECR", "DockerHub", "GAR", "default"]]

The type of registry that is being configured.

One of the following:

"ECR"

"DockerHub"

"GAR"

"default"

public_key: Optional[str]

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.

class RegistryCreateResponse: …

An image registry added in a customer account.

created_at: str

UTC timestamp string in ISO 8601 format.

domain: str

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[Literal["ECR", "DockerHub", "GAR", "default"]]

The type of registry that is being configured.

One of the following:

"ECR"

"DockerHub"

"GAR"

"default"

public_key: Optional[str]

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.

class RegistryDeleteResponse: …

Result of deleting an image registry from a Containers account.

domain: str

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.

containers.registries.credentials.generate(, ) -> CredentialGenerateResponse

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

ModelsExpand Collapse

class CredentialGenerateResponse: …

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

account_id: str

A unique identifier for the user’s account.

password: str

The password to use when authenticating to the image registry.

registry_host: str

The domain of the image registry these credentials target.

username: str

The username to use when authenticating to the image registry.