Ping

The ping API can be used to check if the server is up and running.

Ping

URL/api/<auth_token>/ping
MethodGET
Version1.0

Description

Determines if the server is responding. If successfully, a pong is returned with the date and time in GMT.

Path arguments

Name Type Description Required
auth_token string The authentication token used to authenticate the request. Required

Query arguments

Name Type Description Required
keepalive number The amount of time in seconds requested for the host to keep running if placed in the background. Optional

Response

This call returns a pong parameter containing the date and time the pong was sent in GMT with millisecond accuracy. This can be used to discover latency between devices.

Response example

{
    "pong": "2014-09-05T15:44:50.409Z"
}