API Settings

API Settings

The API settings page found under Administration → Settings allows you to control if API endpoints are served, blocked or require authentication from uControl.

By default all API endpoints are locked. To enable simply highlight the entry on the table and click "Unlock API" or "Authenticate API"

API Endpoints

There are many API endpoints that uControl serves to users to allow them to integrate with uControl and the data it holds. The following sections detail the API endpoints available and their usage: 


Authenticated API Endpoint

Use an API token in all API requests in the header section, key - Authorization, value = Bearer <TOKEN>:

See here how to create an API token for a user

The user will need to be part of the API team in order to generate an api token



Related content