---
title: "REST-API-Dokumentation"
slug: "rest-api-documentation"
updated: 2025-09-02T12:42:53Z
published: 2025-09-02T12:42:53Z
canonical: "docs.insys-icom.com/rest-api-documentation"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.insys-icom.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST-API-Dokumentation

**icom Router Management (iRM)** bietet eine umfassende REST-API, mit der sich nahezu alle Funktionen der Benutzeroberfläche automatisieren und in externe Systeme integrieren lassen. Ob Gerätegruppen verwaltet, Konfigurationen aktualisiert oder Verbindungsstatus überwacht werden sollen – unsere REST-API stellt die passenden Endpunkte bereit, um sichere und effiziente Workflows zu realisieren.

---

### Was ist enthalten?

Unsere REST-API bildet die iRM-Oberfläche nahezu vollständig ab:

- Die meisten Funktionen aus dem UI stehen auch per API zur Verfügung.
- Die API folgt dem **REST-Standard** und verwendet **JSON** für den Datenaustausch.
- Der Zugriff erfolgt sicher über API-Tokens, die im Administrationsbereich von iRM erstellt werden können.

---

### Interaktiv testen mit Swagger UI

Für einen schnellen Einstieg steht Ihnen unsere interaktive **Swagger UI** zur Verfügung:

👉 [**Swagger UI öffnen**](https://api.insys-tec.net/swagger/index.html)

Mit der Swagger-Oberfläche können Sie:

- **Alle Endpunkte durchstöbern**
- **Anfrage- und Antwortformate verstehen**
- **Live-Tests direkt im Browser durchführen**

> [!TIP]
> **So erhalten Sie einen API Token**
> 
> Sie können Ihr API-Token direkt in iRM generieren und im Swagger-Dialog zur Autorisierung einfügen, um API-Anfragen sicher live zu testen.
> 
> Token können **in der iRM-Benutzeroberfläche** unter **Administration → Einstellungen → API Token** erstellt, eingesehen und widerrufen werden.
> 
> Wenn Sie Hilfe beim Verwalten Ihrer Tokens benötigen, lesen Sie bitte unsere ausführliche Anleitung: [API-Tokens verwalten](/kb/docs/de/managing-api-tokens)

---

### API-Dokumentation als JSON (Swagger 2.0)

Wenn Sie lieber mit eigenen Tools wie **Postman**, **OpenAPI-Clients** oder Code-Generatoren arbeiten, steht Ihnen die vollständige **Swagger 2.0-kompatible JSON-Datei** zum Download bereit:

📥 [**Swagger JSON herunterladen**](https://api.insys-tec.net/swagger/doc.json)

---

### Was ist REST? Was ist Swagger?

- **REST (Representational State Transfer)** ist ein verbreiteter Architekturstil für APIs, der HTTP-Methoden wie GET, POST, PUT und DELETE nutzt, um auf Ressourcen zuzugreifen.
- **Swagger (OpenAPI)** ist ein offener Standard zur Dokumentation und zum Testen von REST-APIs. Entwickler erhalten dadurch einen schnellen und verständlichen Einstieg ohne tiefgehende technische Vorkenntnisse.

---

### Sicherheit bei der API-Nutzung

Der Zugriff auf die API ist tokenbasiert geschützt. Bitte beachten Sie:

- Behandeln Sie Tokens wie Passwörter – halten Sie sie geheim.
- Verwenden Sie ausschließlich HTTPS für die API-Kommunikation.
- Widerrufen Sie Tokens sofort, falls sie kompromittiert wurden.

---

Bei Fragen oder Feedback zur API-Dokumentation wenden Sie sich bitte an unser Support-Team: 📧 [support@insys-icom.de](mailto:support@insys-icom.de)