Overview¶

The Device Hub offers a RESTful API. It allows other systems to interact with the Device Hub. The current version of the Device Hub API is v1.

Browsable API¶

The Device Hub API is the collection of the APIs provided by the applications activated on the Device Hub instance (e.g. Device APIs, Data APIs, Firmware APIs).

These APIs usually have multiple "sub" APIs which address different features of the application (e.g. the Firware APIs are Firmware Update, Firmware, Delivery Procedure, ...).

The API is self-documenting: By visiting an API endpoint with a web browser, a HTML representation of the endpoint is shown that contains documentation of the API itself. The developer is able to view the data that is being returned and is able to place manual requests against the API for development purposes.

To get an overview of all available APIs, visit <BASE-URL>/api/v1/ on your server.

Authorization¶

To access resources, the HTTP Authorization request header can be used to authenticate a user. Currently, only Token authentication scheme is supported.

Example:

1

Authorization: Token <secret-token>

Note: Typically, the API is used with a machine user. See Users and Access Rights about how to create a machine user and token.