Skip to main content
Create rule

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

201 - application/json

Created.

id
string
short_id
string
name
string
enabled
boolean
priority
integer
creator_type
enum<string>
Available options:
user,
agent,
system
creator_id
string | null
condition
object

Recursive AND/OR/NOT condition tree. See docs/rule-dsl.md.

actions
object[]
triggers
enum<string>[]
Available options:
sync,
retroactive,
manual
created_at
string<date-time>
updated_at
string<date-time>
Last modified on June 25, 2026