Skip to content

Set zone metadata

POST /v1/dns/zones/{zone_name}/metadata

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

See the Expression schema documentation for information about metadata values.

Path Parameters

zone_name

The name of the zone.

Example: example.com

Body

application/json

Body Sample

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

Body Description

metadata object

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

Response