Routers

Get a router

The full record of one piece of equipment, with its networks and tags.

Required scope infrastructure:read

get/routers/{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 equipment.

Response200 · application/json

The equipment record.

idstring<uuid>required

Identifier of the equipment.

namestringrequired

Name of the equipment.

typeenum<string>required

Kind of equipment.

Available options: router, firewall, switch, access_point

ipAddressstring | null

Management address of the equipment.

locationstring | null

Where the equipment sits.

descriptionstring | null

Free-text description of the equipment.

internetConnectionstring | null

Internet link the equipment carries.

criticalitystring | null

Business criticality of the equipment.

tagsany[]

Tags attached to the equipment.

networksobject[]

Networks the equipment is connected to.

customFieldsany[]

Workspace custom fields and their values.

{ "id": "3f9c9f2e-8a71-4e2a-9b0d-2c5f6a1d7e44", "name": "<string>", "type": "router", "ipAddress": "<string>", "location": "<string>", "description": "<string>", "internetConnection": "<string>", "criticality": "<string>", "tags": [ { "id": "3f9c9f2e-8a71-4e2a-9b0d-2c5f6a1d7e44", "name": "<string>" } ], "networks": [ { "id": "3f9c9f2e-8a71-4e2a-9b0d-2c5f6a1d7e44", "name": "<string>", "role": "<string>", "interfaceAddress": "<string>" } ], "customFields": [ { "id": "3f9c9f2e-8a71-4e2a-9b0d-2c5f6a1d7e44", "name": "<string>", "type": "text", "description": "<string>", "value": null } ] }