API Reference

Here you can find a list all endpoints available to use across the Connectware API.

The Connectware API provides a comprehensive set of interfaces for managing and interacting with your Industrial IoT environment. This reference documentation covers the essential API endpoints that allow you to control all aspects of Connectware.

Use these APIs to manage access, deploy and configure services, monitor resources, track system status, and integrate industrial protocols.

Connectware API Overview

Auth-Server API

Use the Auth-Server API to manage authentication and user related configuration, including local users and external identity provider integration.

Typical use cases

• Manage local users and roles to control access.

• Configure the LDAP and Microsoft Entra ID integration for centralized authentication.

• Handle login, logout, and token based authentication.

• Enforce role based access control and multi-factor authentication.

For the full API definition, see Auth-Server API.

Services API

Use the Services API to create, update, and manage Connectware services and their lifecycle.

Typical use cases

• Create and update service definitions for data flows and logic.

• Retrieve service information and status.

• Validate service configurations before deployment.

• Manage service dependencies and associated resources.

For the full API definition, see Services API.

Resources API

Use the Container Manager API to inspect runtime container information in Connectware. This API is mainly intended for diagnostics and troubleshooting.

Typical use cases

• Inspect running containers.

• Retrieve container logs and runtime metadata.

• Access container health and lifecycle state.

• Retrieve orchestrator details such as Docker or Kubernetes information.

For the full API definition, see Resources API.

System Status API

Use the System Control Server API to retrieve system health information and licensing related status.

Typical use cases

• Check system health and availability.

• Trigger refresh or control operations provided by the API.

• Retrieve license related information.

For the full API definition, see System Status API.

Resource Status Tracking API

Use the Resource Status Tracking API to monitor the operational state and deviations of resources managed by Connectware. This API is intended for observability and monitoring integrations.

Typical use cases

• Track resource state and deviations.

• Monitor runner heartbeat and activity information.

• Integrate resource status information into observability workflows.

For the full API definition, see Resource Status Tracking API.

Topic Explorer API

Use the Topic Explorer API to explore and search MQTT topics managed by Connectware.

Typical use cases

• Discover available MQTT topics in the system.

• Explore topic hierarchies and structures.

• Search for specific topics or patterns.

For the full API definition, see Topic Explorer API