Authentication

The Vantage API authenticates all requests with an API access token. Tokens are required to ensure stability of the API and enforce rate limiting. If you do not include a token along with a request or pass an incorrect value, an error is returned within the API response.

šŸš§

Important

It is recommended that you keep your token in a safe place and do not share it.

Create a Personal Access Token

To create a personal access token:

  1. Navigate to the Settings screen in Vantage.
  2. On the left navigation menu, under Personal Settings, click API Access Tokens.
  3. Enter a new token name, select the Read and/or Write scope, and click Create.
  4. Click Show to reveal and copy your token.

Use Your Access Token in a Request

Pass your access token through the Authorization header of a request: 

curl --request GET \
  --url https://api.vantage.sh/v2/cost_reports \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <YOUR TOKEN>'