Obtaining an authentication token

To use the management API, you must first obtain an authentication token. This token, along with other information, must be supplied on all API calls.


  1. On the Swagger page, click sessions.
  2. Click POST to display the API call used to return an authentication token.
  3. Type the email address (that is, user name) and password for your administrator account.
  4. Click Try it out.

    example sign in

    If the user name and password are valid, you should receive the HTTP status code 201, indicating success.
  5. Copy the authentication token (without the quotes) returned in the response body.

    example response body

  6. Use this token as the X-API-Token parameter when making future API calls.