Routeurs

Créer un routeur

Déclare un nouveau routeur, pare-feu, commutateur ou point d'accès.

Scope requis infrastructure:add

post/routers

Authentification

Authorizationstringobligatoire

En-tête Authorization portant une clé d'API de l'espace de travail, sous la forme « Bearer kbn_live_… ». L'en-tête X-Api-Key est accepté de façon équivalente.

Corps de la requêteapplication/json

namestringobligatoire

Nom de l'équipement.

typeenum<string>obligatoire

Type de la ressource.

Valeurs possibles : router, firewall, switch, access_point

ipAddressstring

Adresse d'administration de l'équipement.

locationstring

Emplacement physique.

descriptionstring

Courte description libre.

internetConnectionstring

Lien Internet porté par l'équipement.

Réponse201 · application/json

L'équipement a été créé.

idstring<uuid>obligatoire

Identifiant unique.

namestringobligatoire

Nom de l'équipement.

typeenum<string>obligatoire

Type d'équipement.

Valeurs possibles : router, firewall, switch, access_point

ipAddressstring | null

Adresse d'administration de l'équipement.

locationstring | null

Emplacement physique.

descriptionstring | null

Courte description libre.

internetConnectionstring | null

Lien Internet porté par l'équipement.

criticalitystring | null

Criticité métier attribuée.

tagsany[]

Tags attachés à la ressource.

networksobject[]

Réseaux auxquels l'équipement est connecté.

customFieldsany[]

Champs personnalisés de l'espace de travail et leurs valeurs.

curl --request POST \ --url https://app.kabeen.io/public/v1/routers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "type": "router", "ipAddress": "<string>", "location": "<string>", "description": "<string>", "internetConnection": "<string>" }'

{ "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 } ] }