Response parameters

Authentication Response parameters

ParametersTypeDescription
userIdstringA string containing your user id.
accountIdstringA string containing your account id.
date_issueddictionarycontains sec and usec
date_issued > secintThe moment the api token was created
date_issued > usecintThe moment the api token was created
tokenNamestringThe name of your api token
tokenstringYour api token

Device Response parameters

ParametersTypeDescription
_idstringThe id of your device. This is used when Updating a device .
accountIdstringThe account to which the device belongs to.
agentKeystringThe key used by the agent. Can be used to View device by agent key
agentVersionstringThe version of the agent running on the device
cIdstringUsed when first creating a cloud device, not important after that.
cloudboolIs a cloud device.
createdAtstringWhen the device was created.
deletedboolIf the device is deleted.
groupstringThe group to which the device belongs to, default is null.
hostnamestringHostname of the server.
imageIdstringCloud Image ID from the cloud provider.
installedRamstringThe amount of ram as specified by the user.
ipstringThe IP address of the server.
isMonitoredbooleanAn internal check making sure each machine is being monitored.
isNewbooleanWhether the device is new or not.
lastPayLoadAtdictionaryThe id of your device.
lastPayLoadAt > secintNumbers of seconds according to Unix time.
lastPayLoadAt > usecintThis microseconds from that second where this was issued.
locationdictionaryA dictionary of location specifics.
location > countryCodestringAn international country code.
location > countryNamestringThe name of country.
location > textstringText name of the place in the country, London for instance.
namestringThe name of your device.
osdictionaryA dictionary of OS specifics.
os > codestringAn internal code for the OS.
os > namestringThe name of the OS.
pluginsEnabledJSON listA list of dictionaries containing which plugins the device is using.
privateIPsJSON listA list of the private IPs associated with the device.
providerstringThe provider associated with the device.
publicIPsJSON listA list of public IPs associated with the device.
swapSpacestringThe amount of swapspace as defined by the user.
CPUCoresstringThe amount of cores as specified by the user.
typestringWhether it is a device or a service.
updatedAtstringWhen the device was last updated.
userIdstringThe user associated with the device.
tagsJSON listA JSON list with the tag IDs.

Service Response Parameters

ParametersTypeDescription
_idstringThe id of your service.
currentStatusstringWhether the site is currently up and running or not.
bodystringHTTP Check - A body content string to send as part of the HTTP check.
namestringThe display name for the service.
slowThresholdintRequest time millisecond threshold after which service is deemed slow.
timeoutintHow many seconds the service waits until timing out. Max 30.
checkTypestringThe type of check: either http or tcp
checkUrlstringHTTP Check - The URL to issue the request to.
checkMethodstringHTTP Check - The HTTP method used to issue the check: either GET or POST.
checkLocationsjson listA JSON list of locations to check from e.g. ["lon", "dub"]. Each location has its own "API ID" which is noted on the locations list.
notesstringA box on the ui for the user to put details about the service.
groupstringThe group the service belongs to.
typestringWhether this is a service or a device.
updatedAtstringWhen this service was last updated
createdAtstringWhen this service was created
accountIdstringTo which account this service belongs to.
deletedstringWhether the device is deleted or not.
headersJSON listSpecific headers that you want to send with the HTTP request.
validateCertboolIf the service is HTTPS we validate the certificate and check whether it is valid or not.
tagsJSON listA JSON list with the tag IDs.

Alert Response Parameters

ParametersTypeDescription
idstringThe ID of the alert.
account_idstringThe account to which the alert belongs to.
comparisonstringThe comparison type for the alert, see table at Creating an alert.
createdAtdictWhen the alert was created in unix time and microseconds after that second.
deletedboolWhether the alert has been deleted.
enabledboolWhether the alert is enabled or not.
fixboolControls whether you get notifications when the alert is fixed.
fieldstringThe metric sub-section. Take a look at Listing device alert metrics & Listing service alert metrics for a full explanation.
fullFieldstringa combination of section and field.
groupstringTo which group the alert belongs to.
lastTriggeredAtdictWhen the alert was last triggered in unix time and microseconds after that second
locationsThresholdintOnly valid for services, the number of locations that are down for the alert to trigger.
openboolSet to true when an Alert is triggered.
sectionstringThe metric section. Take a look at Listing device alert metrics & Listing service alert metrics for a full explanation.
subjectstringIs the target you're measuring from, eg for disk usage it would be /dev for instance.
subjectIdstringThe ID of the subject.
subjectTypestringEither a device, service, service group or device group.
updatedAtstringWhen the alert was last updated.
validboolWhether all fields are filled in correctly for the alert.
valuestringThe value to trigger the alert based on the comparison.
waitdictJSON encoded object describing the amount of time to wait before first alert notification. See this section at Creating an alert
recipientsdictJSON encoded list of objects describing recipients and actions. See this section at Creating an alert
repeatdictJSON encoded object describing how often to repeat the alert notifications. See this section at Creating an alert

Overall (meta) Service Status Response Parameters

ParametersTypeDescription
currentStatusstringWhether the service is up or down
metricsdictionarya dictionary of status and time
metrics > statusfloatThe percentage of uptime for the service
metrics > timefloatThe average response time for the service.

Location Service Status Response Parameters

ParametersTypeDescription
_idstringThe ID of the service
rttfloatThis is the round trip time for the service in seconds.
accountIdstringThe account to which the service belongs to.
codeintHTTP status code for the website the service checks.
contentstringBody of the request that is being sent
createdAtstringTime when service was created
errorstringIf there was an error, what kind of error appears here.
headersdictionaryThe headers that the request sent to the service.
locationstringThe location from the request is being sent.
location_nodestringThe actual server from the request is being sent.
servicedictionaryContains all the details about the service check.
statusstringWhether the website is up or not at the last check.
successboolWhether the service succeeded in accessing website.
timefloatThis is the response time in seconds.
typestringType of request, either HTTP or TCP.
updatedAtstringWhen service was last updated.

Users Response Parameters

ParametersTypeDescription
adminboolAdmin user or not.
firstNamestringUser first name.
lastNamestringUser last name.
loginstringUsername for login
passwordstringPassword for login
emailAddressesJSON listJSON list of e-mail addresses.
phoneNumbersJSON listJSON list of phone numbers in international format with country code.
gravatarstringThe Gravatar that is tied to your email address.
updatedAtstringWhen the user was last updated
createdAtstringWhen the user was created
_idstringThe ID of the user
permissionsdictA dictionary that contains the key tags, tags itself is a dictionary that contains the tag IDs. Each tag ID is a dictionary with a key mode and value read

Dashboard Response Parameters

ParametersTypeDescription
namestringThe name of the dashboard.
accountIdstringThe account to which the dashboard belongs.
_idstringThe ID of the dashboard.
layoutdictDictionary with the ids of the widgets from this dashboard as keys. The values are objects with 3 values: col (column), row (row), size_x (size in the x axis, from 1 to 6)

Widget Response Parameters

ParametersTypeDescription
_idstringThe id of the widget
typestringThe type of graph.
dashboardIdstringThe dashboard to which the widget belongs
accountIdstringThe account to which the widget belongs
configdictConfiguration options, refer to the section of how to Configuring a widget to read more.

Tags Response Parameters

ParametersTypeDescription
_idstringThe ID of the tag.
namestringThe name of the tag.
colorstringThe color of the tag in hexcode.
updatedAtstringThe date when the tag was last updated.
createdAtstringThe date when the tag was created.
accountIdstringThe account to which the tag belongs.
deletedbooleanWhether the tag has been deleted or not.