networks
Manage networks.
get /networks
List all configured networks.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
post /networks
Create a new network
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"ip": "string",
"mtu": 42,
"type": "other",
"gateway": "string",
"netmask": 42,
"poolEnd": "string",
"poolStart": "string",
"description": "string"
}put /networks/{id}
Replace a network, must provide the full network config
Parameters
id integer path Required
body object
Examples
Request Body
{
"ip": "string",
"mtu": 42,
"type": "other",
"gateway": "string",
"netmask": 42,
"poolEnd": "string",
"poolStart": "string",
"description": "string"
}delete /networks/{id}
Delete a network by its ID
Parameters
id integer path Required
Examples
No request body required