List Composer recipes

Returns the Composer recipes that have results in your recently scanned cloud accounts, with counts of those results by status and their estimated savings. Recipes with no such results are not listed. Dismissed recipes are listed with status: dismissed and every count set to 0.

Recipes are sorted by severity, descending, by default. Ties break by title (case-insensitive), then by id.

filter is one string of key:value clauses: , separates alternative values for one key (OR) and | separates keys (AND), for example severity:critical,high|provider:aws,gcp. Because , and | are separators, a value itself can't contain them. Supported keys:

  • provider: one or more of aws, azure, azure_ad, gcp, general, google_cloud_source, google_workspace, k8s, oci, vmware.
  • severity: one or more of critical, high, medium, low.
  • pillar: one or more of cost, operations, performance, security, compliance. compliance matches recipes tagged with at least one compliance standard.
  • has_active_results: exactly one of true or false.
  • allocation: up to 10 distinct allocation IDs from GET /analytics/v1/allocations. Lists only recipes with results on resources in any of those allocations; counts, savings and rowCount then cover only those resources. An allocation you can't view returns 404; if access can't be checked, the request returns 503 rather than unfiltered data.

Requests are always served for the customer your API token belongs to. To list the results of one recipe, use its id with GET /insights/v2/recipes/{recipeId}/results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 500
Defaults to 50

Maximum number of items to return on one page, from 1 to 500. Defaults to 50. A value outside that range returns 400 validation_failed.

string

Continuation token from the pageToken of the previous response. Omit it on the first request; a response without pageToken is the last page.

The token records the position, the sort and the allocation filter IDs. Changing sortBy, sortOrder or the allocation IDs while paginating returns 400 pagination_token_invalid. Keep the other filter keys and maxResults unchanged while paginating. Tokens expire 5 minutes after they are issued; an expired token returns 400 pagination_token_expired. In both cases, restart from the first page.

string
enum
Defaults to severity

Field to sort recipes by. Defaults to severity. Ties break by title (case-insensitive, ascending), then by id (ascending), whatever the sortOrder.

Show Details
severitySort by severity, from critical to low when descending.
titleSort alphabetically by title, ignoring case.
detection_timeSort by when the recipe's earliest result was detected. Recipes without a detection time sort last when descending and first when ascending.
active_results_countSort by the number of active results.
total_results_countSort by the number of results in any status.
Allowed:
string
enum
Defaults to desc

Sort direction for sortBy. Defaults to desc.

Show Details
ascSmallest, earliest or lowest first (for `severity`, low first).
descLargest, latest or highest first (for `severity`, critical first). Default.
Allowed:
string

Restricts the recipes returned. One string of key:value clauses: , separates alternative values for one key (OR) and | separates keys (AND). For example, severity:critical,high|provider:aws,gcp returns recipes whose severity is critical or high and whose provider is Amazon Web Services or Google Cloud Platform. Because , and | are separators, a value itself can't contain them. Only equality matching is supported. Omit filter to list every recipe that has results in your recently scanned accounts, including dismissed recipes.

Keys:

  • provider: one or more of aws, azure, azure_ad, gcp, general, google_cloud_source, google_workspace, k8s, oci, vmware.
  • severity: one or more of critical, high, medium, low.
  • pillar: one or more of cost, operations, performance, security, compliance. Matches recipes tagged with that pillar; compliance matches recipes tagged with at least one compliance standard (such as SOC2 or HIPAA).
  • has_active_results: exactly one of true or false.
  • allocation: up to 10 distinct allocation IDs (duplicates are ignored); get allocation IDs from GET /analytics/v1/allocations. Matches recipes with results on resources in any of those allocations, as resolved by Cloud Analytics; counts, savings and rowCount then cover only those resources. You must be able to view every listed allocation. Service-account API keys can use public allocations only. If allocation access can't be checked, the request returns 503 with Retry-After and never falls back to unfiltered data.

Errors:

  • An unknown key returns 400 filter_key_not_supported when it's the only problem, otherwise 400 validation_failed.
  • A value outside the allowed list, a non-boolean has_active_results, more than one has_active_results value, more than 10 distinct allocation IDs, an invalid allocation ID (blank, longer than 256 characters, or containing /, whitespace or control characters), a malformed expression or an unsupported operator returns 400 validation_failed.
  • An allocation that doesn't exist or that you can't view returns 404 composer-api.allocation_not_found.
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json