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

Status Codes:

• 200 OK – List of Metadata objects Returns: array of Metadata objects
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

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) –

Status Codes:

• 204 No Content – OK
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

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

Status Codes:

• 200 OK – Metadata object with list of values Returns: Metadata object
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

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) –
• metadata_kind (string) – The kind of metadata

Status Codes:

• 200 OK – Metadata object with list of values Returns: Metadata object
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

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
• 400 Bad Request – The supplied request was not valid Returns: Error object
• 404 Not Found – Requested item was not found Returns: Error object
• 422 Unprocessable Entity – The input to the operation was not valid Returns: Error object
• 500 Internal Server Error – Internal server error Returns: Error object

Objects

Metadata

Represents zone metadata

Object Properties:  

• kind (string) – Name of the metadata
• metadata ([string]) – Array with all values for this metadata kind.