recommendations

Get recommendation

Returns the full details of a single recommendation, including metadata, suggested actions, and cost impact. Note: The optimization_id field is deprecated; use recommendation_type_id instead.

get/v2/optimize/recommendations/{recommendation_id}

Request

Base URL
https://api.cloudzero.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/cloudzero/apis/cloudzero-api-v2-resources/docs/v2/optimize/recommendations/:recommendation_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

recommendation_idstring required

The ID of the recommendation to get

Response

Successful Response

columnsstring[]

The columns in the response

display_namesobject

A mapping of column names to display names

multiple_value_columnsstring[]

Columns in the response that are an array of values

Example response

{
  "recommendation": {
    "recommendation_id": "rec-12345",
    "title": "Rightsize EC2 instance",
    "category": "optimization",
    "optimization_id": "CIR-AWS-00216",
    "recommendation_type_id": "CIR-AWS-00216",
    "source": "CloudZero",
    "effort": "low",
    "status": "not_started",
    "cost_impact_last_30_days": 150,
    "enriched": false
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.