v1

latestOpenAPI 3.1.02026-07-244861122.7 KB
records

Set metadata for an RRSet

Set metadata associated to an RRSet. RRSet metadata is stored until the rrset gets deleted. New keys are added, existing keys are updated. To remove a key, set its value to an empty string.

See metadata filters for an in-depth explanation about metadata filters.

post/v1/dns/records/{zone_name}/{name}/rrsets/{dns_type}/metadata

Path parameters

zone_namestring required

The name of the zone.

Example:example.com

The name of the zone.

namestring required

The DNS name, not including the zone portion.

Example:dns-name

The DNS name, not including the zone portion.

dns_type'A' | 'AAAA' | 'CAA' | 'CNAME' | 'MX' | 'NS' | 'SRV' | 'TXT' | 'PTR' | '_URL' | 'ALIAS' required

DNS name type supported by API

Example:A

DNS name type supported by API

Request body

metadataMetadata

A collection of string key/value pairs that provide additional information or classification for an object.

Example request

{
  "metadata": {
    "public property": "public value"
  }
}

Response

resource updated