Authorisation parameters

To make authorised API calls, include the x-auth-token as an HTTP header parameter in each request. Use the JWT received from the authentication response as the value for the x-auth-token parameter.

For example:

Shell (bash)

-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMTAtMDRUMTM6MTI6MzYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTY0MjUxNTZ9.jelwZ8DCr9qBhJ0IBy_3i6Ki0Yc0-Clq92FDubiZQ4c'

Sample API call

For an example of using a JWT as the value for the x-auth-token parameter, refer to the refresh token section in the API Cookbook.