Skip to main content
NEXCLARADocumentation

health

Sondes techniques de vivacite et d'aptitude au trafic.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

GET /api/v1/health/live

Sonde de vivacite

Confirme que le processus API repond. N'interroge aucune dependance : un incident de base de donnees ne doit pas declencher un redemarrage.

healthLive

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonLivenessResponse

GET /api/v1/health/ready

Sonde d'aptitude au trafic

Interroge reellement les dependances de fondation configurees (PostgreSQL, et Redis lorsqu'il est configure). Retourne 503 des qu'une dependance est indisponible.

healthReady

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonReadinessResponse
503Service Unavailableapplication/jsonReadinessResponse

GET /api/v1/version

Version servie

Version produit, revision abregee de l'artefact deploye, environnement, version du contrat et du moteur. Aucun detail d'infrastructure.

serviceVersion

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonVersionResponse