Give Feedback

database_firewall

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

Synopsis

Configure firewall rules for a database cluster. Database firewall rules restrict which resources can connect to your database cluster. By default, database clusters are accessible from any source. View the API documentation at https://docs.digitalocean.com/reference/api/api-reference/#tag/Databases.

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.
`cluster_id` str / required		The UUID of the database cluster.
`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.
`rules` list / elements=dict / required		An array of firewall rules for the database cluster. Setting this replaces all existing rules.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`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: Configure database firewall rules
  digitalocean.cloud.database_firewall:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    rules:
      - type: ip_addr
        value: 192.168.1.0/24
      - type: droplet
        value: "12345678"
      - type: k8s
        value: bd5f5959-5e1e-4205-a714-a914373942af
      - type: tag
        value: backend

- name: Remove all firewall rules (allow all)
  digitalocean.cloud.database_firewall:
    token: "{{ token }}"
    state: present
    cluster_id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
    rules: []

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	Database firewall result information. Sample: `[ "Updated database firewall rules", "Database firewall rules would be updated" ]`
`rules` list	always	Database firewall rules. Sample: `[ { "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", "created_at": "2020-03-13T19:20:47Z", "type": "ip_addr", "uuid": "5a4981aa-9653-4bd1-bef5-d6bff52042e4", "value": "192.168.1.0/24" } ]`

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str

always

Database firewall result information.
Sample:

[
  "Updated database firewall rules",
  "Database firewall rules would be updated"
]

rules
list