Networks

These endpoints allow configuration of networks, used by Views.

Networks Endpoints

GET /servers/{server_id}/networks

List all registered networks and views in a server

Parameters:

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

Status Codes:

• 200 OK – An array of networks Returns: Networks 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}/networks/{ip}/{prefixlen}

Return the view associated to the given network

Parameters:

• server_id (string) – The id of the server to retrieve
• ip (string) – The base address of the network
• prefixlen (string) – The length of the network prefix

Status Codes:

• 200 OK – A network Returns: Network 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}/networks/{ip}/{prefixlen}

Sets the view associated to the given network

Parameters:

• server_id (string) – The id of the server to retrieve
• ip (string) – The base address of the network
• prefixlen (string) – The length of the network prefix

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

Examples

Listing all networks

GET /api/v1/servers/localhost/networks 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

{"networks": [{"network":"192.168.0.0/16","view":"trusted"},{"network":"0.0.0.0/0","view":"untrusted"}]}

Listing the view of a given network

GET /api/v1/servers/localhost/networks/192.168.0.0/16 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

{"networks": [{"network":"192.168.0.0/16","view":"trusted"}]}

Setting up a network

PUT /api/v1/servers/localhost/networks/192.168.0.0/16 HTTP/1.1
X-API-Key: secret
Content-Type: application/json

{"view": "trusted"}

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

HTTP/1.1 204 No Content