Skip to navigation
ReferenceService 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.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to text/plain

Response

Returns the string, 'pong'.

Errors

405
Method Not Allowed Error