Aller au contenu principal
NEXCLARADocumentation

health

Sondes techniques de vivacite et d'aptitude au trafic.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

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

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
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

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
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

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonVersionResponse