Ping a host from a Core

Runs ping on the Core against an address you choose and returns the device output. Use it to prove that a Core can reach a specific host on the customer network or on the internet — a camera, a gateway, a DNS server, an NVR. To check the Core's connection to Lumana itself use POST /v1/troubleshooting/cores/connectivity-test, which pings a fixed Lumana host and needs no address. The command is published to the Core and the HTTP response is held open until the device answers. On success the body is the device's own output merged with sessionId and state. state is a NUMBER, not a word - 0 completed, 1 the device did not answer in time, 2 the device reported an error, 3 the command was not sent because the Core was out of sync. A call that times out answers 408 with { message, state: 1, responseBody } and carries NO sessionId and no device output. The shape of the device output depends on the Core software version and is passed through untouched, so treat it as free-form diagnostic data rather than a fixed schema.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Id of the Core to run the diagnostic on. It must belong to the organization the credential authenticates as; a Core of another organization is reported as not found. The location is resolved from the Core itself, so there is no locationId parameter.

string
required

Hostname or IPv4 address to ping, for example 8.8.8.8 or gateway.example.com. Only hostnames and IP addresses are accepted: the value is forwarded to a command on the device, so anything carrying shell metacharacters is rejected with 400.

boolean
Defaults to false

Probe with a TCP connection instead of ICMP. Use it on networks that drop ICMP, where a plain ping reports a loss that does not reflect real reachability. Defaults to false (ICMP).

Responses

400

The request body is invalid. The response names the field to correct.

401

Unauthorized. Missing or invalid credentials.

404

No such Core in this organization. Returned both for a Core id that does not exist and for one that belongs to another organization.

408

The Core did not answer within 120 SECONDS, after which the call answers 408 Request Timeout and the command may still complete on the device. The body is { message: "Request Timeout", state: 1, responseBody } — no sessionId and no device output. This usually means the device is offline or has lost its connection to Lumana.

500

The diagnostic could not be dispatched, or the Core answered with an error. The body carries state: 2 (error) and the device message when there is one.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json