POST /v1/debug_bundles
Bundles are kept in the export object store (EXPORT_S3_BUCKET, EXPORT_S3_REGION, EXPORT_S3_KMS_KEY_ID). A deployment without it answers 503 debug_bundles_unavailable (not retryable) once the sign-in is found and authorized, and writes nothing; reading a bundle there answers the same code.
- Scope
environment:write- Auth
- Access token
- Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”sign_instring Required
Responses
Section titled “Responses”- 201 OK DebugBundle
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/debug_bundles" \ -H "Authorization: Bearer $OHAUTHCAT_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "sign_in": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5"}'const response = await fetch("https://api.ohauthcat.com/v1/debug_bundles", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_ACCESS_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ "sign_in": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/debug_bundles", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_ACCESS_TOKEN']}"}, json={ "sign_in": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", },)data = response.json(){ "id": "dbgb_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "sign_in": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "created_at": "2026-01-15T09:30:00Z", "expires_at": "2026-01-15T09:30:00Z", "diagnostic_available": true}