Skip to main content

Authentication Methods

The API authenticates requests with an API token sent as X-Aegister-Token. To create one, see Token.

1. Header-Based Authentication

Include the X-Aegister-Token in the request headers. This is the supported method: it keeps the token out of the URL and out of server logs. Example Request:
Curl Example:
Example Response (fields trimmed):
A missing or invalid token returns HTTP 403:

2. Query Parameter Authentication (deprecated)

This method is deprecated and will be removed. A token in the URL ends up in proxy and server logs and in browser history. Use the header instead.
The API still accepts X-Aegister-Token as a query parameter in the URL. Example Request: