Update a recipe
Beta. The request and response shapes may still change.
Overwrite a recipe in place. The body is the whole recipe, not a patch: rules and parameters you omit are cleared.
The submitted recipe is validated exactly as a creation is, and re-pinned to today’s signal vocabulary - a recipe follows the vocabulary it was last published against, so an edit is what moves it forward. Moving a recipe between DRAFT, SHADOW, LIVE and INACTIVE is this endpoint too.
status to promote a SHADOW recipe to LIVE, or to take a LIVE one back to INACTIVE.Authorizations
Path Parameters
Body
Whether the recipe takes part in an evaluation, and whether its verdict counts.
DRAFT- Not yet in service. It does not evaluate.SHADOW- Evaluates and is reported, so you can watch a threshold against live traffic before trusting it.LIVE- Evaluates, and its verdict counts toward the evaluation-level answer.INACTIVE- Taken back out of service. It does not evaluate.
DRAFT, SHADOW, LIVE, INACTIVE "SHADOW"
This recipe's configuration: keys and their values, referenced in an expression as param.<key>, fixed until the recipe is updated. Use them for the country list or the limit a shared rule should apply here, so the same rule can serve two recipes tuned differently.
A key is lower snake_case, at most 64 characters, and at most 32 may be declared. Values are strings - the only type either supports today.
Every key needs a value. An empty value is refused - omit the key instead.
The managed recipe this recipe extends (see List managed recipes). The recipe then scores the managed recipe's rules, followed by its own rules.
On such a recipe, threshold must be within the managed recipe's threshold_bounds, or equal to its threshold when it has none, and parameters sets the parameters the managed recipe exposes, within their bounds. A parameter you do not set uses its default_value. The managed recipe's parameters tune its rules only: a custom rule cannot read them. Under any other name, parameters declares a parameter of this recipe, which its custom rules read as in any recipe. The managed recipe's parameters count toward the 32 a recipe may declare.
"rcp_01jc0t6fwwfgfsq1md24mhyztj"
Response
OK
The managed recipe this recipe extends. rules and parameters are this recipe's own. The managed recipe's rules are not listed; its parameters are described by List managed recipes.
"rcp_01jc0t6fwwfgfsq1md24mhyztj"