Give Feedback

domain_records_info

Generated on 14 Jul 2025 from digitalocean.cloud version v1.2.1

Synopsis

Retrieve a listing of all of the domain records for a domain. View the API documentation at (https://docs.digitalocean.com/reference/api/api-reference/#operation/domains_list_records).

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.
`domain_name` str / required		The name of the domain itself.
`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		Retrieve a specific fully qualified record name.
`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`
`type` str	Choices: `A` `AAAA` `CNAME` `MX` `TXT` `SRV` `NS` `CAA`	Retrieve a specific type of record.

Examples

- name: Get domain records
  digitalocean.cloud.domain_records_info:
    token: "{{ token }}"
    domain_name: example.com

Return Values

Key Returned Description

Key	Returned	Description
`domain_records` list	always	Domain records. Sample: `[ { "data": "ns1.digitalocean.com", "flags": null, "id": 324538538, "name": "@", "port": null, "priority": null, "tag": null, "ttl": 1800, "type": "NS", "weight": null } ]`
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`msg` str	always	Domain records result information. Sample: `[ "Current domains", "No domains" ]`

domain_records
list

always

Domain records.
Sample:

[
  {
    "data": "ns1.digitalocean.com",
    "flags": null,
    "id": 324538538,
    "name": "@",
    "port": null,
    "priority": null,
    "tag": null,
    "ttl": 1800,
    "type": "NS",
    "weight": null
  }
]

error
dict

failure

DigitalOcean API error.
Sample:

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

msg
str