The purpose of these endpoints is to provide a quick mechanism for determining whether the service is listening.
The endpoint returns the string “UP” if the connection is correct.
GET: api/v1/health/{entrypointName}/{svr_timeout}
Examples: api/v1/health
api/v1/health/MYENTRYPOINT/3
api/v1/health?entrypointName=MYENTRYPOINT&svr_timeout=3
Parameters or headers (as you prefer)
•entrypointName
If a valid value is given to this parameter, an operation is launched against that EntryPoint and the availability of that EntryPoint is evaluated.
If any free lines are found, or lines on demand that have not been opened, the EntryPoint is considered “live” and a response with code 200 and text UP is returned.
If the EntryPoint is off, or there are no free lines, the EntryPoint is considered “dead” and a response with code 400 is returned.
•svr_timeout
This is the maximum wait time (in seconds) for the EntryPoint status query operation to complete.
If no response is received within this time period, the EntryPoint is considered “dead” and a response with code 400 is returned.
The default value for this parameter is set to 3 seconds.
Request Body
None
Responses
Error message or string “UP” if the service or Entrypoint is available.
