Get a recipe

GET

watch

management

recipes

{recipe_id}

Get a recipe

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/recipes/{recipe_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "rcp_01jc0t6fwwfgfsq1md24mhyztj",
  "name": "signup_proxy_abuse",
  "status": "DRAFT",
  "threshold": 70,
  "rules": [
    {
      "rule_id": "rul_01jc0t6fwwfgfsq1md24mhyztj",
      "weight": 40,
      "overrides": "FLAG"
    }
  ],
  "parameters": {
    "blocked_countries": "RU,BY",
    "max_attempts": "5"
  }
}

{
  "code": "recipe_not_found",
  "message": "The requested recipe does not exist.",
  "type": "not_found",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}

Returns one recipe in full: its status, threshold, the rules it scores over with their weights, and the 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

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"

status

enum<string>

required

Available options:

DRAFT,

SHADOW,

LIVE,

INACTIVE

threshold

integer<int64>

required

Example:

70

rules

object[]

required

Show child attributes

parameters

object

Show child attributes

Example:

{
  "blocked_countries": "RU,BY",
  "max_attempts": "5"
}

Get a recipe

curl --request GET \
  --url https://api.prelude.dev/v2/watch/management/recipes/{recipe_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/watch/management/recipes/{recipe_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "rcp_01jc0t6fwwfgfsq1md24mhyztj",
  "name": "signup_proxy_abuse",
  "status": "DRAFT",
  "threshold": 70,
  "rules": [
    {
      "rule_id": "rul_01jc0t6fwwfgfsq1md24mhyztj",
      "weight": 40,
      "overrides": "FLAG"
    }
  ],
  "parameters": {
    "blocked_countries": "RU,BY",
    "max_attempts": "5"
  }
}

{
  "code": "recipe_not_found",
  "message": "The requested recipe does not exist.",
  "type": "not_found",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a"
}

Documentation

API Reference

Management API

Authorizations

Path Parameters

Response