Skip to content

Ping Interface

The Ping (ping) interface provides a standard method for validating that a devices is reachable and that both ends of the connection are up.

When ping is implemented for a device, the Control Gateway automatically pings the device once-per-minute. This is intended to prevent, or reset stale or half-open connections, common with long running/always open TCP connections.

PingInterface

ping

Ping the device:

json
{
    "msg": "io.upswell.xagent.ControlRequest",
    "device": "<device alias>",
    "method": "ping",
    "mid": "123abc"
}

Accepts: None / Returns: Ack

Atlas, Hybrid cloud, on-premesis platform for large scale media program development, delivery and operation.