All Anyscale platform API keys have revocable read-write access, with no option for finer permission scoping. We recommend submitting a feature request to Anyscale, and Vantage will adopt fine-grained permissions if they become available.
Prerequisites
- You need to be an Organization Owner to generate a platform API key in the Anyscale console.
- Create a free Vantage account, then follow the steps below to integrate Anyscale costs.
Create the Connection
Service accounts are available in Anyscale but currently only have collaborator permissions. At this time, personal API keys are recommended for integrations.
Step 1 - Obtain an Anyscale API Key
- CLI (Recommended)
- Console UI
The CLI method allows you to create API keys with custom expiry periods or permanent keys that don’t expire, making it ideal for long-term integrations. For more information, see the Anyscale CLI configuration documentation.
Authenticate using the CLI. You can use either:Or to create a key that expires in 90 days (you’ll need to update the key in Vantage when it expires):A new browser window opens to confirm authentication. Once approved, the CLI stores the access token in
--no-expireto create a permanent API key that never expires--expire-in-days=<days>to set a custom expiry period
~/.anyscale/credentials.json. For more details, see the Anyscale CLI authentication documentation.Retrieve your API key. You can access the file using one of these methods:
-
Using the command line: Open a terminal and run:
Or on macOS/Linux, you can open it in a text editor:
-
Using Finder (macOS): Press
Cmd+Shift+Gin Finder, then type~/.anyscaleand press Enter. Open thecredentials.jsonfile. -
Using File Explorer (Windows): Navigate to
%USERPROFILE%\.anyscale\credentials.jsonin File Explorer.
cli_token field in the JSON file.Step 2 - Add the Key to Vantage
After adding your integration, you will see the status of your integration change to Importing within the Vantage console. This status indicates that Vantage is actively importing your Anyscale cost data. It usually takes less than 15 minutes to ingest Anyscale costs. The integration will fetch historical data up to your account’s configured retention period. See the Integration Status documentation for details on integration statuses.
As soon as costs are processed, they will be available on your All Resources Cost Report. If you decide to remove your Anyscale integration from Vantage, all costs associated with your Anyscale API key will be removed from the Vantage console.
Next Steps - Manage Workspace Access
Once the import is complete and the integration status changes to Stable, you can select which workspaces this integration is associated with. See the Workspaces documentation for information.Data Refresh
See the provider data refresh documentation for information on when data for each provider refreshes in Vantage.Anyscale Reporting Dimensions
On Anyscale Cost Reports, you can filter across several dimensions:- Billing Account (Organization)
- Account (Project)
- Service (e.g., Instances)
- Category (e.g., customer_hosted)
- Subcategory (e.g., k8s)
- Resource ID (Resource ID)
- Charge Type (e.g., Usage)
- Tags: Includes Virtual Tags created in Vantage for this provider. The following provider tags are automatically created by Vantage from Anyscale data and are available for filtering and grouping:
anyscale:cloud_id: The cloud ID associated with the cost, allowing you to filter and group costs by cloud.anyscale:workspace_id: The workspace ID associated with the cost, allowing you to filter and group costs by workspace.anyscale:cloud_provider: The cloud provider (e.g., AWS, GCP, Azure), allowing you to filter and group costs by cloud provider.anyscale:instance_type: The instance type used, allowing you to filter and group costs by instance type.anyscale:user_email: The user email associated with the cost when present in the source data, allowing you to filter and group costs by user email.anyscale:user_id: The user ID associated with the cost when present in the source data, allowing you to filter and group costs by user ID.