API

An API is the interface that lets a program drive a service: send commands and read data, without the graphical interface. The Ubidesk API is a REST API, JSON-based, over port 443.

It exposes sessions (creation, six-digit code, state), devices, the audit log and users. Authentication uses a token issued from the console and revocable at any time; every call is written to the audit log.

In practice

The API and webhooks are available on the Business plan. Never put a token in versioned code: use a secrets vault.