Skip to main content
GET
/
api
/
v1
/
config
/
{key}
Get a single config entry
curl --request GET \
  --url https://breadbox.example.com/api/v1/config/{key} \
  --header 'X-API-Key: <api-key>'
{
  "key": "<string>",
  "value": "<string>",
  "masked": true,
  "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

​
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.

Path Parameters

​
key
string
required

Query Parameters

​
reveal
boolean

Response

200 - application/json

Config entry.

​
key
string
​
value
string | null
​
masked
boolean
​
source
enum<string>
Available options:
env,
db,
default
​
secret
boolean