Developers API

createHost

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

Request Parameters

Parameter Data Type Description Required Default
name string A short name to help you identify this host in reports and alerts Required -
testinterval integer The Uptime Monitoring interval, expressed as the number of seconds between tests. This setting is used only for Uptime Monitoring, it is not used for Metrics collection. Optional 60
idempotent boolean Set to 1 to return any existing, identically named host, otherwise create a new host. Essentially this performs a "create host if it doesn't already exist" function. Optional 0

Response Data

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

Your API Key

API command to be called

Desired response format

A short name to help you identify this host in reports and alerts (string)

The Uptime Monitoring interval, expressed as the number of seconds between tests. This setting is used only for Uptime Monitoring, it is not used for Metrics collection. (integer, optional, default = 60)

Set to 1 to return any existing, identically named host, otherwise create a new host. Essentially this performs a "create host if it doesn't already exist" function. (boolean, optional, default = 0)