Incus networks API is one of 22 APIs that Incus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include networks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.
This API exposes
10 operations
across 5 paths,
and defines 12 schemas.
It is described by OpenAPI 2.0, at version 1.0.
10 operations5 paths12 schemas1 DELETE5 GET1 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 5 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
networks 10
GET
/1.0/networks
Get the networks
networks_get3 params→ 200403500
POST
/1.0/networks
Add a network
networks_post3 params→ 200400403500
DELETE
/1.0/networks/{name}
Delete the network
network_delete2 params→ 200400403500
GET
/1.0/networks/{name}
Get the network
network_get3 params→ 200403500
PATCH
/1.0/networks/{name}
Partially update the network
network_patch4 params→ 200400403412500
POST
/1.0/networks/{name}
Rename the network
network_post3 params→ 200400403500
PUT
/1.0/networks/{name}
Update the network
network_put4 params→ 200400403412500
GET
/1.0/networks/{name}/leases
Get the DHCP leases
networks_leases_get3 params→ 200403500
GET
/1.0/networks/{name}/state
Get the network state
networks_state_get3 params→ 200403500
GET
/1.0/networks?recursion=1
Get the networks
networks_get_recursion13 params→ 200403500
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are NetworkState (10 properties), Network (9 properties), NetworkStateBond (7 properties), NetworkStateBridge (6 properties). Each schema is shown below with its type and property counts.
NetworkPost
object
NetworkPost represents the fields required to rename a network
1 property
NetworkStateBond
object
NetworkStateBond represents bond specific state
7 properties
NetworkStateVLAN
object
NetworkStateVLAN represents VLAN specific state
2 properties
NetworkState
object
NetworkState represents the network state
10 properties
NetworkPut
object
NetworkPut represents the modifiable fields of a network
2 properties
NetworkStateBridge
object
NetworkStateBridge represents bridge specific state
6 properties
NetworkStateOVN
object
NetworkStateOVN represents OVN specific state
5 properties
NetworkStateCounters
object
NetworkStateCounters represents packet counters
4 properties
Network
object
Network represents a network
9 properties
NetworkStateAddress
object
NetworkStateAddress represents a network address
4 properties
NetworksPost
object
NetworksPost represents the fields of a new network
4 properties
NetworkLease
object
NetworkLease represents a DHCP lease
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
