Recipes

DEPRECATED Update automated recipe configuration

Deprecated: use PUT /api/v3.1/automated-recipes/{recipe_id}/. This version stays available until it is switched off; see Moving recipes to v3.1.

When the recipes service fails, this version answers 500 with an HTML page, and an error in the 4xx range can arrive with a body that is not JSON. It also repeats the request to the recipes service up to three times, create included, so a create can run twice. v3.1 does neither: every error is {code, message, details}, and a request is repeated only when it provably never reached the service.

Supplies the configuration of an automated recipe: data sources, connections and accounts. A recipe created by POST is empty, so this call is a required step of every deployment, not an optional edit.

The payload is the complete configuration, and it is append-only. Send every data source, every connection and every account the recipe should have, including the ones it already has. Sending a delta fails: removing a data source, a connection or an account that is already configured returns 400 and nothing is saved. There is no way to remove an account, a connection or a data source from a recipe through this call. If the set has to shrink, delete the recipe with DELETE /api/v3/automated-recipes/{recipe_id}/ and deploy it again from the same template.

Returns 200 with an empty body. Read the recipe back with GET /api/v3/automated-recipes/{recipe_id}/ to confirm what was stored.

put/api/v3/automated-recipes/{recipe_id}/

Request

Path parameters

recipe_idstring required

Automated recipe ID (numeric string)

Request body

data_sourcesstring[] required

List of data source names to include

sync_from_datestring date

Start date for data synchronization (YYYY-MM-DD)

Response

Recipe configuration updated successfully (empty body)

Changes

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