Information
- OpenAPI version:
3.0.4
Overview
Consystence API f565f645d
Section titled “Consystence API f565f645d”The public operations the Consystence CLI and its client library call on a tenant’s hosted service ({tenant}.consystence.com for Enterprise tenants, {tenant}.consystence.dev for Integrator tenants and free sandboxes) and on a site server. Exported on 10 November 2026 from Consystence revision f565f645d, which the hosted service was running on that date. Operations marked “Site server only” are served by a site server, not the hosted service; operations marked “Hosted service only” are not served by a site server. For credentials, see API keys and the authentication model.
Authentication
Section titled “ Authentication ”Bearer
Section titled “Bearer”A person’s sign-in token, sent as Authorization: Bearer. On a site server, this includes the site’s own sign-in token.
Security scheme type: http
Bearer format: JWT
ApiKey
Section titled “ApiKey”Tenant API key, sent as X-Api-Key (prefix csk_). A standard key is read-only: it reads tenant and site data and never changes anything, and its role decides which reads it may make. An operator key is bound to one person and one native site (a site where Consystence is the declared operator surface) and lasts at most 30 days; it may also acknowledge alarms on that site. An operator key reads its site through csy ui; over this API it makes only the reads that need no role. See https://docs.consystence.com/api/api-keys/.
Security scheme type: apiKey
Header parameter name: X-Api-Key