API Authentication
API requests require an API key for authentication, obtained from the system settings within the application. The API key is linked to your user account and automatically identifies the specific site you are targeting.
When working with the API, the same permissions structure as the web interface generally applies,
meaning the user needs to have the public_api and, for example, the manage_devices privileges
to create devices via the API.
Creating an API key
{ style="width: 237px;" }
Navigate to the system settings or account page (see above), then select the "API keys" tab. Click the create ("+") button in the top-right corner of the section to generate a new API key. Choose a label (description) for the key to help you identify its purpose later and a "time-to-live" (which will determine when the key expires).
Note that you will not be able to change the expiration date later, so choose accordingly. When a key expires, it will no longer be valid, and a new key will need to be generated.
Once you click "Create", the authentication token associated with the API key will be displayed once. Make sure to copy it and store it securely, as there is no way to retrieve it later.
Using Your API Key
Once you have your API key, include it in your API requests as a header:
Authorization: Bearer your-api-key-here
The API key automatically identifies the site.
See cURL example for practical examples of how to use your API key in requests.