icom Router Management (iRM) provides a comprehensive REST API that enables users to automate and integrate most platform operations available in the web interface. Whether you're looking to manage device groups, update configurations, or monitor connection statuses—our REST API provides the necessary endpoints to build reliable, secure automation workflows.
What’s Available
Our REST API mirrors the iRM user interface closely:
Most operations available in the UI can also be executed programmatically.
The API uses standard REST conventions with JSON as the data format.
Secure access via API tokens is required. Token management is available in your iRM administration settings.
Explore the API with Swagger UI
To help you get started quickly, we offer an interactive Swagger UI:
The Swagger interface allows you to:
Browse all endpoints
Understand request and response formats
Live test the API from your browser using a valid token
How to get an API key
You can generate your API token in iRM and paste it into the Swagger authorization dialog to test live requests securely. You can create, view, and revoke tokens in the iRM user interface under Settings → API Access → Tokens.
If you need help managing your tokens, refer to our dedicated guide: Managing API Tokens
Downloadable API Definition (Swagger 2.0 JSON)
If you prefer working with your own tools or integrating the API into other platforms like Postman, OpenAPI clients, or code generators, you can download the full Swagger 2.0-formatted JSON file here:
What is REST? What is Swagger?
REST (Representational State Transfer) is a widely adopted API architecture style that uses standard HTTP methods like GET, POST, PUT, and DELETE to interact with resources.
Swagger (OpenAPI) is an open standard for documenting and testing REST APIs. It helps developers understand how to use APIs without needing to dig through raw code or documentation.
API Security
Access to the API is protected via token-based authentication. Be sure to:
Treat tokens like passwords—keep them secure.
Use HTTPS for all API communication.
Revoke and regenerate tokens if compromised.
If you have questions or feedback regarding the API documentation, please contact our support team at support@insys-icom.de.