Skip to main content

Vega API

note

Vega API is in Open Preview and is not General Availability (GA) at this time. More information about release phases may be found here.

Vega API Documentation​

The Vega API documentation can be found at https://api.vegacloud.io/docs

Purpose​

The Vega API is a set of endpoints that allows integration to the Vega Platform in a programmatic way. Examples of integrations include:

  • Users and their permissions
  • Provider Accounts
  • Resources
  • Schedules (Policies)
  • Business Groupings (Business Units)

Connecting to the Vega API​

To ensure secure access to the API, we utilize JWT (JSON Web Token) authentication. The token is validated to verify the user's identity and permissions and must be included in the Authorization header of the HTTP request to access protected endpoints.

tip

Generate an API Client Registration to securely access the Vega API.