Local log bundle
Synchronous on-appliance log-bundle stream. Distinct from the tenant-side asynchronous flow under broker-papi.yaml's logs tag — that one is request → poll → download against the cloud, this one is a single POST that streams the bundle back as application/octet-stream.
Collect and stream the on-appliance log bundle back to the caller as application/octet-stream (a gzipped tar archive).
The collector is single-writer: only one bundle generation runs at a time. A concurrent call returns 503 with Retry-After: 60.
Authentication: Bearer token from
generateToken.DRF authenticates once at request start; a token that expires mid-stream does NOT abort the response.
Response is streamed — a downstream failure during collection (timeout, disk read error) surfaces as a truncated download, not as a clean
500. Treat that case by inspecting the broker's request-level logs.
Short-lived (10-minute TTL) opaque API token issued by
generateToken. Sent as
Authorization: Bearer <token>. A token that expires mid-request
does NOT abort the response (DRF authenticates once at request
start).
Gzipped tar archive of the on-appliance log bundle.
Raw bytes of the gzipped tar archive.
Missing, malformed, or expired Bearer token.
InitialPasswordGateMiddleware blocked the request because the
factory-default admin password has not yet been replaced via
resetInitialPassword.
Synchronous startup failure (e.g., Redis read error from
build_bundle_filename, or pre-stream audit log emission
failure). Streaming failures are NOT mapped to 500 — see
the operation description.
Another log collection is in progress; back off and retry.
POST /public_api/v1/logs HTTP/1.1
Host: broker.example.local
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryLast updated
Was this helpful?
