Check Health

Call this endpoint using a GET request to check the health of the transactional SMS service.

Endpoint

Method URL Parameters
GET https://[Your URL]/api/2.0/production/health [Your URL] – Your Everlytic Install URL, e.g. live1.everlytic.net

Example Request

curl --location 'https://live0.everlytic.net/api/2.0/production/health'

Response

Status codes

Status codes Explanation
200 Ok Transactional SMS service is available.
500 Internal Server Error Transactional SMS service is unavailable.

Properties

Property Description Data type Parameters
status The current health of the Transactional SMS service string
  • ok
  • error

Example responses

Service is available [200 OK]

{
  "status": "ok"
}

Service is unavailable [500]

{
  "status": "error"
}