API

This section is for developers and testers who know how to work with HTTP and OpenAPI. It documents only endpoints currently exposed by platform-api.

The API documentation has three layers:

• Guides explain authentication, errors, common requests, and domain-specific behavior.
• The generated Reference is built from the OpenAPI contract and provides a searchable page for every operation, parameter, request body, response, and schema.
• The interactive API console uses the same OpenAPI file and can send real requests to test, local development, or production.

Start with Getting started for the base URLs and first request. Resource Inventory explains lifecycle, scope, device-type field contracts, and the unique Flow relationship.

The test environment is selected first in the console. Requests are real: POST, PUT, PATCH, and DELETE can change data. Authentication and tenant permissions are enforced by the API exactly as they are for the web console.

An endpoint is considered available only after it is documented in the OpenAPI contract. Telemetry and export schemas may exist as future contracts, but no corresponding endpoint appears in the reference until the behavior is implemented.