Skip to main content
GET
/
recommendations
Get all recommendations
curl --request GET \
  --url https://api.vantage.sh/v2/recommendations \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/recommendations",
    "first": "https://api.vantage.sh/v2/recommendations?page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/recommendations?page=1",
    "prev": null
  },
  "recommendations": [
    {
      "token": "rcmmndtn_5cbc9cf9692619a9",
      "category": "ip_unattached",
      "workspace_token": "wrkspc_ab4f7a41afd5f542",
      "provider": "aws",
      "provider_account_id": "123456789012",
      "description": "IP address is not attached to an instance.",
      "potential_savings": "100.0",
      "service": "AWS IP",
      "created_at": "2026-01-23T21:26:59Z",
      "resources_affected_count": 0,
      "currency_code": "USD",
      "currency_symbol": "$"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

workspace_token
string

Filter by workspace.

provider_account_id
string

Filter by provider account id (AWS account, Azure subscription id, etc).

category
enum<string>

Filter by category.

Available options:
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,
database_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
enum<string>

Filter by provider.

Available options:
aws,
gcp,
azure,
kubernetes,
datadog
provider_ids
enum<string>[]

Filter by one or more providers. Requires workspace_token.

Available options:
aws,
gcp,
azure,
kubernetes,
datadog
billing_account_ids
string[]

Filter by billing account identifiers. Requires workspace_token.

account_ids
string[]

Filter by account identifiers. Requires workspace_token.

regions
string[]

Filter by region slugs (e.g. us-east-1, eastus, asia-east1). Requires workspace_token.

tag_key
string

Filter by tag key (must be used with tag_value). Requires workspace_token.

tag_value
string

Filter by tag value (requires tag_key). Requires workspace_token.

start_date
string

Filter recommendations created on/after this YYYY-MM-DD date. Requires workspace_token.

end_date
string

Filter recommendations created on/before this YYYY-MM-DD date. Requires workspace_token.

status
enum<string>

Filter by status.

Available options:
active,
archived
page
integer<int32>

The page of results to return.

limit
integer<int32>

The number of results to return. The maximum is 1000.

Response

200 - application/json

Recommendations model

recommendations
object[]
required