AliveService Resource

DELETE /healthcheck/heartbeat

This endpoint is used to stop the service from being used by the load balancer.

Example

Request
DELETE /healthcheck/heartbeat

              
Response
HTTP/1.1 204 No Content

              

GET /healthcheck/heartbeat

This endpoint is used to determine if the service is running.

Response Body
media type data type description
application/json string (JSON) a status 204 if alive and 404 if not.
application/xml string (XML)

Example

Request
GET /healthcheck/heartbeat
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

POST /healthcheck/heartbeat

This endpoint is used to start the service to used by the load balancer.

Example

Request
POST /healthcheck/heartbeat

              
Response
HTTP/1.1 201 Created

              

GET /healthcheck/heartbeat/checked

This endpoint is used to see if the heartbeat has been checked since update.

Response Body
media type data type description
application/json string (JSON) a status 204 or 404 depending on if the heartbeat has been checked.
application/xml string (XML)

Example

Request
GET /healthcheck/heartbeat/checked
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...