Skip to main content
GET
Get a recipe
Returns one recipe in full: its status, threshold, the rules it scores over with their weights, and the attributes and parameters it declares. Rule entries carry identifiers only. To read the expression behind one of your own, call Get a rule; for a managed one, find its description in List managed rules.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

recipe_id
string
required

The recipe identifier.

Example:

"rcp_01jc0t6fwwfgfsq1md24mhyztj"

Response

OK

id
string
required

The recipe identifier. Reference it in a flow's recipes to run it.

Example:

"rcp_01jc0t6fwwfgfsq1md24mhyztj"

name
string
required
Example:

"signup_proxy_abuse"

catalog_version
integer<int64>
required

The version of the Prelude signal catalog this recipe's rules are compiled against, stamped by the server when the recipe is created or replaced. It is what stops a catalog that later grows or deprecates entries from silently changing what this recipe means.

Example:

1

status
enum<string>
required
Available options:
DRAFT,
SHADOW,
LIVE,
INACTIVE
threshold
integer<int64>
required
Example:

70

rules
object[]
required
attributes
string[]
Example:
parameters
object
Example: