For the complete documentation index, see llms.txt. This page is also available as Markdown.

Public REST API

Kilo IoT Server Public REST API — primary integration surface over HTTPS/JSON with X-API-Key and X-Organization-Id.

The REST API is the primary way to integrate Kilo IoT Server with external systems over standard HTTPS. Any language or tool that can make an authenticated HTTP request can use it — backend services, data pipelines, reporting jobs, and operational tooling.

Use the API reference for the full list of endpoints, request parameters, response schemas, and required scopes.

Base endpoint and authentication

Requests go to the secured production endpoint and carry two headers:

  • X-API-Key — a scoped key created in Settings → API Keys.

  • X-Organization-Id — the organization the request operates in; it must match the key's organization. Some operations also accept the organization as an organizationId query parameter instead of the header.

All traffic is over TLS. Treat the key like a credential — see Authentication & API keys.

What the API can do

REST is the broad, primary surface. Subject to the scopes granted to the key, integrations can work across the platform — for example: read the account/user profile; list and manage devices and their physical-device configuration (the client device ID, the connection it binds to, and connection-specific settings), their sensors and sensor mappings, and sensor templates; read sensor history and last-seen values; read connector definitions and manage connections; read and manage dashboards and widgets; read organization, membership, and subscription data; read and manage automation rule definitions, along with their versions and builds; and define and dispatch device commands to control hardware.

For typed service-to-service or on-premise integrations, see gRPC API.

Workflow

  1. Create a scoped key in Settings → API Keys and store it securely.

  2. Find the operation you need in the API reference.

  3. Call it with X-API-Key and X-Organization-Id.

  4. Handle standard HTTP status codes and JSON responses.

A minimal authenticated call is in Examples.

See also

Last updated