Metadata¶

Endpoints¶

GET /servers/{server_id}/zones/{zone_id}/metadata¶

Get all the Metadata associated with the zone.

Parameters:¶

• server_id (string) – The id of the server to retrieve

• zone_id (string) – The id of the zone to retrieve

Example request:

GET /servers/{server_id}/zones/{zone_id}/metadata HTTP/1.1
Host: example.com

Status Codes:¶

• 200 OK –

  List of Metadata objects

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  [
      {
          "kind": "string",
          "metadata": [
              "string"
          ]
      }
  ]
  

• default –

  The input to the operation was not valid

  Example response:

  HTTP/1.1 default -
  Content-Type: application/json
  
  {
      "error": "string",
      "errors": [
          "string"
      ]
  }
  

POST /servers/{server_id}/zones/{zone_id}/metadata¶

Creates a set of metadata entries

Creates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are not overwritten.

Parameters:¶

• server_id (string) – The id of the server to retrieve

• zone_id (string) – The id of the zone to retrieve

Example request:

POST /servers/{server_id}/zones/{zone_id}/metadata HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "kind": "string",
    "metadata": [
        "string"
    ]
}

Status Codes:¶

• 204 No Content – OK

• default –

  The input to the operation was not valid

  Example response:

  HTTP/1.1 default -
  Content-Type: application/json
  
  {
      "error": "string",
      "errors": [
          "string"
      ]
  }
  

GET /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}¶

Get the content of a single kind of domain metadata as a Metadata object.

Parameters:¶

• server_id (string) – The id of the server to retrieve

• zone_id (string) – The id of the zone to retrieve

• metadata_kind (string) – The kind of metadata

Example request:

GET /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} HTTP/1.1
Host: example.com

Status Codes:¶

• 200 OK –

  Metadata object with list of values

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "kind": "string",
      "metadata": [
          "string"
      ]
  }
  

• default –

  The input to the operation was not valid

  Example response:

  HTTP/1.1 default -
  Content-Type: application/json
  
  {
      "error": "string",
      "errors": [
          "string"
      ]
  }
  

PUT /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}¶

Replace the content of a single kind of domain metadata.

Creates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are removed.

Parameters:¶

• server_id (string) – The id of the server to retrieve

• zone_id (string) – The id of the zone to retrieve

• metadata_kind (string) – The kind of metadata

Status Codes:¶

• 200 OK –

  Metadata object with list of values

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "kind": "string",
      "metadata": [
          "string"
      ]
  }
  

• default –

  The input to the operation was not valid

  Example response:

  HTTP/1.1 default -
  Content-Type: application/json
  
  {
      "error": "string",
      "errors": [
          "string"
      ]
  }
  

DELETE /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}¶

Delete all items of a single kind of domain metadata.

Parameters:¶

• server_id (string) – The id of the server to retrieve

• zone_id (string) – The id of the zone to retrieve

• metadata_kind (string) – The kind of metadata

Status Codes:¶

• 204 No Content – OK

• default –

  The input to the operation was not valid

  Example response:

  HTTP/1.1 default -
  Content-Type: application/json
  
  {
      "error": "string",
      "errors": [
          "string"
      ]
  }
  

Objects¶

json Metadata : object¶

Metadata

Represents zone metadata

Optional members:¶

kind : string¶

Name of the metadata

metadata : array of string¶

Array with all values for this metadata kind.