IMimprovado
Automated Recipes

List recipes

Lists the automated recipes of the workspace the request is authenticated for, the most recently changed first.

Every field you need to triage a fleet is already here: state, degraded, not_delivered_reasons and error. Read the detail of a recipe only when you need its configuration or the per-data-source breakdown.

The page holds 20 recipes by default and 100 at most; next and previous are full v3.1 URLs.

get/api/v3.1/automated-recipes/

Request

Query parameters

template_idinteger

Return only the recipes deployed from this template. A value that is not a positive integer is rejected with 400 invalid_query_parameter.

state'extracting_data' | 'building_dependencies' | 'ready_to_work' | 'failed'

Return only the recipes in this state. The value has to match one of the four snake_case states exactly; anything else, including a v3 value such as Ready to work, is rejected with 400 invalid_query_parameter and the allowed values in details.allowed_values.

pageinteger

Page number, starting at 1. A page beyond the last one is rejected with 400 invalid_query_parameter, not answered with an empty list.

page_sizeinteger

Recipes per page, from 1 to 100. A larger value is rejected with 400 invalid_query_parameter; it is not silently capped.

Response

One page of recipes

countinteger

Total number of recipes matching the request.

nextstring nullable

Full URL of the next page, or null on the last page.

previousstring nullable

Full URL of the previous page, or null on the first page.

Changes

No recorded changes to this operation across all 1 revision of this API.