PATCH /v2/domains/{domain_name}/records/{domain_record_id}

To update an existing record, send a PATCH request to /v2/domains/$DOMAIN_NAME/records/$DOMAIN_RECORD_ID. Any attribute valid for the record type can be set to a new value for the record.

See the attribute table for details regarding record types and their respective attributes.

Servers

Path parameters

Name Type Required Description
domain_record_id Integer Yes

The unique identifier of the domain record.

domain_name String Yes

The name of the domain itself.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id Integer No

A unique identifier for each domain record.

ttl Integer No

This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.

data String No

Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.

priority Integer No

The priority for SRV and MX records.

port Integer No

The port for SRV records.

name String No

The host name, alias, or service being defined by the record.

flags Integer No

An unsigned integer between 0-255 used for CAA records.

type String Yes

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

weight Integer No

The weight for SRV records.

tag String No

The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef"

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.