Update rule
curl --request PUT \
--url https://breadbox.example.com/api/v1/rules/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"condition": {},
"actions": [
{}
],
"enabled": true,
"priority": 123,
"triggers": []
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"enabled": true,
"priority": 123,
"creator_id": "<string>",
"condition": {},
"actions": [
{}
],
"triggers": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Rules
Update rule
Requires full_access scope.
PUT
/
api
/
v1
/
rules
/
{id}
Update rule
curl --request PUT \
--url https://breadbox.example.com/api/v1/rules/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"condition": {},
"actions": [
{}
],
"enabled": true,
"priority": 123,
"triggers": []
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"enabled": true,
"priority": 123,
"creator_id": "<string>",
"condition": {},
"actions": [
{}
],
"triggers": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}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
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.
Path Parameters
UUID or 8-char short_id.
Body
application/json
Response
200 - application/json
Updated rule.
Available options:
user, agent, system Recursive AND/OR/NOT condition tree. See docs/rule-dsl.md.
Available options:
sync, retroactive, manual ⌘I