{ "opencollection": "1.0.0", "info": { "name": "Incus external REST certificates networks API", "version": "1.0" }, "items": [ { "info": { "name": "networks", "type": "folder" }, "items": [ { "info": { "name": "Get the networks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/1.0/networks", "params": [ { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "all-projects", "value": "true", "type": "query", "description": "Retrieve networks from all projects" }, { "name": "filter", "value": "default", "type": "query", "description": "Collection filter" } ] }, "docs": "Returns a list of networks (URLs)." }, { "info": { "name": "Add a network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/1.0/networks", "params": [ { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Creates a new network.\nWhen clustered, most network types require individual POST for each cluster member prior to a global POST." }, { "info": { "name": "Get the network", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/1.0/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Gets a specific network." }, { "info": { "name": "Rename the network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/1.0/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" } ] }, "docs": "Renames an existing network." }, { "info": { "name": "Update the network", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/1.0/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Updates the entire network configuration." }, { "info": { "name": "Partially update the network", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/1.0/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Updates a subset of the network configuration." }, { "info": { "name": "Delete the network", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/1.0/networks/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" } ] }, "docs": "Removes the network." }, { "info": { "name": "Get the DHCP leases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/1.0/networks/:name/leases", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Returns a list of DHCP leases for the network." }, { "info": { "name": "Get the network state", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/1.0/networks/:name/state", "params": [ { "name": "name", "value": "", "type": "path", "description": "Network name" }, { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "target", "value": "server01", "type": "query", "description": "Cluster member name" } ] }, "docs": "Returns the current network state information." }, { "info": { "name": "Get the networks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/1.0/networks?recursion=1", "params": [ { "name": "project", "value": "default", "type": "query", "description": "Project name" }, { "name": "all-projects", "value": "true", "type": "query", "description": "Retrieve networks from all projects" }, { "name": "filter", "value": "default", "type": "query", "description": "Collection filter" } ] }, "docs": "Returns a list of networks (structs)." } ] } ], "bundled": true }