Views¶

These endpoints allow configuration of per-zone Views.

Views Endpoints¶

GET /servers/{server_id}/views¶

List all views in a server

Parameters:	server_id (string) – The id of the server to retrieve
Status Codes:	200 OK – An array of view names Returns: `Views` 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

GET /servers/{server_id}/views/{view}¶

List the contents of a given view

Parameters:	server_id (string) – The id of the server to retrieve view (string) – The name of the view to retrieve
Status Codes:	200 OK – An array of zone names Returns: `View` 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

POST /servers/{server_id}/views/{view}¶

Adds a zone to a given view, creating it if needed

Parameters:	server_id (string) – The id of the server to retrieve view (string) – The name of the view to update
Status Codes:	204 No Content – Returns 204 No Content on success. 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}/views/{view}/{id}¶

Removes the given zone from the given view

Parameters:	server_id (string) – The id of the server to retrieve view (string) – The name of the view to update id (string) – The zone to remove from the view
Status Codes:	204 No Content – Returns 204 No Content on success. 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 /api/v1/servers/localhost/views HTTP/1.1
X-API-Key: secret

Will yield a response similar to this (several headers omitted):

HTTP/1.1 200 OK
Content-Type: application/json

{"views":["trusted","untrusted"]}

GET /api/v1/servers/localhost/views/trusted HTTP/1.1
X-API-Key: secret

Will yield a response similar to this (several headers omitted):

HTTP/1.1 200 OK
Content-Type: application/json

{"zones":["example.com..trusted","otherdomain.com..untrusted"]}

POST /api/v1/servers/localhost/views/trusted HTTP/1.1
X-API-Key: secret
Content-Type: application/json

{"name":"example.org..trusted"}

Will yield a response similar to this (several headers omitted):

HTTP/1.1 204 No Content

DELETE /api/v1/servers/localhost/views/trusted/example.com. HTTP/1.1
X-API-Key: secret

Will yield a response similar to this (several headers omitted):

HTTP/1.1 204 No Content