Get metadata for a zone

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

Get metadata associated to the zone.

Path Parameters

zone_name

The name of the zone.

Example: example.com

Response

200 401 403 404

---

OK

Response for get metadata queries

{
  "data": {
    "metadata": {
      "public property": "public value"
    }
  },
  "warnings": [
    {
      "code": "string",
      "detail": "string",
      "title": "string"
    }
  ]
}

---

Unauthorized

unauthorized (code: 2465)

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "location": "string",
      "pointer": "string",
      "title": "string"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "detail": "string",
      "title": "string"
    }
  ]
}

---

Forbidden

operation only available via the website (code: 4786)

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "location": "string",
      "pointer": "string",
      "title": "string"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "detail": "string",
      "title": "string"
    }
  ]
}

---

Not Found

zone not found (codes: 2510, 2728)

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "location": "string",
      "pointer": "string",
      "title": "string"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "detail": "string",
      "title": "string"
    }
  ]
}