Get shallow, deep, storage, or PostgreSQL health.
GET /api/health
Get shallow, deep, storage, or PostgreSQL health.
Access
Section titled “Access”This operation does not declare a credential requirement in the released API contract.
Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.
Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
check |
query | "postgres" · "storage" · "deep" |
No |
Call the endpoint
Section titled “Call the endpoint”Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.
curl --request GET \ 'https://commentary.dev/api/health'Responses
Section titled “Responses”| Status | Meaning | Payload |
|---|---|---|
200 |
Successful response. | object |
503 |
Health check failed. | object |
Successful response fields
Section titled “Successful response fields”Value type: object.
Recover from errors
Section titled “Recover from errors”Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.
Contract and related guidance
Section titled “Contract and related guidance”Operation ID: getHealth. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.