Health endpoints
The unauthenticated status probe behind the status page. Every operation with parameters, body, responses, errors and examples.
The unauthenticated status probe behind the status page.
Base URL https://app.processcart.com/api/v1. Every operation below is also in the OpenAPI document and the interactive reference.
| Operation | Method and path | Scope |
|---|---|---|
| Check that the API is up | GET /v1 |
No credential |
GET /v1/health
Check that the API is up. No credential. Operation id getHealth · open in the API reference.
The status-page probe: { "status": "ok" } with 200 when the database answers, { "status": "degraded" } with 503 otherwise. Unauthenticated, cached per instance for ten seconds, limited per client address, never logged.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | OK. | Health |
| 405 | The verb is not supported on this path. method_not_allowed — Method not allowed. |
Problem |
| 429 | rate_limited — Too many requests. |
Problem |
| 500 | internal_error — Internal error. |
Problem |
| 503 | The database did not answer in time: { "status": "degraded" } (JSON, not a problem). |
Health |
Errors (every code this operation can answer; see Errors)
- 405
method_not_allowed— Method not allowed - 429
rate_limited— Too many requests - 500
internal_error— Internal error - 503
unavailable— Service unavailable
Example response (200)
{
"status": "ok"
}