Vantage API
The Vantage API consists of a GraphQL API for cluster and team operations and a set of REST endpoints for organization, subscription, and job management.
Authentication
The API uses OAuth 2.0 authentication via Keycloak. Obtain an access token from the Keycloak token endpoint and include it in requests as a Bearer token:
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
https://api.vantage.omnivector.solutions/organizations
REST Endpoints
| Endpoint prefix | Purpose |
|---|---|
/organizations | Organization management, users, invitations |
/subscriptions | Subscription management |
/cloud_accounts | Cloud provider account management |
/roles | Role definitions |
/groups | Permission group management |
/clients | API client management |
/jobbergate/* | Job script templates, job scripts, job submissions |
GraphQL API
Cluster and team operations are served through the GraphQL API. Refer to the interactive documentation for the full schema.
SDK
- Python SDK -- Python client library
Additional Resources
- OpenAPI Specification -- machine-readable API spec
- Interactive API Documentation -- generated from the OpenAPI spec
- Postman -- import the OpenAPI spec at
/openapi.yamlinto Postman to explore endpoints