Vantage Launches New Integrations API Endpoints

Today, Vantage is announcing the launch of new API endpoints for managing provider integrations. Customers who use the Vantage API can now programmatically create integrations for Azure and GCP, view the status of all their existing provider integrations, and manage workspace access for integrations.

Previously, Vantage customers could manually connect provider integrations as well as add integrations to workspaces in the UI; however, it was not possible to programmatically complete these tasks or monitor an integration’s connection status. Customers who often add multiple accounts for Azure or GCP were also unable to automate the creation of these integrations.

Now, with these new integrations endpoints, customers can programmatically view all existing integrations, create new integrations for Azure and GCP, manage granting workspace access for all integrations, and delete integrations. Customers can integrate these new endpoints into existing automations and scripts.

To get started with these new API endpoints, review the API docs. For information on how to create provider integrations in the Vantage UI, see the product documentation.

Frequently Asked Questions

1. What is being announced today?

Vantage is announcing updates to the Vantage API. New /integrations endpoints are available.

2. Who is the customer?

The customer is anyone who wants to programmatically view, create, and manage provider integrations.

3. How much does this cost?

These endpoints are free to all users, including those in the free tier.

4. Which new endpoints are available?

• GET /integrations: retrieves all existing integrations
• POST /integrations/azure: creates a new Azure integration
• POST /integrations/gcp: creates a new GCP integration
• DELETE /integrations/{integration_token}: deletes a specific integration
• GET /integrations/{integration_token}: gets information about an existing integration
• PUT /integrations/{integration_token}: updates workspace access for an existing integration

5. How do you use these endpoints?

To fetch all connected integrations, send a GET request to /integrations. The following JSON is returned in a successful 200 response.

curl --location 'https://api.vantage.sh/v2/integrations' \
--header 'Authorization: Bearer <AUTH_TOKEN>' \
--header 'content-type: application/json'

  "integrations": [
    {
      "token": "accss_crdntl_b1234c567cg890c",
      "provider": "snowflake",
      "account_identifier": "abc12345.us-east-1.snowflakecomputing.com",
      "status": "connected",
      "workspace_tokens": [
        "wrkspc_12345a6e89ab165",
        "wrkspc_123ad45v678cc9a0"
      ],
      "created_at": "2023-07-27T15:24:44Z"
    }
    ]

The integration’s unique token is returned, along with connected workspaces and a connection status. You can use the token to add additional workspace connections via a PUT call to the /integrations/{integration_token} endpoint.

6. Which provider integrations can be connected via the Vantage API?

You can create an integration with Azure and GCP via the Vantage API. For AWS, Vantage already includes an option to connect via the Terraform provider.

To connect an Azure account, send the following API call:

curl --request POST \
     --url https://api.vantage.sh/v2/integrations/azure \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <AUTH_TOKEN>' \
     --header 'content-type: application/json' \
     --data '
{
  "tenant": "<Azure AD Tenant ID>",
  "app_id": "<Azure Service Principal Application ID>",
  "password": "<Azure Service Principal Password>"
}
'

Additional information about our Azure connection process and required inputs can be found in the product documentation.

To connect a GCP account, send the following API call:

curl --request POST \
     --url https://api.vantage.sh/v2/integrations/gcp \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <AUTH_TOKEN>' \
     --header 'content-type: application/json' \
     --data '
{
  "billing_account_id": "<GCP billing account ID>",
  "project_id": "<GCP project ID>",
  "dataset_name": "<BigQuery dataset name>"
}
'

Additional information about our GCP connection process and required inputs can be found in the product documentation.

7. How do I authenticate with Vantage to use the API?

The Vantage API uses a Vantage API token for authentication. All API calls performed by the API are authenticated via your user token.

8. Where can I read the documentation?

Vantage provides multiple resources for getting started with the API:

• The Vantage API documentation site contains information about available API endpoints and provides a tool for running API calls directly on the site.
• The “FinOps as Code” repository contains tutorials and code samples for getting started with the Vantage API.