Public API
Read a project's data programmatically — authentication with access tokens, base URL, formats, and conventions.
The public API lets other systems read a project’s data over HTTP — for feeding dashboards, reports, billing, or analytics outside THMI. It exposes the same data you see in the Cloud (tags, their values, history, and pages), as a plain REST API.
Authenticating
Every request is authenticated with an access token. Create a token, choose which projects and resources it may read, then send it as a bearer token:
Authorization: Bearer <your-token>A token only reaches the projects and resource types it was granted, so you can hand out narrowly-scoped access — exactly the data a given system needs and no more. The API is read-only.
Base URL and versioning
The API is served under /api/v1 on your Cloud host, and most paths are
scoped to a project:
https://<your-cloud-host>/api/v1/{projectId}/...The v1 in the path is the API version. See Endpoints
for the full list.
Formats
- Responses are JSON by default; some endpoints also return CSV (for exports and history) or SVG (for pages) — the format is part of the path where it applies.
- History and CSV-export endpoints use POST with a JSON body to carry the query (time range, tags, grouping); everything else is GET. Both are read operations.
The OpenAPI specification
The API publishes its own OpenAPI specification — the authoritative, always-up-to-date definition of every endpoint, parameter, and response. Fetch it as JSON or YAML:
https://<your-cloud-host>/api/openapi.json
https://<your-cloud-host>/api/openapi.yamlPoint your API client or code generator at it rather than copying paths by hand.