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 an API Service Token

Service tokens can be created by users with owner-level permissions and are associated with an account, not with an individual user. For Enterprise customers who use teams and role-based access control, you have the option of selecting a team to inherit permissions from.

To generate an API service token:

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

Create an API Personal Access Token

To generate an API personal access token:

  1. Navigate to the Settings screen in Vantage.
  2. On the left navigation menu, select API Access Tokens, then navigate to the Personal Access Tokens tab.
  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>'