The REST API is served under /cxs on the default HTTP port (8181).
Unomi 3.1 authentication:
| Access | Credentials |
|---|---|
Public endpoints (/cxs/context.json, /cxs/eventcollector, …) | X-Unomi-Api-Key: <tenant-public-key> |
| Tenant private endpoints | Basic auth tenantId:privateApiKey |
| System administration (tenants, cluster, tasks, …) | JAAS user (for example karaf:karaf) |
Key manual chapters:
manual/src/main/asciidoc/multitenancy.adoc — tenants and API keysmanual/src/main/asciidoc/request-examples.adoc — curl examples with authmanual/src/main/asciidoc/useful-unomi-urls.adoc — endpoint referencemanual/src/main/asciidoc/scheduler.adoc — /cxs/tasks APIPostman collections: see rest/postman-readme.md.
rest-documentation branch (adds @Path annotations and the Maven plugin for doc generation).git rebase master.mvn test.target/miredot/index.html.