Skip to main content
POST
/
api
/
v1
/
rules
/
preview
Preview rule matches
curl --request POST \
  --url https://breadbox.example.com/api/v1/rules/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "condition": {},
  "actions": [
    {}
  ],
  "enabled": true,
  "priority": 123,
  "triggers": []
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Body

application/json
​
name
string
required
​
condition
object
required
​
actions
object[]
required
​
enabled
boolean
​
priority
integer
​
triggers
enum<string>[]
Available options:
sync,
retroactive,
manual

Response

200 - application/json

Preview matches.

The response is of type object.