Authenticate to the REST API
All Vantage REST API requests require a Bearer token in the Authorization header. This guide covers getting a key and making an authenticated request.
Prerequisites
- A Vantage account
Step 1: Get an API key
Follow Generate and use API keys to create a key from Account Settings. Copy the key immediately; it is shown only once.
Step 2: Find the base URL
All API requests use:
https://api.vantage.omnivector.solutions/v1
Step 3: Make an authenticated request
Pass the key as a Bearer token:
curl -s \
-H "Authorization: Bearer YOUR_API_KEY" \
https://api.vantage.omnivector.solutions/v1/reference/clusters \
| jq .
A successful response returns a JSON array of your clusters.
Step 4: Test the connection
Use the auth test endpoint to verify your key and scopes:
curl -s \
-H "Authorization: Bearer YOUR_API_KEY" \
https://api.vantage.omnivector.solutions/v1/auth/test \
| jq .
The response includes authenticated, user_id, scopes, and expires_at.
Handle errors
| Status | Meaning | Fix |
|---|---|---|
401 Unauthorized | Invalid or expired token | Generate a new API key |
403 Forbidden | Insufficient scope for this endpoint | Request additional permission groups from your admin |