Give Feedback

container_registry

Generated on 11 Feb 2026 from digitalocean.cloud version v1.2.1

Synopsis

Create or delete your DigitalOcean container registry. DigitalOcean Container Registry is a private Docker image registry with additional tooling support that enables integration with your Docker environment and DigitalOcean Kubernetes clusters. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Container-Registry.

Requirements

pydo >= 0.1.3
azure-core >= 1.26.1

Parameters

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`name` str / required		The name of the container registry. Must be unique and contain only lowercase letters, numbers, and hyphens.
`region` str		The slug of the region where the registry will be created.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`subscription_tier_slug` str	Choices: `starter` `basic` (default) `professional`	The slug of the subscription tier to use.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

Examples

- name: Create container registry
  digitalocean.cloud.container_registry:
    token: "{{ token }}"
    state: present
    name: my-registry
    subscription_tier_slug: basic
    region: nyc3

- name: Delete container registry
  digitalocean.cloud.container_registry:
    token: "{{ token }}"
    state: absent
    name: my-registry

Return Values

Key Returned Description

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Container registry result information. Sample: `[ "Created container registry my-registry", "Deleted container registry my-registry", "Container registry my-registry would be created", "Container registry my-registry exists", "Container registry does not exist" ]`
`registry` dict	always	Container registry information. Sample: { "created_at": "2020-03-21T16:02:37Z", "name": "my-registry", "region": "nyc3", "storage_usage_bytes": 0, "storage_usage_bytes_updated_at": "2020-11-04T21:39:49.530562231Z", "subscription": { "created_at": "2020-01-23T21:19:12Z", "tier": { "allow_storage_overage": true, "included_bandwidth_bytes": 5368709120, "included_repositories": 5, "included_storage_bytes": 5368709120, "monthly_price_in_cents": 500, "name": "Basic", "slug": "basic", "storage_overage_price_in_cents": 2 }, "updated_at": "2020-11-05T15:53:24Z" } }

error
dict

failure

DigitalOcean API error.
Sample:

{
  "Message": "Informational error message.",
  "Reason": "Unauthorized",
  "Status Code": 401
}

msg
str

always

Container registry result information.
Sample:

[
  "Created container registry my-registry",
  "Deleted container registry my-registry",
  "Container registry my-registry would be created",
  "Container registry my-registry exists",
  "Container registry does not exist"
]

registry
dict