Sign in

v1

latestOpenAPI 3.1.02026-07-244861122.7 KB
records

Set metadata for a name

Set metadata associated to a name. Name metadata is stored until the name 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}/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.

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