Skip to content

API-Referenz

Alle Endpunkte erfordern eine Authentifizierung per JWT-Cookie, außer /api/health, /api/auth/login und /api/auth/setup.

Datenmodell


Authentifizierung

MethodeEndpunktBeschreibung
POST/api/auth/loginAnmelden und JWT-Cookie erhalten
POST/api/auth/logoutAbmelden und JWT-Cookie löschen
GET/api/auth/meAktuell authentifizierten Benutzer abrufen
POST/api/auth/setupErsteinrichtung des Admin-Kontos

Switches

MethodeEndpunktBeschreibung
GET/api/switchesAlle Switches auflisten
POST/api/switchesNeuen Switch erstellen
GET/api/switches/:idSwitch nach ID abrufen
PUT/api/switches/:idSwitch nach ID aktualisieren
DELETE/api/switches/:idSwitch nach ID löschen
POST/api/switches/:id/duplicateSwitch duplizieren
PUT/api/switches/sortSortierreihenfolge der Switches aktualisieren

Switch-Ports

MethodeEndpunktBeschreibung
PUT/api/switches/:id/ports/:portIdSwitch-Port aktualisieren
DELETE/api/switches/:id/ports/:portIdSwitch-Port löschen
PUT/api/switches/:id/ports/bulkSwitch-Ports per Massenoperation aktualisieren

Switch-LAG-Gruppen

MethodeEndpunktBeschreibung
GET/api/switches/:id/lag-groupsLAG-Gruppen eines Switches auflisten
POST/api/switches/:id/lag-groupsLAG-Gruppe erstellen
GET/api/switches/:id/lag-groups/:idLAG-Gruppe nach ID abrufen
PUT/api/switches/:id/lag-groups/:idLAG-Gruppe nach ID aktualisieren
DELETE/api/switches/:id/lag-groups/:idLAG-Gruppe nach ID löschen

VLANs

MethodeEndpunktBeschreibung
GET/api/vlansAlle VLANs auflisten
POST/api/vlansNeues VLAN erstellen
GET/api/vlans/:idVLAN nach ID abrufen
PUT/api/vlans/:idVLAN nach ID aktualisieren
DELETE/api/vlans/:idVLAN nach ID löschen
GET/api/vlans/:id/referencesObjekte abrufen, die dieses VLAN referenzieren
GET/api/vlans/suggest-colorFarbvorschlag für ein neues VLAN

Netzwerke

MethodeEndpunktBeschreibung
GET/api/networksAlle Netzwerke auflisten
POST/api/networksNeues Netzwerk erstellen
GET/api/networks/:idNetzwerk nach ID abrufen
PUT/api/networks/:idNetzwerk nach ID aktualisieren
DELETE/api/networks/:idNetzwerk nach ID löschen
GET/api/networks/:id/referencesObjekte abrufen, die dieses Netzwerk referenzieren
GET/api/networks/:id/utilizationIP-Auslastungsstatistiken des Netzwerks abrufen

Netzwerk-IP-Zuweisungen

MethodeEndpunktBeschreibung
GET/api/networks/:id/allocationsZuweisungen eines Netzwerks auflisten
POST/api/networks/:id/allocationsIP-Zuweisung erstellen
GET/api/networks/:id/allocations/:allocIdZuweisung nach ID abrufen
PUT/api/networks/:id/allocations/:allocIdZuweisung nach ID aktualisieren
DELETE/api/networks/:id/allocations/:allocIdZuweisung nach ID löschen

Netzwerk-IP-Bereiche

MethodeEndpunktBeschreibung
GET/api/networks/:id/rangesIP-Bereiche eines Netzwerks auflisten
POST/api/networks/:id/rangesIP-Bereich erstellen
GET/api/networks/:id/ranges/:rangeIdIP-Bereich nach ID abrufen
PUT/api/networks/:id/ranges/:rangeIdIP-Bereich nach ID aktualisieren
DELETE/api/networks/:id/ranges/:rangeIdIP-Bereich nach ID löschen

Layout-Templates

MethodeEndpunktBeschreibung
GET/api/layout-templatesAlle Layout-Templates auflisten
POST/api/layout-templatesLayout-Template erstellen
GET/api/layout-templates/:idLayout-Template nach ID abrufen
PUT/api/layout-templates/:idLayout-Template nach ID aktualisieren
DELETE/api/layout-templates/:idLayout-Template nach ID löschen
POST/api/layout-templates/:id/duplicateLayout-Template duplizieren
GET/api/layout-templates/:id/exportLayout-Template als Datei exportieren
POST/api/layout-templates/importLayout-Template aus Datei importieren

Benutzer

MethodeEndpunktBeschreibung
GET/api/usersAlle Benutzer auflisten
POST/api/usersNeuen Benutzer erstellen
GET/api/users/:idBenutzer nach ID abrufen
PUT/api/users/:idBenutzer nach ID aktualisieren
DELETE/api/users/:idBenutzer nach ID löschen
PUT/api/users/:id/passwordBenutzerpasswort ändern

Einstellungen

MethodeEndpunktBeschreibung
GET/api/settingsAnwendungseinstellungen abrufen
PUT/api/settingsAnwendungseinstellungen aktualisieren

Dashboard & Werkzeuge

MethodeEndpunktBeschreibung
GET/api/healthHealth-Check-Endpunkt (keine Auth.)
GET/api/dashboard/statsDashboard-Statistiken abrufen
GET/api/searchGlobale Suche über alle Entitäten
GET/api/subnet-calculatorSubnetz-Details aus CIDR berechnen

Topologie

MethodeEndpunktBeschreibung
GET/api/sites/:siteId/topologyTopologie-Daten (Nodes, Links, Ghost-Nodes) für einen Standort
GET/api/sites/:siteId/topology-layoutGespeicherte Node-Positionen abrufen
PUT/api/sites/:siteId/topology-layoutNode-Positionen speichern
DELETE/api/sites/:siteId/topology-layoutGespeichertes Layout zurücksetzen

Datenverwaltung

MethodeEndpunktBeschreibung
GET/api/backup/exportVollständiges Backup als Archiv exportieren
POST/api/backup/importVollständiges Backup aus Archiv importieren
GET/api/data/exportAlle Daten als JSON exportieren
POST/api/data/importAlle Daten aus JSON importieren
GET/api/data/templateLeere Datenvorlage herunterladen
GET/api/export/:entityEinzelnen Entitätstyp als CSV exportieren
POST/api/import/:entityEinzelnen Entitätstyp aus CSV importieren
GET/api/import/template/:entityCSV-Vorlage für Entität herunterladen

Aktivität

MethodeEndpunktBeschreibung
GET/api/activityAktuelle Aktivitätsprotokoll-Einträge auflisten
POST/api/activity/:id/undoAktivitätsprotokoll-Eintrag rückgängig machen

Released under the GPL-3.0 License.