Set a config value
curl --request PUT \
--url https://breadbox.example.com/api/v1/config/{key} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"value": "<string>"
}
'{
"key": "<string>",
"value": "<string>",
"secret": true
}Settings
Set a config value
Writes the named value to the app_config table. The
always-denied key list (ENCRYPTION_KEY, teller_cert_pem,
teller_key_pem) returns 403 FORBIDDEN.
Requires full_access scope.
PUT
/
api
/
v1
/
config
/
{key}
Set a config value
curl --request PUT \
--url https://breadbox.example.com/api/v1/config/{key} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"value": "<string>"
}
'{
"key": "<string>",
"value": "<string>",
"secret": true
}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
Body
application/json
⌘I