API Endpoints

Joule REST APIs enables easy custom data processing and integration

Overview

This API Endpoints page offers an overview of Joule's core API functionalities, management capabilities and setup instructions. Joule offers two main API types, each tailored to specific development needs.

This is v1.2.1 an incubating feature which is constantly being refined and extended until v1.3

API reference

For detailed OpenAPI documentation, start Joule and access Swagger documentation at:

http://<host>:9080/swagger

Joule offers two main API types:

Management API

Manages use cases and dependencies, providing endpoints for deployment, pipeline management, connector registration and contextual data sources

Data access API

Enables data interactions, allowing for querying, publishing and consuming data events