Routers

Create a router

Declare a new router, firewall, switch or access point.

Required scope infrastructure:add

post/routers

Authorizations

Authorizationstringrequired

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

Bodyapplication/json

namestringrequired

Name of the equipment.

typeenum<string>required

Kind of equipment.

Available options: router, firewall, switch, access_point

ipAddressstring

Management address of the equipment.

locationstring

Where the equipment sits.

descriptionstring

Free-text description of the equipment.

internetConnectionstring

Internet link the equipment carries.

Response201 · application/json

The equipment was created.

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.