Skip to navigation
Online APIService Status

Ping

This endpoint can be used to check that the service is available and reachable.

Note

Unlike all other endpoints, this endpoint does not require authentication, and responds with text/plain instead of application/json.

Successful Response (200)

Returns the string, “pong”.

Connection Timeouts

  • Open timeout: 10 seconds
  • Read timeout: 20 seconds

Errors

The following error responses can be returned by Ping:

HTTP Status CodeerrorCodeDescription
405
Method Not Allowed		N/AThe request was made by a HTTP Method other than GET, HEAD or OPTIONS.

For example, POST, PUT or DELETE.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to text/plain

Response

This endpoint returns an object.