Connection Check

Test connection to internet from the gateway.

Useful for debugging, this endpoint can be called to attempt to ping and check for connection from the gateway side.

GET /api/v2/gateway/check{?timeout}

Query Parameters

ParameterDescriptionType
timeoutThe number of seconds to wait for response to a server.integer, optional
default: 2
min: 2
max: 10

Responses

200 OK

online refers to the connection to the internet. cloud refers to LRSConnect could be "ONLINE" or "OFFLINE" depending on internet connection or the cloud server. (e.g. In the case that LRSConnect is down, connection to internet may still be online)

{
  "status": 200,
  "returnCode": 14,
  "online": True,
  "cloud": "ONLINE"
}

400 Bad Request

Invalid timeout parameter.

{
  "status": 400,
  "message": "Invalid timeout.",
  "returnCode": -33
}

400 Bad Request

timeout out of bounds.

{
  "status": 400,
  "message": "Timeout out of bounds.",
  "returnCode": -34
}