GET /v2/domains/{domain_name}/records

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.

Servers

Path parameters

Name Type Required Description
domain_name String Yes

The name of the domain itself.

Query parameters

Name Type Required Description
page Integer No

Which 'page' of paginated results to return.

Default value: 1

name String No

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.

per_page Integer No

Number of items returned per page

Default value: 20

type String No

The type of the DNS record. For example: A, CNAME, TXT, ...

Possible values:

  • "TXT"
  • "A"
  • "CNAME"
  • "MX"
  • "AAAA"
  • "SOA"
  • "NS"
  • "SRV"
  • "CAA"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.