Networks

Get a network

The full record of a network, with the routers connected to it.

Required scope infrastructure:read

get/networks/{id}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the network.

Response200 · application/json

The network record.

idstring<uuid>required

Identifier of the network.

namestringrequired

Name of the network.

roleenum<string>required

Role the network plays.

Available options: local, wireless, storage, vpn, data_center, edge, public, management, dmz, iot, intercommunication

ipAddressstring

Base address of the network.

subnetstring

Subnet in CIDR notation.

descriptionstring | null

Free-text description of the network.

vlanIdinteger | null

VLAN the network is carried on.

routersobject[]

Routers connected to the network.