Skip to main content
This page is auto-generated from the OpenAPI specification. For interactive testing and detailed schemas, visit the individual endpoint pages linked below.

AccessGrants

GET /access_grants

Get all access grants Return all Access Grants that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/accessgrants/get-all-access-grants

POST /access_grants

Create access grant Create an Access Grant.

Request Body

{
  "resource_token": string // required // The token of the resource for which you are granting access,
  "team_token": string // required // The token of the Team you want to grant access to,
  "access": string // The access level you want to grant. Defaults to 'allowed'. Allowed values: `denied`, `allowed`
}

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 406: NotAcceptable 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/accessgrants/create-access-grant

DELETE /access_grants/

Delete access grant Delete an Access Grant.

Path Parameters

  • access_grant_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/accessgrants/delete-access-grant

GET /access_grants/

Get access grant by token Return a specific Access Grant.

Path Parameters

  • access_grant_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/accessgrants/get-access-grant-by-token

PUT /access_grants/

Update access grant Update an AccessGrant.

Path Parameters

  • access_grant_token (path) (string) - Required

Request Body

{
  "access": string // required // Allowed or denied access to resource. Allowed values: `denied`, `allowed`
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/accessgrants/update-access-grant

AnomalyAlerts

GET /anomaly_alerts

Get all anomaly alerts Return all Anomaly Alerts that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • start_date (string (date-time)) - Optional: The start date of the anomalies to return. ISO 8601 formatted.
  • end_date (string (date-time)) - Optional: The end date of the anomalies to return. ISO 8601 formatted.
  • provider (string) - Optional: The provider of the anomalies to return.
  • service (string) - Optional: The service of the anomalies to return.
  • cost_category (string) - Optional: The cost category of the anomalies to return.
  • cost_report_token (string) - Optional: The cost report token of the anomalies to return.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalyalerts/get-all-anomaly-alerts

GET /anomaly_alerts/

Get anomaly alert by token Return an AnomalyAlert that the current API token has access to.

Path Parameters

  • anomaly_alert_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalyalerts/get-anomaly-alert-by-token

PUT /anomaly_alerts/

Update anomaly alert Update an AnomalyAlert.

Path Parameters

  • anomaly_alert_token (path) (string) - Required

Request Body

{
  "status": string // required // The status of the Anomaly Alert,
  "feedback": string // Optional additional comments for why this alert is ignored
}

Responses

200: OK 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalyalerts/update-anomaly-alert

AnomalyNotifications

GET /anomaly_notifications

Get all anomaly notifications Return all Anomaly Notifications.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalynotifications/get-all-anomaly-notifications

POST /anomaly_notifications

Create anomaly notification Create an Anomaly Notification for a Cost Report.

Request Body

{
  "cost_report_token": string // required // The token of the Cost Report that has the notification,
  "threshold": integer // The threshold amount that must be met for the notification to fire,
  "user_tokens": [string] // The tokens of the Users that receive the notification,
  "recipient_channels": [string] // The Slack/MS Teams channels that receive the notification
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalynotifications/create-anomaly-notification

DELETE /anomaly_notifications/

Delete anomaly notification Delete an Anomaly Notification.

Path Parameters

  • anomaly_notification_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalynotifications/delete-anomaly-notification

GET /anomaly_notifications/

Get anomaly notification by token Return an Anomaly Notification that the current API token has access to.

Path Parameters

  • anomaly_notification_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalynotifications/get-anomaly-notification-by-token

PUT /anomaly_notifications/

Update anomaly notification Update an Anomaly Notification.

Path Parameters

  • anomaly_notification_token (path) (string) - Required

Request Body

{
  "threshold": integer // The threshold amount that must be met for the notification to fire,
  "user_tokens": [string] // The tokens of the users that receive the notification,
  "recipient_channels": [string] // The Slack/MS Teams channels that receive the notification
}

Responses

200: OK 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/anomalynotifications/update-anomaly-notification

AuditLogs

GET /audit_logs

Get all audit logs Return all AuditLogs.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • user (integer (int32)) - Optional: Filter by personal or service API token that performed the action.
  • workspace_token (string) - Optional: Filter by workspace token.
  • action (string) - Optional: Filter by action type.
    • Allowed values: create, update, delete
  • object_name (string) - Optional: Filter by object name.
  • source (string) - Optional: Filter by source.
    • Allowed values: console, api, finops_agent
  • object_type (string) - Optional: Filter by object type.
    • Allowed values: virtual_tag, cost_report, recommendation_commitment
  • token (string) - Optional: Filter by audit log token.
  • object_token (string) - Optional: Filter by object token (auditable_token).
  • start_date (string (date)) - Optional: Filter by start date (ISO 8601 format, e.g., 2024-06-01).
  • end_date (string (date)) - Optional: Filter by end date (ISO 8601 format, e.g., 2024-06-01).

Responses

200: OK 403: Forbidden

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/auditlogs/get-all-audit-logs

GET /audit_logs/

Get audit log by token Return a specific AuditLog.

Path Parameters

  • audit_log_token (path) (string) - Required

Responses

200: OK 403: Forbidden 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/auditlogs/get-audit-log-by-token

BillingProfiles

GET /billing_profiles

Get all billing profiles Returns a list of billing profiles (MSP invoicing required).

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingprofiles/get-all-billing-profiles

POST /billing_profiles

Create billing profile Create a billing profile (MSP invoicing required).

Request Body

{
  "nickname": string // required // Display name for the billing profile,
  "billing_information_attributes": { // Billing address and contact information
    "token": string,
    "company_name": string // Company name for billing,
    "country_code": string // ISO country code,
    "address_line_1": string // First line of billing address,
    "address_line_2": string // Second line of billing address,
    "city": string // City for billing address,
    "state": string // State or province for billing address,
    "postal_code": string // Postal or ZIP code,
    "billing_email": [string] // Array of billing email addresses
  },
  "business_information_attributes": { // Business information and custom fields
    "token": string,
    "metadata": { // Business metadata including custom fields
      "custom_fields": [ // Array of custom field objects
        {
          "name": string // Custom field name,
          "value": string // Custom field value
        }
      ]
    }
  },
  "banking_information_attributes": { // Banking details (MSP accounts only)
    "token": string,
    "bank_name": string // Name of the bank,
    "beneficiary_name": string // Name of the account beneficiary,
    "tax_id": string // Tax identification number,
    "secure_data": { // Encrypted banking details
      "account_number": string // Bank account number (US),
      "routing_number": string // Bank routing number (US),
      "iban": string // International Bank Account Number (EU),
      "swift_bic": string // SWIFT/BIC code (EU)
    }
  },
  "invoice_adjustment_attributes": { // Invoice adjustments (taxes, fees, etc.)
    "token": string,
    "adjustment_items": [ // Array of adjustment items
      {
        "name": string // required // Name of the adjustment,
        "adjustment_type": string // Type of adjustment. Allowed values: `charge`, `credit`, `discount`,
        "calculation_type": string // required // How the adjustment is calculated. Allowed values: `fixed`, `percentage`,
        "amount": number // required // Amount or percentage value
      }
    ]
  }
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingprofiles/create-billing-profile

DELETE /billing_profiles/

Delete billing profile Requires MSP invoicing to be enabled on the account.

Path Parameters

  • billing_profile_token (path) (string) - Required

Responses

204: Billing Profile deleted successfully. 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingprofiles/delete-billing-profile

GET /billing_profiles/

Get billing profile by token Requires MSP invoicing to be enabled on the account.

Path Parameters

  • billing_profile_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingprofiles/get-billing-profile-by-token

PUT /billing_profiles/

Update billing profile Requires MSP invoicing to be enabled on the account.

Path Parameters

  • billing_profile_token (path) (string) - Required

Request Body

{
  "nickname": string // Display name for the billing profile,
  "billing_information_attributes": { // Billing address and contact information
    "token": string,
    "company_name": string // Company name for billing,
    "country_code": string // ISO country code,
    "address_line_1": string // First line of billing address,
    "address_line_2": string // Second line of billing address,
    "city": string // City for billing address,
    "state": string // State or province for billing address,
    "postal_code": string // Postal or ZIP code,
    "billing_email": [string] // Array of billing email addresses
  },
  "business_information_attributes": { // Business information and custom fields
    "token": string,
    "metadata": { // Business metadata including custom fields
      "custom_fields": [ // Array of custom field objects
        {
          "name": string // Custom field name,
          "value": string // Custom field value
        }
      ]
    }
  },
  "banking_information_attributes": { // Banking details (MSP accounts only)
    "token": string,
    "bank_name": string // Name of the bank,
    "beneficiary_name": string // Name of the account beneficiary,
    "tax_id": string // Tax identification number,
    "secure_data": { // Encrypted banking details
      "account_number": string // Bank account number (US),
      "routing_number": string // Bank routing number (US),
      "iban": string // International Bank Account Number (EU),
      "swift_bic": string // SWIFT/BIC code (EU)
    }
  },
  "invoice_adjustment_attributes": { // Invoice adjustments (taxes, fees, etc.)
    "token": string,
    "adjustment_items": [ // Array of adjustment items
      {
        "name": string // required // Name of the adjustment,
        "adjustment_type": string // Type of adjustment. Allowed values: `charge`, `credit`, `discount`,
        "calculation_type": string // required // How the adjustment is calculated. Allowed values: `fixed`, `percentage`,
        "amount": number // required // Amount or percentage value
      }
    ]
  }
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingprofiles/update-billing-profile

BillingRules

GET /billing_rules

Get all billing rules Returns a list of billing rules.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingrules/get-all-billing-rules

POST /billing_rules

Create billing rule Create a BillingRule.

Request Body

{
  "type": string // required // The type of the BillingRule. Note: the values are case insensitive. Allowed values: `exclusion`, `adjustment`, `credit`, `charge`, `custom`,
  "title": string // required // The title of the BillingRule,
  "start_period": string // The start period of the BillingRule. DEPRECATED: use start_date instead,
  "start_date": string // The start date of the BillingRule. ISO 8601 formatted,
  "end_date": string // The end date of the BillingRule. ISO 8601 formatted,
  "apply_to_all": boolean // Determines if the BillingRule applies to all current and future managed accounts,
  "charge_type": string // The charge type of the BillingRule. Required for Exclusion rules,
  "percentage": number // The percentage of the cost shown. Required for Adjustment rules. Example value: 75.0,
  "service": string // The service of the BillingRule. Required for Charge and Credit rules,
  "category": string // The category of the BillingRule. Required for Charge and Credit rules,
  "sub_category": string // The subcategory of the BillingRule. Required for Charge and Credit rules,
  "amount": number // The amount for the BillingRule. Required for Charge and Credit rules. Example value: 300,
  "sql_query": string // The SQL query for the BillingRule. Required for Custom rules. Example value: UPDATE costs SET costs.amount = costs.amount * 0.95
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingrules/create-billing-rule

DELETE /billing_rules/

Delete billing rule Delete a BillingRule.

Path Parameters

  • billing_rule_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingrules/delete-billing-rule

GET /billing_rules/

Get billing rule by token Return a BillingRule.

Path Parameters

  • billing_rule_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingrules/get-billing-rule-by-token

PUT /billing_rules/

Update billing rule Update a BillingRule.

Path Parameters

  • billing_rule_token (path) (string) - Required

Request Body

{
  "title": string // The title of the BillingRule,
  "charge_type": string // The charge type of the BillingRule,
  "percentage": number // The percentage of the cost shown. Example value: 75.0,
  "service": string // The service of the BillingRule,
  "category": string // The category of the BillingRule,
  "sub_category": string // The subcategory of the BillingRule,
  "start_period": string // The start period of the BillingRule,
  "amount": number // The credit amount for the BillingRule. Example value: 300,
  "start_date": string // The start date of the BillingRule. ISO 8601 formatted,
  "end_date": string // The end date of the BillingRule. ISO 8601 formatted,
  "apply_to_all": boolean // Determines if the BillingRule applies to all current and future managed accounts,
  "sql_query": string // The SQL query of the BillingRule
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/billingrules/update-billing-rule

BudgetAlerts

GET /budget_alerts

Get all budget alerts Return all BudgetAlerts.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgetalerts/get-all-budget-alerts

POST /budget_alerts

Create budget alert Create a Budget Alert.

Request Body

{
  "budget_tokens": [string] // required // The tokens of the Budget that has the alert,
  "threshold": integer // required // The threshold amount that must be met for the alert to fire,
  "user_tokens": [string] // The tokens of the users that receive the alert,
  "duration_in_days": string // required // The number of days from the start or end of the month to trigger the alert if the threshold is reached.  For the full month, pass an empty value,
  "period_to_track": string // The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month,
  "recipient_channels": [string] // The channels receiving the alerts. Requires an integration provider to be connected
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgetalerts/create-budget-alert

DELETE /budget_alerts/

Delete budget alert Delete a BudgetAlert.

Path Parameters

  • budget_alert_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgetalerts/delete-budget-alert

GET /budget_alerts/

Get budget alert by token Return a BudgetAlert.

Path Parameters

  • budget_alert_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgetalerts/get-budget-alert-by-token

PUT /budget_alerts/

Update budget alert Updates an existing BudgetAlert.

Path Parameters

  • budget_alert_token (path) (string) - Required

Request Body

{
  "budget_tokens": [string] // The tokens of the Budget that has the alert,
  "threshold": integer // The threshold amount that must be met for the alert to fire,
  "user_tokens": [string] // The tokens of the users that receive the alert,
  "duration_in_days": string // The number of days from the start or end of the month to trigger the alert if the threshold is reached. For the full month, pass an empty value,
  "period_to_track": string // The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month,
  "recipient_channels": [string] // The channels receiving the alerts. Requires an integration provider to be connected
}

Responses

201: Created 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgetalerts/update-budget-alert

Budgets

GET /budgets

Get all budgets Return all Budgets.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgets/get-all-budgets

POST /budgets

Create budget Create a Budget.

Request Body

{
  "name": string // required // The name of the Budget,
  "workspace_token": string // The token of the Workspace to add the Budget to,
  "cost_report_token": string // The CostReport token. Ignored for hierarchical Budgets,
  "child_budget_tokens": [string] // The tokens of any child Budgets when creating a hierarchical Budget,
  "periods": [ // The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets
    {
      "start_at": string // required // The start date of the period,
      "end_at": string // The end date of the period,
      "amount": number // required // The amount of the period
    }
  ]
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgets/create-budget

DELETE /budgets/

Delete budget Delete a Budget.

Path Parameters

  • budget_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgets/delete-budget

GET /budgets/

Get budget by token Return a Budget.

Path Parameters

  • budget_token (path) (string) - Required

Query Parameters

  • include_performance (boolean) - Optional: Include performance data.

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgets/get-budget-by-token

PUT /budgets/

Update budget Update a Budget.

Path Parameters

  • budget_token (path) (string) - Required

Request Body

{
  "name": string // The name of the Budget,
  "cost_report_token": string // The CostReport token. Ignored for hierarchical Budgets,
  "child_budget_tokens": [string] // The tokens of any child Budgets when creating a hierarchical Budget,
  "periods": [ // The periods for the Budget. The start_at and end_at must be iso8601 formatted e.g. YYYY-MM-DD. Ignored for hierarchical Budgets
    {
      "start_at": string // required // The start date of the period,
      "end_at": string // The end date of the period,
      "amount": number // required // The amount of the period
    }
  ]
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/budgets/update-budget

BusinessMetrics

GET /business_metrics

Get all business metrics Return all BusinessMetrics that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/get-all-business-metrics

POST /business_metrics

Create business metric Create a new BusinessMetric.

Request Body

{
  "title": string // required // The title of the BusinessMetrics,
  "cost_report_tokens_with_metadata": [ // The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter
    {
      "cost_report_token": string // required // The token of the CostReport the BusinessMetric is attached to,
      "unit_scale": string // Determines the scale of the BusinessMetric's values within the CostReport. Allowed values: `per_unit`, `per_hundred`, `per_thousand`, `per_million`, `per_billion`,
      "label_filter": [string] // Include only values with these labels in the CostReport
    }
  ],
  "values": [ // The dates, amounts, and (optional) labels for the BusinessMetric
    {
      "date": string // required,
      "amount": number // required,
      "label": string
    }
  ],
  "datadog_metric_fields": { // Datadog metric configuration fields
    "integration_token": string // Integration token for the account from which you would like to fetch metrics,
    "query": string // Datadog metrics query string. e.g. sum:aws.applicationelb.request_count{region:us-east-1}.rollup(avg,daily)
  },
  "cloudwatch_fields": { // Cloudwatch configuration fields
    "integration_token": string // Integration token for the account from which you would like to fetch metrics,
    "stat": string,
    "region": string,
    "namespace": string,
    "metric_name": string,
    "label_dimension": string,
    "dimensions": [
      {
        "name": string,
        "value": string
      }
    ]
  }
}

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/create-business-metric

DELETE /business_metrics/

Delete business metric Deletes an existing BusinessMetric.

Path Parameters

  • business_metric_token (path) (string) - Required

Responses

204: No Content 403: Forbidden 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/delete-business-metric

GET /business_metrics/

Get business metric by token Return a BusinessMetric.

Path Parameters

  • business_metric_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/get-business-metric-by-token

PUT /business_metrics/

Update business metric Updates an existing BusinessMetric.

Path Parameters

  • business_metric_token (path) (string) - Required

Request Body

{
  "title": string // The title of the BusinessMetric,
  "cost_report_tokens_with_metadata": [ // The tokens for any CostReports that use the BusinessMetric, and the unit scale
    {
      "cost_report_token": string // required // The token of the CostReport the BusinessMetric is attached to,
      "unit_scale": string // Determines the scale of the BusinessMetric's values within the CostReport. Allowed values: `per_unit`, `per_hundred`, `per_thousand`, `per_million`, `per_billion`,
      "label_filter": [string] // Include only values with these labels in the CostReport
    }
  ],
  "values": [ // The dates, amounts, and (optional) labels for the BusinessMetric
    {
      "date": string // required,
      "amount": number // required,
      "label": string
    }
  ],
  "datadog_metric_fields": { // Datadog metric configuration fields
    "integration_token": string // Integration token for the account from which you would like to fetch metrics,
    "query": string // Datadog metrics query string. e.g. sum:aws.applicationelb.request_count{region:us-east-1}.rollup(avg,daily)
  },
  "cloudwatch_fields": { // Cloudwatch configuration fields
    "integration_token": string // Integration token for the account from which you would like to fetch metrics,
    "stat": string,
    "region": string,
    "namespace": string,
    "metric_name": string,
    "label_dimension": string,
    "dimensions": [
      {
        "name": string,
        "value": string
      }
    ]
  }
}

Responses

200: OK 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/update-business-metric

GET /business_metrics//values

Get business metric values Return values of a BusinessMetric

Path Parameters

  • business_metric_token (path) (string) - Required

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • start_date (string (date)) - Optional: Query BusinessMetrics by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/get-business-metric-values

PUT /business_metrics//values.csv

Update business metric values from CSV Updates the values for an existing BusinessMetric from a CSV file.

Path Parameters

  • business_metric_token (path) (string) - Required

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/businessmetrics/update-business-metric-values-from-csv

CostAlertEvents

GET /cost_alerts//events

Get all cost alert events Get all CostAlertEvents

Path Parameters

  • cost_alert_token (path) (string) - Required: The token of the CostAlertEvent.

Query Parameters

  • report_token (string) - Optional: The token of the report associated with the CostAlertEvent.
  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalertevents/get-all-cost-alert-events

GET /cost_alerts//events/

Get cost alert event by token Get a CostAlertEvent

Path Parameters

  • cost_alert_token (path) (string) - Required
  • event_token (path) (string) - Required

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalertevents/get-cost-alert-event-by-token

CostAlerts

GET /cost_alerts

Get all cost alerts List all Cost Alerts

Responses

200: List all Cost Alerts

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalerts/get-all-cost-alerts

POST /cost_alerts

Create cost alert Create a new Cost Alert

Request Body

{
  "title": string // required // The title of the Cost Alert,
  "interval": string // required // The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter',
  "threshold": number // required // The threshold value for the Cost Alert,
  "unit_type": string // required // The unit type used to compare costs. Options are 'currency' or 'percentage',
  "workspace_token": string // required // The token of the Workspace to add the Cost Alert to,
  "report_tokens": [string] // required // The tokens of the reports to alert on,
  "email_recipients": [string] // The email recipients for the Cost Alert,
  "slack_channels": [string] // The Slack channels that will receive the alert,
  "teams_channels": [string] // The Microsoft Teams channels that will receive the alert
}

Responses

201: Cost Alert created successfully. 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalerts/create-cost-alert

DELETE /cost_alerts/

Delete cost alert Delete a Cost Alert

Path Parameters

  • cost_alert_token (path) (string) - Required: The token of the Cost Alert.

Responses

204: Cost Alert deleted successfully. 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalerts/delete-cost-alert

GET /cost_alerts/

Get cost alert by token Get a Cost Alert

Path Parameters

  • cost_alert_token (path) (string) - Required: The token of the Cost Alert.

Responses

200: Get a Cost Alert 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalerts/get-cost-alert-by-token

PUT /cost_alerts/

Update cost alert Update a Cost Alert

Path Parameters

  • cost_alert_token (path) (string) - Required: The token of the Cost Alert.

Request Body

{
  "title": string // The title of the Cost Alert,
  "email_recipients": [string] // The email recipients for the Cost Alert,
  "interval": string // The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter',
  "threshold": number // The threshold value for the Cost Alert,
  "slack_channels": [string] // The Slack channels that will receive the alert. Make sure your slack integration is connected at https://console.vantage.sh/settings/slack,
  "teams_channels": [string] // The Microsoft Teams channels that will receive the alert. Make sure your teams integration is connected at https://console.vantage.sh/settings/microsoft_teams,
  "unit_type": string // The unit type used to compare costs. Options are 'currency' or 'percentage',
  "report_tokens": [string] // The tokens of the reports to alert on
}

Responses

200: Cost Alert updated successfully. 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costalerts/update-cost-alert

CostProvider

GET /cost_providers

Get cost providers List CostProviders available to query in a given Workspace.

Query Parameters

  • workspace_token (string) - Optional: The token of the Workspace to list CostProviders for. Required if the API token is associated with multiple Workspaces.

Responses

200: List of connected CostProviders.

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costprovider/get-cost-providers

CostProviderAccounts

GET /cost_provider_accounts

Get all cost provider accounts List CostProviderAccounts available in a given Workspace.

Query Parameters

  • workspace_token (string) - Optional: The token of the Workspace to list CostProviderAccounts for. Required if the API token is associated with multiple Workspaces.
  • provider (string) - Optional: Filter by provider type.
    • Allowed values: aws, azure, gcp, snowflake, databricks, mongo, datadog, fastly, new_relic, opencost, open_ai, oracle, confluent, planetscale, coralogix, kubernetes, custom_provider, github, linode, grafana, clickhouse, temporal, twilio, azure_csp, kubernetes_agent, anthropic, anyscale, cursor
  • account_id (string) - Optional: Filter by provider account identifier.
  • account_name (string) - Optional: Filter by account name (exact match).

Responses

200: List of provider accounts.

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costprovideraccounts/get-all-cost-provider-accounts

CostService

GET /cost_services

Get cost services List CostServices available to query in a given Workspace.

Query Parameters

  • workspace_token (string) - Optional: The token of the Workspace to list CostServices for. Required if the API token is associated with multiple Workspaces.

Responses

200: List of CostServices, used to query costs using VQL.

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costservice/get-cost-services

Costs

GET /cost_reports

Get all cost reports Return all CostReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • folder_token (string) - Optional: The token for the Folder you would like to fetch Reports from.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/get-all-cost-reports

POST /cost_reports

Create cost report Create a CostReport.

Request Body

{
  "title": string // required // The title of the CostReport,
  "workspace_token": string // The token of the Workspace to add the Cost Report to. Ignored if 'folder_token' is set. Required if the API token is associated with multiple Workspaces,
  "groupings": string // Grouping values for aggregating costs on the report. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, tag:tag_value. If providing multiple groupings, join as comma separated values: groupings=provider,service,region,
  "filter": string // The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql,
  "saved_filter_tokens": [string] // The tokens of the SavedFilters to apply to the CostReport,
  "business_metric_tokens_with_metadata": [ // The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale
    {
      "business_metric_token": string // required // The token of the BusinessMetric to attach to the CostReport,
      "unit_scale": string // Determines the scale of the BusinessMetric's values within the CostReport. Allowed values: `per_unit`, `per_hundred`, `per_thousand`, `per_million`, `per_billion`,
      "label_filter": [string] // Include only values with these labels in the CostReport
    }
  ],
  "folder_token": string // The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to,
  "settings": { // Report settings
    "include_credits": boolean // Report will include credits,
    "include_refunds": boolean // Report will include refunds,
    "include_discounts": boolean // Report will include discounts,
    "include_tax": boolean // Report will include tax,
    "amortize": boolean // Report will amortize,
    "unallocated": boolean // Report will show unallocated costs,
    "aggregate_by": string // Report will aggregate by cost or usage,
    "show_previous_period": boolean // Report will show previous period costs or usage comparison
  },
  "previous_period_start_date": string // The previous period start date of the CostReport. ISO 8601 Formatted,
  "previous_period_end_date": string // required // The previous period end date of the CostReport. ISO 8601 Formatted,
  "start_date": string // The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // required // The end date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the CostReport. Incompatible with 'start_date' and 'end_date' parameters. Defaults to 'this_month' if start_date and end_date are not provided. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "chart_type": string // The chart type of the CostReport. Allowed values: `area`, `line`, `pie`, `bar`, `multi_bar`,
  "date_bin": string // The date bin of the CostReport. Allowed values: `cumulative`, `day`, `week`, `month`, `quarter`,
  "chart_settings": { // Report chart settings
    "x_axis_dimension": [string] // The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date'],
    "y_axis_dimension": string // The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage'. Defaults to 'cost'
  }
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/create-cost-report

DELETE /cost_reports/

Delete cost report Delete a CostReport.

Path Parameters

  • cost_report_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/delete-cost-report

GET /cost_reports/

Get cost report by token Return a CostReport.

Path Parameters

  • cost_report_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/get-cost-report-by-token

PUT /cost_reports/

Update cost report Update a CostReport.

Path Parameters

  • cost_report_token (path) (string) - Required

Request Body

{
  "title": string // The title of the CostReport,
  "groupings": string // Grouping values for aggregating costs on the report. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, tag:tag_value. If providing multiple groupings, join as comma separated values: groupings=provider,service,region,
  "filter": string // The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql,
  "saved_filter_tokens": [string] // The tokens of the SavedFilters to apply to the CostReport,
  "business_metric_tokens_with_metadata": [ // The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale
    {
      "business_metric_token": string // required // The token of the BusinessMetric to attach to the CostReport,
      "unit_scale": string // Determines the scale of the BusinessMetric's values within the CostReport. Allowed values: `per_unit`, `per_hundred`, `per_thousand`, `per_million`, `per_billion`,
      "label_filter": [string] // Include only values with these labels in the CostReport
    }
  ],
  "folder_token": string // The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to,
  "settings": { // Report settings
    "include_credits": boolean // Report will include credits,
    "include_refunds": boolean // Report will include refunds,
    "include_discounts": boolean // Report will include discounts,
    "include_tax": boolean // Report will include tax,
    "amortize": boolean // Report will amortize,
    "unallocated": boolean // Report will show unallocated costs,
    "aggregate_by": string // Report will aggregate by cost or usage,
    "show_previous_period": boolean // Report will show previous period costs or usage comparison
  },
  "chart_settings": { // Report chart settings
    "x_axis_dimension": [string] // The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to ['date'],
    "y_axis_dimension": string // The metric or measure displayed on the chart’s y-axis. Possible values: 'cost', 'usage'. Defaults to 'cost'
  },
  "previous_period_start_date": string // The previous period start date of the CostReport. ISO 8601 Formatted,
  "previous_period_end_date": string // The previous period end date of the CostReport. ISO 8601 Formatted,
  "start_date": string // The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the CostReport. Incompatible with 'start_date' and 'end_date' parameters. Defaults to 'this_month' if start_date and end_date are not provided. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "chart_type": string // The chart type of the CostReport. Allowed values: `area`, `line`, `pie`, `bar`, `multi_bar`,
  "date_bin": string // The date bin of the CostReport. Allowed values: `cumulative`, `day`, `week`, `month`, `quarter`
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/update-cost-report

GET /cost_reports//forecasted_costs

Get forecasted costs for a cost report Return all ForecastedCosts.

Path Parameters

  • cost_report_token (path) (string) - Required

Query Parameters

  • start_date (string (date)) - Optional: First date you would like to filter forecasted costs from. ISO 8601 formatted.
  • end_date (string (date)) - Optional: Last date you would like to filter forecasted costs from. ISO 8601 formatted.
  • provider (string) - Optional: Limit the forecasted costs to a specific provider. ‘all’ is accepted to filter to overall forecast.
    • Allowed values: aws, azure, gcp, snowflake, databricks, mongo, datadog, fastly, new_relic, opencost, open_ai, oracle, confluent, planetscale, coralogix, kubernetes, custom_provider, github, linode, grafana, clickhouse, temporal, twilio, azure_csp, kubernetes_agent, anthropic, anyscale, cursor, all
  • service (string) - Optional: Limit the forecasted costs to a specific service. ‘all’ is accepted to filter to overall forecast. e.g. ‘Amazon ElastiCache’.
  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/get-forecasted-costs-for-a-cost-report

GET /costs

Get costs for cost report or VQL filter Return all Costs for a CostReport or VQL filter.

Query Parameters

  • cost_report_token (string) - Optional: The CostReport token.
  • filter (string) - Optional: The VQL filter to apply to the costs. If this is supplied you do not need cost_report_token.
  • workspace_token (string) - Optional: The token of the Workspace to query costs from. Ignored if ‘cost_report_token’ is set. Required if the API token is associated with multiple Workspaces.
  • start_date (string) - Optional: First date you would like to filter costs from. ISO 8601 formatted.
  • end_date (string) - Optional: Last date you would like to filter costs to. ISO 8601 formatted.
  • groupings (array) - Optional: Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, tag:tag_value. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
  • order (string) - Optional: Whether to order costs by date in an ascending or descending manner.
    • Allowed values: asc, desc
    • Default: desc
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 5000.
  • page (integer (int32)) - Optional: The page of results to return.
  • date_bin (string) - Optional: The date bin of the costs. Defaults to the report’s default or day.
    • Allowed values: day, week, month, quarter
  • settings[include_credits] (boolean) - Optional: Results will include credits.
    • Default: False
  • settings[include_refunds] (boolean) - Optional: Results will include refunds.
    • Default: False
  • settings[include_discounts] (boolean) - Optional: Results will include discounts.
    • Default: True
  • settings[include_tax] (boolean) - Optional: Results will include tax.
    • Default: True
  • settings[amortize] (boolean) - Optional: Results will amortize.
    • Default: True
  • settings[unallocated] (boolean) - Optional: Results will show unallocated costs.
    • Default: False
  • settings[aggregate_by] (string) - Optional: Results will aggregate by cost or usage.
    • Default: cost
  • settings[show_previous_period] (boolean) - Optional: Results will show previous period costs or usage comparison.
    • Default: True

Responses

200: OK 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/get-costs-for-cost-report-or-vql-filter

POST /costs/data_exports

Generate cost data export Generate a DataExport of costs.

Query Parameters

  • groupings (array) - Optional: Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, tag:tag_value. If providing multiple groupings, join as comma separated values: groupings=provider,service,region

Request Body

{
  "cost_report_token": string // The CostReport token,
  "filter": string // The VQL filter to apply to the costs. If this is supplied you do not need cost_report_token,
  "workspace_token": string // The token of the Workspace to query costs from. Ignored if 'cost_report_token' is set. Required if the API token is associated with multiple Workspaces,
  "start_date": string // First date you would like to filter costs from. ISO 8601 formatted,
  "end_date": string // Last date you would like to filter costs to. ISO 8601 formatted,
  "date_bin": string // The date bin of the costs. Defaults to the report's default or day. Allowed values: `day`, `week`, `month`, `quarter`,
  "schema": string // The schema of the data export. Allowed values: `vntg`, `focus`,
  "settings[include_credits]": boolean // Results will include credits,
  "settings[include_refunds]": boolean // Results will include refunds,
  "settings[include_discounts]": boolean // Results will include discounts,
  "settings[include_tax]": boolean // Results will include tax,
  "settings[amortize]": boolean // Results will amortize,
  "settings[unallocated]": boolean // Results will show unallocated costs,
  "settings[aggregate_by]": string // Results will aggregate by cost or usage,
  "settings[show_previous_period]": boolean // Results will show previous period costs or usage comparison
}

Responses

202: The data export has been queued and will be available at the location specified in the Location header. 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/costs/generate-cost-data-export

Dashboards

GET /dashboards

Get all dashboards Return all Dashboards.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dashboards/get-all-dashboards

POST /dashboards

Create dashboard Create a Dashboard.

Request Body

{
  "title": string // required // The title of the Dashboard,
  "widgets": [ // The widgets to add to the Dashboard. Currently supports CostReport, ResourceReport, KubernetesEfficiencyReport, and FinancialCommitmentReport
    {
      "widgetable_token": string // required // The token of the represented Resource,
      "title": string // The title of the Widget (defaults to the title of the Resource),
      "settings": { // The settings for the DashboardWidget
        "display_type": string // required // Allowed values: `table`, `chart`
      }
    }
  ],
  "saved_filter_tokens": [string] // The tokens of the Saved Filters used in the Dashboard,
  "date_bin": string // Determines how to group costs in the Dashboard. Allowed values: `cumulative`, `day`, `week`, `month`,
  "date_interval": string // Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "start_date": string // The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "workspace_token": string // The token of the Workspace to add the Dashboard to. Required if the API token is associated with multiple Workspaces
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dashboards/create-dashboard

DELETE /dashboards/

Delete dashboard Delete a Dashboard.

Path Parameters

  • dashboard_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dashboards/delete-dashboard

GET /dashboards/

Get dashboard by token Return a specific Dashboard.

Path Parameters

  • dashboard_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dashboards/get-dashboard-by-token

PUT /dashboards/

Update dashboard Update a Dashboard.

Path Parameters

  • dashboard_token (path) (string) - Required

Request Body

{
  "title": string // The title of the Dashboard,
  "widgets": [ // The widgets to add to the Dashboard. Currently supports CostReport, ResourceReport, KubernetesEfficiencyReport, and FinancialCommitmentReport
    {
      "widgetable_token": string // required // The token of the represented Resource,
      "title": string // The title of the Widget (defaults to the title of the Resource),
      "settings": { // The settings for the DashboardWidget
        "display_type": string // required // Allowed values: `table`, `chart`
      }
    }
  ],
  "saved_filter_tokens": [string] // The tokens of the Saved Filters used in the Dashboard,
  "date_bin": string // Determines how to group costs in the Dashboard. Allowed values: `cumulative`, `day`, `week`, `month`,
  "date_interval": string // Determines the date range in the Dashboard. Incompatible with 'start_date' and 'end_date' parameters. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`, ``,
  "start_date": string // The start date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date for the date range for costs in the Dashboard. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "workspace_token": string // The token of the Workspace the Dashboard belongs to. Required if the API token is associated with multiple Workspaces
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dashboards/update-dashboard

DataExports

GET /data_exports/

Get status of data export Get the status of a data export.

Path Parameters

  • data_export_token (path) (string) - Required

Responses

200: Returns the completed data export and its manifest. If it is still pending, the response will be a 202 and the caller should check the Location and Retry-After headers to determine where and how long to wait before polling again. 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/dataexports/get-status-of-data-export

ExchangeRates

GET /exchange_rates

Get all exchange rates Return all Exchange Rates.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/exchangerates/get-all-exchange-rates

POST /exchange_rates/csv

Upload exchange rates via CSV Upload Exchange Rates via CSV.

Responses

201: CSV uploaded successfully 400: BadRequest 403: Forbidden

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/exchangerates/upload-exchange-rates-via-csv

FinancialCommitmentReports

GET /financial_commitment_reports

Get all financial commitment reports Return all FinancialCommitmentReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitmentreports/get-all-financial-commitment-reports

POST /financial_commitment_reports

Create financial commitment report Create a FinancialCommitmentReport.

Request Body

{
  "workspace_token": string // required // The Workspace in which the FinancialCommitmentReport will be created,
  "title": string // required // The title of the FinancialCommitmentReport,
  "filter": string // The filter query language to apply to the FinancialCommitmentReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the FinancialCommitmentReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_3_months'. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "date_bucket": string // The date bucket of the FinancialCommitmentReport. Allowed values: `hour`, `day`, `week`, `month`,
  "on_demand_costs_scope": string // The scope for the costs. Possible values: discountable, all. Allowed values: `discountable`, `all`,
  "groupings": [string] // Grouping values for aggregating costs on the FinancialCommitmentReport. Valid groupings: cost_type, commitment_type, service, resource_account_id, provider_account_id, region, cost_category, cost_sub_category, instance_type, tag, tag:label_name
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitmentreports/create-financial-commitment-report

DELETE /financial_commitment_reports/

Delete financial commitment report Delete a FinancialCommitmentReport.

Path Parameters

  • financial_commitment_report_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitmentreports/delete-financial-commitment-report

GET /financial_commitment_reports/

Get financial commitment report by token Return a FinancialCommitmentReport.

Path Parameters

  • financial_commitment_report_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitmentreports/get-financial-commitment-report-by-token

PUT /financial_commitment_reports/

Update financial commitment report Update a FinancialCommitmentReport.

Path Parameters

  • financial_commitment_report_token (path) (string) - Required

Request Body

{
  "title": string // The title of the FinancialCommitmentReport,
  "filter": string // The filter query language to apply to the FinancialCommitmentReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the FinancialCommitmentReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_3_months'. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "date_bucket": string // The date bucket of the FinancialCommitmentReport. Allowed values: `hour`, `day`, `week`, `month`,
  "on_demand_costs_scope": string // The scope for the costs. Possible values: discountable, all. Allowed values: `discountable`, `all`,
  "groupings": [string] // Grouping values for aggregating costs on the FinancialCommitmentReport. Valid groupings: cost_type, commitment_type, service, resource_account_id, provider_account_id, region, cost_category, cost_sub_category, instance_type, tag, tag:label_name
}

Responses

200: OK 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitmentreports/update-financial-commitment-report

FinancialCommitments

GET /financial_commitments

Get all financial commitments Return all FinancialCommitments.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/financialcommitments/get-all-financial-commitments

Folders

GET /folders

Get all folders Return all Folders for CostReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/folders/get-all-folders

POST /folders

Create folder Create a Folder for CostReports.

Request Body

{
  "title": string // required // The title of the Folder,
  "parent_folder_token": string // The token of the parent Folder,
  "saved_filter_tokens": [string] // The tokens of the SavedFilters to apply to any Cost Report contained within the Folder,
  "workspace_token": string // The token of the Workspace to add the Folder to. Ignored if 'parent_folder_token' is set. Required if the API token is associated with multiple Workspaces
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/folders/create-folder

DELETE /folders/

Delete folder Delete a Folder for CostReports.

Path Parameters

  • folder_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/folders/delete-folder

GET /folders/

Get folder by token Return a specific Folder for CostReports.

Path Parameters

  • folder_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/folders/get-folder-by-token

PUT /folders/

Update folder Update a Folder for CostReports.

Path Parameters

  • folder_token (path) (string) - Required

Request Body

{
  "title": string // The title of the Folder,
  "parent_folder_token": string // The token of the parent Folder,
  "saved_filter_tokens": [string] // The tokens of the SavedFilters to apply to any Cost Report contained within the Folder
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/folders/update-folder

Integrations

GET /integrations

Get all integrations Return all Integrations.

Query Parameters

  • provider (string) - Optional: Query by provider name to list all Integrations for a specific provider.
    • Allowed values: aws, azure, gcp, snowflake, databricks, mongo, datadog, fastly, new_relic, opencost, open_ai, oracle, confluent, planetscale, coralogix, kubernetes, custom_provider, github, linode, grafana, clickhouse, temporal, twilio, azure_csp, kubernetes_agent, anthropic, anyscale, cursor
  • account_identifier (string) - Optional: Query by account identifier to list all Integrations that match a specific account. For Azure, this is the subscription ID. Must include provider when using this parameter.
  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/get-all-integrations

POST /integrations/azure

Create Azure integration Create an Azure Integration

Request Body

{
  "tenant": string // required // Azure AD Tenant ID,
  "app_id": string // required // Service Principal Application ID,
  "password": string // required // Service Principal Password
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/create-azure-integration

POST /integrations/custom_provider

Create custom provider integration Create a Custom Provider Integration

Request Body

{
  "name": string // required // Name of the Custom Provider Integration,
  "description": string // Description of the Custom Provider Integration
}

Responses

201: Created 400: BadRequest 403: Forbidden

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/create-custom-provider-integration

POST /integrations/gcp

Create GCP integration Create a GCP Integration

Request Body

{
  "billing_account_id": string // required // GCP billing account ID,
  "project_id": string // required // GCP project ID,
  "dataset_name": string // required // BigQuery dataset name
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/create-gcp-integration

DELETE /integrations/

Delete integration Delete an Integration.

Path Parameters

  • integration_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/delete-integration

GET /integrations/

Get integration by token Return an Integration.

Path Parameters

  • integration_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/get-integration-by-token

PUT /integrations/

Update integration Update an Integration.

Path Parameters

  • integration_token (path) (string) - Required

Request Body

[
  string
]

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/update-integration

GET /integrations//costs

Get all user costs uploads List UserCostUploads.

Path Parameters

  • integration_token (path) (string) - Required

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/get-all-user-costs-uploads

POST /integrations//costs.csv

Upload custom provider costs Create UserCostsUpload via CSV for a Custom Provider Integration.

Path Parameters

  • integration_token (path) (string) - Required

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/upload-custom-provider-costs

DELETE /integrations//costs/

Delete user costs upload Delete a UserCostsUpload.

Path Parameters

  • integration_token (path) (string) - Required
  • user_costs_upload_token (path) (integer (int32)) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/integrations/delete-user-costs-upload

Invoices

GET /invoices

Get all invoices Returns a list of invoices (MSP invoicing required).

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • managed_account_token (string) - Optional: Filter invoices by managed account token (MSP accounts only)

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/get-all-invoices

POST /invoices

Create invoice Create an invoice (MSP accounts only).

Request Body

{
  "billing_period_start": string // required // Start date of billing period (YYYY-MM-DD),
  "billing_period_end": string // required // End date of billing period (YYYY-MM-DD),
  "account_token": string // required // Token of the managed account to invoice
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/create-invoice

GET /invoices/

Get invoice by token Return an invoice.

Path Parameters

  • invoice_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/get-invoice-by-token

GET /invoices//cost_report

Get cost report URL Get cost report URL for invoice period.

Path Parameters

  • invoice_token (path) (string) - Required

Responses

200: Returns cost report URL for the invoice period 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/get-cost-report-url

POST /invoices//download

Get invoice file Download invoice file (PDF or CSV).

Path Parameters

  • invoice_token (path) (string) - Required

Request Body

{
  "file_type": string // required // Type of file to download (pdf or csv). Allowed values: `pdf`, `csv`
}

Responses

200: Returns download URL for the invoice file 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/get-invoice-file

POST /invoices//regenerate

Regenerate invoice Regenerate an existing invoice (MSP accounts only).

Path Parameters

  • invoice_token (path) (string) - Required

Responses

200: Invoice regeneration started 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/regenerate-invoice

POST /invoices//send

Send invoice Send invoice via email.

Path Parameters

  • invoice_token (path) (string) - Required

Responses

200: Invoice sent successfully 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/send-invoice

POST /invoices//send_and_approve

Send and approve invoice Send and approve invoice via email (MSP accounts only).

Path Parameters

  • invoice_token (path) (string) - Required

Responses

200: Invoice approved and sent successfully 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/invoices/send-and-approve-invoice

KubernetesEfficiencyReports

GET /kubernetes_efficiency_reports

Get all Kubernetes efficiency reports Return all KubernetesEfficiencyReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/get-all-kubernetes-efficiency-reports

POST /kubernetes_efficiency_reports

Create Kubernetes efficiency report Create a KubernetesEfficiencyReport.

Request Body

{
  "workspace_token": string // required // The Workspace in which the KubernetesEfficiencyReport will be created,
  "title": string // required // The title of the KubernetesEfficiencyReport,
  "filter": string // The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the KubernetesEfficiencyReport. Incompatible with 'start_date' and 'end_date' parameters. Defaults to 'this_month' if start_date and end_date are not provided. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "aggregated_by": string // The column by which the costs are aggregated. Allowed values: `idle_cost`, `amount`, `cost_efficiency`,
  "date_bucket": string // The date bucket of the KubernetesEfficiencyReport. Allowed values: `day`, `week`, `month`,
  "groupings": [string] // Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: cluster_id, namespace, labeled, category, pod, label, label:label_name
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/create-kubernetes-efficiency-report

POST /kubernetes_efficiency_reports/data_exports

Generate Kubernetes efficiency data export Generate a DataExport of Kubernetes efficiency data.

Query Parameters

  • groupings (array) - Optional: Group the results by specific field(s). Valid groupings: cluster_id, namespace, labeled, category, pod, label, label:label_name.

Request Body

{
  "kubernetes_efficiency_report_token": string // The KubernetesEfficiencyReport token. If not provided, the default report for the workspace will be used,
  "filter": string // The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql,
  "workspace_token": string // The token of the Workspace to export data from. Ignored if 'kubernetes_efficiency_report_token' is set. Required if the API token is associated with multiple Workspaces,
  "start_date": string // First date you would like to filter data from. ISO 8601 formatted,
  "end_date": string // Last date you would like to filter data to. ISO 8601 formatted,
  "date_bin": string // The date bin of the data. Defaults to the report's default or day. Allowed values: `day`, `week`, `month`
}

Responses

202: The data export has been queued and will be available at the location specified in the Location header. 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/generate-kubernetes-efficiency-data-export

DELETE /kubernetes_efficiency_reports/

Delete Kubernetes efficiency report Delete a KubernetesEfficiencyReport.

Path Parameters

  • kubernetes_efficiency_report_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/delete-kubernetes-efficiency-report

GET /kubernetes_efficiency_reports/

Get Kubernetes efficiency report by token Return a KubernetesEfficiencyReport.

Path Parameters

  • kubernetes_efficiency_report_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/get-kubernetes-efficiency-report-by-token

PUT /kubernetes_efficiency_reports/

Update Kubernetes efficiency report Update a KubernetesEfficiencyReport.

Path Parameters

  • kubernetes_efficiency_report_token (path) (string) - Required

Request Body

{
  "title": string // The title of the KubernetesEfficiencyReport,
  "filter": string // The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the KubernetesEfficiencyReport. Incompatible with 'start_date' and 'end_date' parameters. Defaults to 'this_month' if start_date and end_date are not provided. Allowed values: `this_month`, `last_7_days`, `last_30_days`, `last_month`, `last_3_months`, `last_6_months`, `custom`, `last_12_months`, `last_24_months`, `last_36_months`, `next_month`, `next_3_months`, `next_6_months`, `next_12_months`, `year_to_date`, `last_3_days`, `last_14_days`,
  "aggregated_by": string // The column by which the costs are aggregated. Allowed values: `idle_cost`, `amount`, `cost_efficiency`,
  "date_bucket": string // The date bucket of the KubernetesEfficiencyReport. Allowed values: `day`, `week`, `month`,
  "groupings": [string] // Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: cluster_id, namespace, labeled, category, pod, label, label:label_name
}

Responses

200: OK 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/kubernetesefficiencyreports/update-kubernetes-efficiency-report

ManagedAccounts

GET /managed_accounts

Get all managed accounts Returns a list of managed accounts.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/managedaccounts/get-all-managed-accounts

POST /managed_accounts

Create managed account Create a Managed Account.

Request Body

{
  "name": string // required // The name of the Managed Account,
  "contact_email": string // required // The contact email address for the Managed Account,
  "access_credential_tokens": [string] // Access Credential (aka Integrations) tokens to assign to the Managed Account,
  "billing_rule_tokens": [string] // Billing Rule tokens to assign to the Managed Account
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/managedaccounts/create-managed-account

DELETE /managed_accounts/

Delete managed account Delete a Managed Account.

Path Parameters

  • managed_account_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/managedaccounts/delete-managed-account

GET /managed_accounts/

Get managed account by token Return a Managed Account.

Path Parameters

  • managed_account_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/managedaccounts/get-managed-account-by-token

PUT /managed_accounts/

Update managed account Update a Managed Account.

Path Parameters

  • managed_account_token (path) (string) - Required

Request Body

{
  "name": string // The name of the Managed Account,
  "contact_email": string // The contact email address for the Managed Account,
  "access_credential_tokens": [string] // Access Credential (aka Integrations) tokens to assign to the Managed Account,
  "billing_rule_tokens": [string] // Billing Rule tokens to assign to the Managed Account,
  "msp_billing_profile_token": string // Token of the MSP billing profile to use for this managed account (MSP invoicing accounts only),
  "billing_information_attributes": { // Billing address and contact information (MSP invoicing accounts only)
    "id": integer,
    "token": string,
    "company_name": string // Company name for billing,
    "country_code": string // ISO country code,
    "address_line_1": string // First line of billing address,
    "address_line_2": string // Second line of billing address,
    "city": string // City for billing address,
    "state": string // State or province for billing address,
    "postal_code": string // Postal or ZIP code,
    "billing_email": [string] // Array of billing email addresses
  },
  "business_information_attributes": { // Business information and custom fields (MSP invoicing accounts only)
    "id": integer,
    "token": string,
    "metadata": { // Business metadata including custom fields
      "custom_fields": [ // Array of custom field objects
        {
          "name": string // Custom field name,
          "value": string // Custom field value
        }
      ]
    }
  }
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/managedaccounts/update-managed-account

Me

GET /me

Get authenticated user info Get information about the authenticated BearerToken.

Responses

200: General information about the user.

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/me/get-authenticated-user-info

NetworkFlowReports

GET /network_flow_reports

Get all network flow reports Return all NetworkFlowReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/networkflowreports/get-all-network-flow-reports

POST /network_flow_reports

Create network flow report Create a NetworkFlowReport.

Request Body

{
  "workspace_token": string // required // The Workspace in which the NetworkFlowReport will be created,
  "title": string // required // The title of the NetworkFlowReport,
  "filter": string // The filter query language to apply to the NetworkFlowReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the NetworkFlowReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the NetworkFlowReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the NetworkFlowReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_7_days'. Allowed values: `last_3_days`, `last_7_days`, `custom`,
  "groupings": [string] // Grouping values for aggregating data on the NetworkFlowReport. Valid groupings: account_id, az_id, dstaddr, dsthostname, flow_direction, interface_id, instance_id, peer_resource_uuid, peer_account_id, peer_vpc_id, peer_region, peer_az_id, peer_subnet_id, peer_interface_id, peer_instance_id, region, resource_uuid, srcaddr, srchostname, subnet_id, traffic_category, traffic_path, vpc_id,
  "flow_direction": string // The flow direction of the NetworkFlowReport. Allowed values: `ingress`, `egress`,
  "flow_weight": string // The dimension by which the logs in the report are sorted. Defaults to costs. Allowed values: `costs`, `bytes`
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/networkflowreports/create-network-flow-report

DELETE /network_flow_reports/

Delete network flow report Delete a NetworkFlowReport.

Path Parameters

  • network_flow_report_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/networkflowreports/delete-network-flow-report

GET /network_flow_reports/

Get network flow report by token Return a NetworkFlowReport.

Path Parameters

  • network_flow_report_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/networkflowreports/get-network-flow-report-by-token

PUT /network_flow_reports/

Update network flow report Update a NetworkFlowReport.

Path Parameters

  • network_flow_report_token (path) (string) - Required

Request Body

{
  "title": string // The title of the NetworkFlowReport,
  "filter": string // The filter query language to apply to the NetworkFlowReport. Additional documentation available at https://docs.vantage.sh/vql,
  "start_date": string // The start date of the NetworkFlowReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "end_date": string // The end date of the NetworkFlowReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter,
  "date_interval": string // The date interval of the NetworkFlowReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_7_days'. Allowed values: `last_3_days`, `last_7_days`, `custom`,
  "groupings": [string] // Grouping values for aggregating data on the NetworkFlowReport. Valid groupings: account_id, az_id, dstaddr, dsthostname, flow_direction, interface_id, instance_id, peer_resource_uuid, peer_account_id, peer_vpc_id, peer_region, peer_az_id, peer_subnet_id, peer_interface_id, peer_instance_id, region, resource_uuid, srcaddr, srchostname, subnet_id, traffic_category, traffic_path, vpc_id,
  "flow_direction": string // The flow direction of the NetworkFlowReport. Allowed values: `ingress`, `egress`,
  "flow_weight": string // The dimension by which the logs in the report are sorted. Defaults to costs. Allowed values: `costs`, `bytes`
}

Responses

200: OK 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/networkflowreports/update-network-flow-report

Ping

GET /ping

This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly.

Responses

200: This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly.

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/ping/

Prices

GET /products

Get all products Return available Products for a Service. For example, with a Provider of AWS and a Service of EC2, Products will be a list of all EC2 Instances. By default, this endpoint returns all Products across all Services and Providers but has optional query parameters for filtering listed below.

Query Parameters

  • provider_id (string) - Optional: Query by Provider to list all Products across all Services for a Provider. e.g. aws
  • service_id (string) - Optional: Query by Service to list all Products for a specific provider service. e.g. aws-ec2
  • name (string) - Optional: Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/prices/get-all-products

GET /products/

Get product by ID Return a product

Path Parameters

  • id (path) (string) - Required

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/prices/get-product-by-id

GET /products//prices

Get prices for a product Return available Prices across all Regions for a Product.

Path Parameters

  • product_id (path) (string) - Required

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/prices/get-prices-for-a-product

GET /products//prices/

Get price by ID Returns a price

Path Parameters

  • product_id (path) (string) - Required
  • id (path) (string) - Required

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/prices/get-price-by-id

Recommendations

GET /recommendations

Get all recommendations Return all Recommendations.

Query Parameters

  • workspace_token (string) - Optional: Filter by workspace.
  • provider_account_id (string) - Optional: Filter by provider account id (AWS account, Azure subscription id, etc).
  • category (string) - Optional: Filter by category.
    • Allowed values: ebs_gp2_to_gp3, ebs_unattached_volume, elasticache_reserved_instances, elastic_search_reserved_instances, rds_reserved_instances, redshift_reserved_instances, ec2_generational_upgrades, rds_generational_upgrades, es_generational_upgrades, cw_log_retention_policy, workspace_unused, workspace_stranded, cloudfront_cloudflare, s3_cloudflare, ip_unattached, s3_bucket_intelligent_tiering, s3_bucket_glacier_instant_retrieval, savings_plan, unused_financial_commitments, datadog_financial_commitments, az_compute_reserved_instances, az_compute_reserved_instances_cosmos, az_compute_reserved_instances_sql, az_compute_reserved_instances_app_service, az_disks_unattached, dynamodb_reserved_capacity_recommender, kubernetes_recommender, gcp_compute_rightsizing_recommender, gcp_compute_commitment_recommender, ec2_snapshot_recommender, ec2_rightsizing_recommender, ebs_compute_optimizer_recommender, lambda_compute_optimizer_recommender, ecs_compute_optimizer_recommender, idle_compute_optimizer_recommender, rds_compute_optimizer_recommender, ec2_compute_optimizer_recommender, azure_rightsizing_recommender, azure_compute_savings_recommender, azure_blob_storage_reserved_instances_recommender, azure_sql_paas_db_reserved_instances_recommender, azure_files_reserved_instances_recommender, eks_in_extended_support_window, eks_approaching_extended_support_window, rds_in_extended_support_window, rds_approaching_extended_support_window, datadog_metrics_unqueried
  • provider (string) - Optional: Filter by provider.
  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/recommendations/get-all-recommendations

GET /recommendations/

Get recommendation by token Return a Recommendation.

Path Parameters

  • recommendation_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/recommendations/get-recommendation-by-token

GET /recommendations//resources

Get all resources for a recommendation Return all Active Resources, including Recommendation Actions, referenced in this Recommendation.

Path Parameters

  • recommendation_token (path) (string) - Required

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/recommendations/get-all-resources-for-a-recommendation

GET /recommendations//resources/

Get specific resource for a recommendation Return an Active Resource, including Recommendation Actions, referenced in this Recommendation.

Path Parameters

  • recommendation_token (path) (string) - Required
  • resource_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/recommendations/get-specific-resource-for-a-recommendation

ReportNotifications

GET /report_notifications

Get all report notifications Return all ReportNotifications.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/reportnotifications/get-all-report-notifications

POST /report_notifications

Create report notification Create a ReportNotification.

Request Body

{
  "title": string // required // The title of the ReportNotification,
  "cost_report_token": string // required // The CostReport token,
  "workspace_token": string // The token of the Workspace to add the ReportNotification to. Required if the API token is associated with multiple Workspaces,
  "user_tokens": [string] // The Users that receive the notification,
  "recipient_channels": [string] // The Slack or Microsoft Teams channels that receive the notification,
  "frequency": string // required // The frequency the ReportNotification is sent. Possible values: daily, weekly, monthly,
  "change": string // required // The type of change the ReportNotification is tracking. Possible values: percentage, dollars
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/reportnotifications/create-report-notification

DELETE /report_notifications/

Delete report notification Delete a ReportNotification.

Path Parameters

  • report_notification_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/reportnotifications/delete-report-notification

GET /report_notifications/

Get report notification by token Return a ReportNotification.

Path Parameters

  • report_notification_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/reportnotifications/get-report-notification-by-token

PUT /report_notifications/

Update report notification Update a ReportNotification.

Path Parameters

  • report_notification_token (path) (string) - Required

Request Body

{
  "title": string // The title of the ReportNotification,
  "cost_report_token": string // The CostReport token,
  "user_tokens": [string] // The Users that receive the notification,
  "recipient_channels": [string] // The Slack or Microsoft Teams channels that receive the notification,
  "frequency": string // The frequency the ReportNotification is sent. Possible values: daily, weekly, monthly,
  "change": string // The type of change the ReportNotification is tracking. Possible values: percentage, dollars
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/reportnotifications/update-report-notification

ResourceReports

GET /resource_reports

Get all resource reports Return all ResourceReports.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The number of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/get-all-resource-reports

POST /resource_reports

Create resource report Create a ResourceReport.

Request Body

{
  "workspace_token": string // required // The token of the Workspace to add the ResourceReport to,
  "title": string // The title of the ResourceReport,
  "filter": string // The filter query language to apply to the ResourceReport. Additional documentation available at https://docs.vantage.sh/vql,
  "columns": [string] // Array of column names to display in the table. Column names should match those returned by the /resource_reports/columns endpoint. The order determines the display order. Only available for reports with a single resource type filter
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/create-resource-report

GET /resource_reports/columns

Get resource report columns List available columns for a resource type.

Query Parameters

Responses

200: Returns array of available column names for the specified resource type 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/get-resource-report-columns

DELETE /resource_reports/

Delete resource report Delete a ResourceReport.

Path Parameters

  • resource_report_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/delete-resource-report

GET /resource_reports/

Get resource report by token Return a ResourceReport.

Path Parameters

  • resource_report_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/get-resource-report-by-token

PUT /resource_reports/

Update resource report Update a ResourceReport.

Path Parameters

  • resource_report_token (path) (string) - Required

Request Body

{
  "title": string // The title of the ResourceReport,
  "filter": string // The filter query language to apply to the ResourceReport. Additional documentation available at https://docs.vantage.sh/vql,
  "columns": [string] // Array of column names to display in the table. Column names should match those returned by the /resource_reports/columns endpoint. The order determines the display order. Only available for reports with a single resource type filter
}

Responses

200: OK 400: BadRequest 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resourcereports/update-resource-report

Resources

GET /resources

Get resources Return Resources contained in a ResourceReport

Query Parameters

  • resource_report_token (string) - Optional: The ResourceReport token.
  • filter (string) - Optional: The filter query language to apply to the Resources. Additional documentation available at https://docs.vantage.sh/vql.
  • workspace_token (string) - Optional: The Workspace in which the Resources are located.
  • include_cost (boolean) - Optional: Include cost information in the response.

Responses

200: OK 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resources/get-resources

GET /resources/

Get resource by token Return a single Resource

Path Parameters

  • resource_token (path) (string) - Required

Query Parameters

  • include_cost (boolean) - Optional: Include cost information in the response.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/resources/get-resource-by-token

SavedFilters

GET /saved_filters

Get all saved filters Return all SavedFilters that can be applied to a CostReport.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/savedfilters/get-all-saved-filters

POST /saved_filters

Create saved filter Create a SavedFilter for CostReports.

Request Body

{
  "title": string // required // The title of the SavedFilter,
  "workspace_token": string // The Workspace to associate the SavedFilter with. Required if the API token is associated with multiple Workspaces,
  "filter": string // The filter query language to apply to the SavedFilter, which subsequently gets applied to a CostReport. Additional documentation available at https://docs.vantage.sh/vql
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/savedfilters/create-saved-filter

DELETE /saved_filters/

Delete saved filter Delete a SavedFilter for CostReports.

Path Parameters

  • saved_filter_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/savedfilters/delete-saved-filter

GET /saved_filters/

Get saved filter by token Return a specific SavedFilter.

Path Parameters

  • saved_filter_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/savedfilters/get-saved-filter-by-token

PUT /saved_filters/

Update saved filter Update a SavedFilter for CostReports.

Path Parameters

  • saved_filter_token (path) (string) - Required

Request Body

{
  "title": string // The title of the SavedFilter,
  "filter": string // The filter query language to apply to the SavedFilter, which subsequently gets applied to a CostReport. Additional documentation available at https://docs.vantage.sh/vql
}

Responses

200: OK 400: BadRequest 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/savedfilters/update-saved-filter

Segments

GET /segments

Get all segments Return all Segments.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/segments/get-all-segments

POST /segments

Create segment Create a Segment.

Request Body

{
  "title": string // required // The title of the Segment,
  "description": string // The description of the Segment,
  "priority": integer // The priority of the Segment,
  "track_unallocated": boolean // Track Unallocated Costs which are not assigned to any of the created Segments,
  "report_settings": { // Report settings configurable on top-level Segments
    "include_credits": boolean // Reports created under this Segment will include credits,
    "include_refunds": boolean // Reports created under this Segment will include refunds,
    "include_discounts": boolean // Reports created under this Segment will include discounts,
    "include_tax": boolean // Reports created under this Segment will include tax,
    "amortize": boolean // Reports created under this Segment will amortize
  },
  "workspace_token": string // The token of the Workspace to add the Segment to. Ignored if 'segment_token' is set. Required if the API token is associated with multiple Workspaces,
  "filter": string // The filter query language to apply to the Segment. Additional documentation available at https://docs.vantage.sh/vql,
  "parent_segment_token": string // The token of the parent Segment this new Segment belongs to. Determines the Workspace the segment is assigned to
}

Responses

201: Created 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/segments/create-segment

DELETE /segments/

Delete segment Delete a Segment.

Path Parameters

  • segment_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/segments/delete-segment

GET /segments/

Get segment by token Return a Segment.

Path Parameters

  • segment_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/segments/get-segment-by-token

PUT /segments/

Update segment Update a Segment.

Path Parameters

  • segment_token (path) (string) - Required

Request Body

{
  "title": string // The title of the Segment,
  "description": string // The description of the Segment,
  "priority": integer // The priority of the Segment,
  "track_unallocated": boolean // Track Unallocated Costs which are not assigned to any of the created Segments,
  "report_settings": { // Report settings configurable on top-level Segments
    "include_credits": boolean // Reports created under this Segment will include credits,
    "include_refunds": boolean // Reports created under this Segment will include refunds,
    "include_discounts": boolean // Reports created under this Segment will include discounts,
    "include_tax": boolean // Reports created under this Segment will include tax,
    "amortize": boolean // Reports created under this Segment will amortize
  },
  "filter": string // The filter query language to apply to the Segment. Additional documentation available at https://docs.vantage.sh/vql,
  "parent_segment_token": string // The token of the parent Segment this new Segment belongs to. Determines the Workspace the segment is assigned to
}

Responses

200: OK 400: BadRequest 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/segments/update-segment

Tags

GET /tags

Get all tags Return all Tags that the current API token has access to.

Query Parameters

  • providers (array) - Optional: An array of providers to scope Tags by.
  • search_query (string) - Optional: A search query to filter Tags by tag key.
  • sort_direction (string) - Optional: The direction in which you would like to sort the data by. Defaults to ‘asc’.
    • Allowed values: asc, desc
  • page (integer (int32)) - Optional: The page of results to return.
    • Default: 1
  • limit (integer (int32)) - Optional: The number of results to return per page. Defaults to 100. The maximum is 1000.
    • Default: 100

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/tags/get-all-tags

PUT /tags

Update tag Updates an existing Tag.

Request Body

{
  "tag_key": string,
  "tag_keys": [string],
  "hidden": boolean // required // Whether the Tag is hidden from the Vantage UI
}

Responses

200: OK 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/tags/update-tag

GET /tags//values

Get tag values Returns corresponding TagValues for a given Tag.

Path Parameters

  • key (path) (string) - Required: The key of the Tag for which you would like to retrieve TagValues.

Query Parameters

  • providers (array) - Optional: An array of providers to scope TagValues by.
  • sort_direction (string) - Optional: The direction in which to sort the TagValues. Defaults to ‘asc’.
    • Allowed values: asc, desc
    • Default: asc
  • search_query (string) - Optional: A search query to filter TagValues by the value name.
  • page (integer (int32)) - Optional: The page of results to return.
    • Default: 1
  • limit (integer (int32)) - Optional: The number of results to return per page. Defaults to 100. The maximum is 1000.
    • Default: 100

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/tags/get-tag-values

Teams

GET /teams

Get all teams Return all Teams that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/teams/get-all-teams

POST /teams

Create team Create a new Team.

Request Body

{
  "name": string // required // The name of the Team,
  "description": string // The description of the Team,
  "workspace_tokens": [string] // The Workspace tokens to associate to the Team,
  "user_tokens": [string] // The User tokens to associate to the Team,
  "user_emails": [string] // The User emails to associate to the Team,
  "role": string // The role to assign to the provided Users. Defaults to 'editor' which has editor permissions. Allowed values: `owner`, `editor`, `viewer`
}

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/teams/create-team

DELETE /teams/

Delete team Delete a Team.

Path Parameters

  • team_token (path) (string) - Required

Responses

204: No Content 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/teams/delete-team

GET /teams/

Get team by token Return a specific Team.

Path Parameters

  • team_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/teams/get-team-by-token

PUT /teams/

Update team Update a Team.

Path Parameters

  • team_token (path) (string) - Required

Request Body

{
  "name": string // The name of the Team,
  "description": string // The description of the Team,
  "workspace_tokens": [string] // The Workspace tokens to associate to the Team,
  "user_tokens": [string] // The User tokens to associate to the Team,
  "user_emails": [string] // The User emails to associate to the Team,
  "role": string // The role to assign to the provided Users. Defaults to 'editor' which has editor permissions. Allowed values: `owner`, `editor`, `viewer`
}

Responses

200: OK 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/teams/update-team

UnitCosts

GET /unit_costs

Get all unit costs for a cost report Return all UnitCosts for a CostReport.

Query Parameters

  • cost_report_token (string) - Required: The CostReport token.
  • start_date (string) - Optional: First date you would like to filter unit costs from. Defaults to the report’s default. ISO 8601 formatted.
  • end_date (string) - Optional: Last date you would like to filter unit costs to. Defaults to the report’s default. ISO 8601 formatted.
  • date_bin (string) - Optional: The date bin of the unit costs. Defaults to the report’s default or day.
    • Allowed values: day, week, month, quarter
  • order (string) - Optional: Whether to order unit costs by date in an ascending or descending manner.
    • Allowed values: asc, desc
    • Default: desc
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.
  • page (integer (int32)) - Optional: The page of results to return.

Responses

200: OK 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/unitcosts/get-all-unit-costs-for-a-cost-report

POST /unit_costs/data_exports

Generate data export of unit costs Generate a DataExport of unit costs.

Request Body

{
  "cost_report_token": string // required // The CostReport token,
  "workspace_token": string // The token of the Workspace to query costs from. Required if the API token is associated with multiple Workspaces,
  "start_date": string // First date you would like to filter unit costs from. Defaults to the report's default. ISO 8601 formatted,
  "end_date": string // Last date you would like to filter unit costs to. Defaults to the report's default. ISO 8601 formatted,
  "date_bin": string // The date bin of the unit costs. Defaults to the report's default or day. Allowed values: `day`, `week`, `month`, `quarter`
}

Responses

202: The data export has been queued and will be available at the location specified in the Location header. 400: BadRequest 402: PaymentRequired 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/unitcosts/generate-data-export-of-unit-costs

UserFeedback

POST /user_feedback

Submit user feedback Provide UserFeedback for our product and features.

Request Body

{
  "message": string // required // UserFeedback message
}

Responses

201: Provide UserFeedback for our product and features. 400: BadRequest 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/userfeedback/submit-user-feedback

Users

GET /users

Get all users Return all Users that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK 403: Forbidden

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/users/get-all-users

GET /users/

Get user by token Return a specific User.

Path Parameters

  • user_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/users/get-user-by-token

VirtualTags

GET /virtual_tag_configs

Get all virtual tag configs Return all VirtualTagConfigs that the current API token has access to.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/virtualtags/get-all-virtual-tag-configs

POST /virtual_tag_configs

Create virtual tag config Create a new VirtualTagConfig.

Request Body

{
  "key": string // required // The key of the VirtualTagConfig,
  "overridable": boolean // required // Whether the VirtualTagConfig can override a provider-supplied tag on a matching Cost,
  "backfill_until": string // The earliest month the VirtualTagConfig should be backfilled to,
  "collapsed_tag_keys": [ // Tag keys to collapse values for
    {
      "key": string // required // The tag key to collapse values for,
      "providers": [string] // The providers this collapsed tag key applies to. Defaults to all providers
    }
  ],
  "values": [ // Values for the VirtualTagConfig, with match precedence determined by order in the list
    {
      "filter": string // required // The filter query language to apply to the value. Additional documentation available at https://docs.vantage.sh/vql,
      "name": string // The name of the value,
      "business_metric_token": string // The token of an associated business metric,
      "cost_metric": {
        "filter": string // required,
        "aggregation": { // required
          "tag": string // required
        }
      },
      "percentages": [
        {
          "value": string // required,
          "pct": number // required
        }
      ]
    }
  ]
}

Responses

201: Created 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/virtualtags/create-virtual-tag-config

DELETE /virtual_tag_configs/

Delete virtual tag config Deletes an existing VirtualTagConfig.

Path Parameters

  • token (path) (string) - Required

Responses

204: No Content 403: Forbidden 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/virtualtags/delete-virtual-tag-config

GET /virtual_tag_configs/

Get virtual tag config by token Return a specific VirtualTagConfig.

Path Parameters

  • token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/virtualtags/get-virtual-tag-config-by-token

PUT /virtual_tag_configs/

Update virtual tag config Updates an existing VirtualTagConfig.

Path Parameters

  • token (path) (string) - Required

Request Body

{
  "key": string // The key of the VirtualTagConfig,
  "overridable": boolean // Whether the VirtualTagConfig can override a provider-supplied tag on a matching Cost,
  "backfill_until": string // The earliest month the VirtualTagConfig should be backfilled to,
  "collapsed_tag_keys": [ // Tag keys to collapse values for
    {
      "key": string // required // The tag key to collapse values for,
      "providers": [string] // The providers this collapsed tag key applies to. Defaults to all providers
    }
  ],
  "values": [ // Values for the VirtualTagConfig, with match precedence determined by order in the list
    {
      "filter": string // required // The filter query language to apply to the value. Additional documentation available at https://docs.vantage.sh/vql,
      "name": string // The name of the value,
      "business_metric_token": string // The token of an associated business metric,
      "cost_metric": {
        "filter": string // required,
        "aggregation": { // required
          "tag": string // required
        }
      },
      "percentages": [
        {
          "value": string // required,
          "pct": number // required
        }
      ]
    }
  ]
}

Responses

200: OK 400: BadRequest 403: Forbidden 404: NotFound 422: UnprocessableEntity

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/virtualtags/update-virtual-tag-config

Workspaces

GET /workspaces

Get all workspaces Return all Workspaces that the current API token has access to.

Query Parameters

  • page (integer (int32)) - Optional: The page of results to return.
  • limit (integer (int32)) - Optional: The amount of results to return. The maximum is 1000.

Responses

200: OK

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/workspaces/get-all-workspaces

POST /workspaces

Create workspace Create a workspace

Request Body

{
  "name": string // required // Name of the workspace,
  "enable_currency_conversion": boolean // Enable currency conversion for the workspace,
  "currency": string // Currency code for the workspace,
  "exchange_rate_date": string // The date to use for currency conversion. Allowed values: `daily_rate`, `end_of_billing_period_rate`
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/workspaces/create-workspace

DELETE /workspaces/

Delete workspace Delete a Workspace

Path Parameters

  • workspace_token (path) (string) - Required

Responses

204: No Content 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/workspaces/delete-workspace

GET /workspaces/

Get workspace by token Return a specific Workspace.

Path Parameters

  • workspace_token (path) (string) - Required

Responses

200: OK 404: NotFound

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/workspaces/get-workspace-by-token

PUT /workspaces/

Update workspace Update a workspace

Path Parameters

  • workspace_token (path) (string) - Required

Request Body

{
  "name": string // Name of the workspace,
  "enable_currency_conversion": boolean // Enable currency conversion for the workspace,
  "currency": string // Currency code for the workspace. Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BYR`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XDR`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW`, `ZWL`,
  "exchange_rate_date": string // The date to use for currency conversion. Allowed values: `daily_rate`, `end_of_billing_period_rate`
}

Responses

201: Created 400: BadRequest

View Full Documentation

For interactive testing, request/response examples, and detailed schemas, visit: https://docs.vantage.sh/api/workspaces/update-workspace

Summary

This reference includes 169 endpoints across 42 categories. For the most up-to-date information, always refer to the OpenAPI specification or the individual endpoint pages.