Setup readiness report

Returns a one-shot readiness/setup summary intended for the breadbox doctor CLI command. Any API key (read or write) works. Fields are best-effort — a per-row failure stays zero and the report still ships. The endpoint returns 503 only when the database is plainly unreachable.

Setup readiness report

cURL

curl --request GET \
  --url https://breadbox.example.com/api/v1/headless/bootstrap \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://breadbox.example.com/api/v1/headless/bootstrap"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://breadbox.example.com/api/v1/headless/bootstrap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/headless/bootstrap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/headless/bootstrap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://breadbox.example.com/api/v1/headless/bootstrap")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/headless/bootstrap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "version": "<string>",
  "encryption_key_set": true,
  "database": {
    "connected": true,
    "migrations_current": true,
    "migration_version": 123
  },
  "providers": [
    {
      "configured": true,
      "env": "<string>"
    }
  ],
  "users_count": 123,
  "login_accounts_count": 123,
  "api_keys_count": 123,
  "active_connections_count": 123,
  "scheduler_running": true,
  "first_run": true
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

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.

Response

200

application/json

Bootstrap report.

Readiness/setup summary consumed by breadbox doctor.

version · string · required

Server build version.

encryption_key_set · boolean · required

True when ENCRYPTION_KEY is set.

database · object · required

Show child attributes

providers · object[] · required

Provider configuration status. Order is stable (plaid, teller).

Show child attributes

users_count · integer<int64> · required

Household user count.

login_accounts_count · integer<int64> · required

Admin / dashboard login account count.

api_keys_count · integer<int64> · required

Active (un-revoked) API key count.

active_connections_count · integer<int64> · required

Bank connections in 'active' status.

scheduler_running · boolean · required

True when the sync scheduler has active cron entries.

first_run · boolean · required

True when login_accounts_count == 0 — the same signal used by the admin first-run redirect.