Health API

Connect to Modica Health API to monitor in a near real-time fashion whether our individual APIs are available and healthy to take requests.

We poll the health of each of these services every minute, from an external geographically distributed provider, independent of our own infrastructure. Status information is cached, we will retrieve status information once per minute.

No authentication is required to utilise this service.

OpenAPI Specification

You must elect which service(s) you wish to receive health information about, eg:

GET /rest/services/v1/status?service=rest&service=smpp

The full list of services which can be queried includes:

  • email2sms

  • https

  • rest

  • restv2

  • smpp

  • soap

Values are case sensitive, providing a service outside of this list will always provide an “unknown” status.