Immutable source snapshot
GET /healthz
Healthz. Permissions, parameters, responses and examples.
This address preserves one reviewed source snapshot. Use the current entry point for the selected documentation version.
Read pinned handler: apps/api/kodesec_api/main.py:2780
Healthz
Healthz through GET /healthz. The parameters and declared response shapes below come from this exact source snapshot.
Source preview; no stable third-party integration promise. This page makes no request to a local installation.
Authority
No browser session required by middleware. Exact Host and Origin boundary still applies.
Parameters and headers
No explicit path, query or header parameters are declared here. The authority boundary still applies.
Request body
No typed JSON body is declared by this handler. That does not rule out source-level request parsing; inspect the pinned implementation, especially for internal connector protocols.
Responses
| Status | Meaning and declared shape |
|---|---|
200 | Successful Response application/json · object |
400 | Exact host, malformed request or URL credential refusal application/json · object |
403 | Exact origin, CSRF or route authority refusal application/json · object |
503 | Check readiness and the recorded job state. A healthy control plane does not prove scanner readiness. See source-linked error catalog. |
An empty or broad schema preserves the source contract. It is not a promise of an empty response.
Source-linked errors
Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.
2 source error observations
Synthetic examples
These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.
Response 200 JSON
{}All referenced models remain in its components section. Browse control model definitions.