Skip to content

Health

Request

Health Check

Headers
x-correlation-idstring

A unique transaction id used to correlate api requests end to end.

Example:123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  https://test.developer.servictoria.io/_mock/portal/rest/ddp-title-alert-api/title-alert-api-schema/vicland/alert/v1/health \
  -H 'x-correlation-id: 123e4567-e89b-12d3-a456-426614174000'

Responses

OK

Bodyapplication/json
applicationNamestringrequired

Application Name

Example:"SERV Title Alert API"
applicationVersionstringrequired

Application Version

Example:"1.0.9"
apiNamestringrequired

API Name

Example:"serv-title-alert-api"
environmentstringrequired

Environment

Example:"DEV"
statusstringrequired

Status

Example:"running"
Response
{ "applicationName": "SERV Title Alert API", "applicationVersion": "1.0.9", "apiName": "serv-title-alert-api", "environment": "DEV", "status": "running" }