pydo.domains.list_records()
Generated on 17 Apr 2025
from pydo version
v0.10.0
Description
To get a listing of all records configured for a domain, send a GET request to /v2/domains/$DOMAIN_NAME/records.
The list of records returned can be filtered by using the name and type query parameters. For example, to only include A records for a domain, send a GET request to /v2/domains/$DOMAIN_NAME/records?type=A. name must be a fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to /v2/domains/$DOMAIN_NAME/records?name=sub.example.com. Both name and type may be used together.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
domain_name |
string | True | The name of the domain itself. | |
name |
string | False | A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to /v2/domains/$DOMAIN_NAME/records?name=sub.example.com. |
|
type |
string | False | The type of the DNS record. For example: A, CNAME, TXT, … | |
per_page |
integer | False | Number of items returned per page | 20 |
page |
integer | False | Which ‘page’ of paginated results to return. | 1 |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
resp = client.domains.list_records(domain_name="example.com")More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.