Authentication¶

The Zerynth Device Manager REST APIs offer access to devices, job and FOTA services, as well as workspaces and fleets. This API can be called from any application that can send an HTTPS request and receive an HTTPS response.

HTTPS only

All requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Set the Content-Type header to application/json.
Set the X-API-KEY header to a valid API Key. For information about how to get an API key, see Authentication.

Authentication¶

Zerynth Device Manager grants access to endpoints by verifying an API key.

The API key is a unique identifier that authenticates your requests and it is bound to a single workspace.

Create an API key¶

To create an API key:

Login to Zerynth Device Manager.
Choose a workspace.
Go to the Settings page.
Click on New API key. Choose a name for the API key and click OK
The newly created API key is now showed.

Using the API key¶

You must include a valid API key with every request. In the following example, replace YOUR_API_KEY with your API key.

curl --request GET \
  --url https://api.zdm.zerynth.com/v3/workspaces/ \
  --header 'X-API-KEY: YOUR_API_KEY'