Developers API

addHostSensor_PING

Adds a Ping monitoring sensor to specified host.

Request Parameters

Parameter Data Type Description Required Default
hostid integer Unique ID of the host to which this sensor is being added Required -
target string Hostname or IP address of this sensors' monitoring target Required -
nicename string A short, human readable description of this sensor Optional
allowedpacketloss integer A percentage threshold of packets lost beyond which the sensor test will fail Optional 25
timeout integer Number of seconds after which we consider a ping packet lost. Optional 5

Response Data

Response Variable Data Type Description
errorcode integer Returns an errorcode of 0 if call is successful.
hostsensorid integer The unique ID corresponding to the newly created sensor
Try it out with the API Explorer:

Your API Key

API command to be called

Desired response format

Unique ID of the host to which this sensor is being added (integer)

Hostname or IP address of this sensors' monitoring target (string)

A short, human readable description of this sensor (string)

A percentage threshold of packets lost beyond which the sensor test will fail (integer, optional, default = 25)

Number of seconds after which we consider a ping packet lost. (integer, optional, default = 5)