Developers API

Command Reference

addHostSensor_FTP

Adds an FTP monitoring sensor to specified host.

addHostSensor_HTTP

Adds an HTTP monitoring sensor to specified host.

addHostSensor_PING

Adds a Ping monitoring sensor to specified host.

assignAlertGroup

Assign an Alert Group to a Host. Different Alert Groups can be specified for alerts generated by Uptime Monitoring, and for alerts generated by Metrics. The "mode" parameter is used to differentiate between them.

createHost

Creates a new Wormly host for Uptime Monitoring and / or Metrics collection.

deleteAlertGroup

Delete an alert group

deleteDoNotDisturbPeriod

Delete a Do Not Disturb period for the specified contact/channel.

deleteHost

Deletes a Wormly-monitored host.

deleteScheduledDowntimePeriod

Delete a scheduled downtime period for the specified host.

deleteSensor

Deletes the specified monitoring sensor.

disableHostUptimeMonitoring

Disables uptime monitoring of the specified host.

disableSensor

Disables a Wormly-monitored host sensor.

downloadLinuxHMAgent

Downloads the Wormly Health Monitoring agent.php for Linux platforms.

enableHostHMLinux

Enables Linux health monitoring for the specified host.

enableHostHMWindows

Enables health monitoring on a Windows host.

enableHostUptimeMonitoring

Enables uptime monitoring of the specified host.

enableSensor

Enables a Wormly-monitored host sensor.

getAlertGroups

Query a list of all alert groups.

getAlertMatrix

Fetches an Alert Group.

getContactList

Query a list of all contact persons, and all alert channels configured for those contacts.

getDailyUptimeReport

Fetches a hosts' daily uptime report records for the specified date range.

getDoNotDisturbPeriods

Fetches a list of all Do Not Disturb periods scheduled for the specified contact/channel.

getHostSensorStatus

Fetches the current state of all sensors belonging to the specified host.

getHostSensors

Fetches all sensors belonging to the specified host

getHostStatus

Query the current uptime & health monitoring status of one of more hosts. Also used to retrieve a list of host IDs and names.

getScheduledDowntimePeriods

Fetches a list of all downtime periods scheduled for the specified host.

prepareHostHMWindows

Prepares Wormly to listen for health monitoring transmissions from the specified IP address.

setAlertMatrix

Creates / updates an Alert Group, specifying the matrix of alert recipients at each escalation level.

setContactChannelMute

Mutes or unmutes a contact channel

setDoNotDisturbPeriod

Create or update a Do Not Disturb period for the specified contact/channel.

setGlobalAlertMute

Enables or disables the global alert mute on your account

setScheduledDowntimePeriod

Create or update a scheduled downtime period for the specified host.