Response parameters
Authentication Response parameters
| Parameters | Type | Description |
|---|---|---|
| userId | string | A string containing your user id. |
| accountId | string | A string containing your account id. |
| date_issued | dictionary | contains sec and usec |
| date_issued > sec | int | The moment the api token was created |
| date_issued > usec | int | The moment the api token was created |
| tokenName | string | The name of your api token |
| token | string | Your api token |
Device Response parameters
| Parameters | Type | Description |
|---|---|---|
| _id | string | The id of your device. This is used when Updating a device . |
| accountId | string | The account to which the device belongs to. |
| agentKey | string | The key used by the agent. Can be used to View device by agent key |
| agentVersion | string | The version of the agent running on the device |
| cId | string | Used when first creating a cloud device, not important after that. |
| cloud | bool | Is a cloud device. |
| createdAt | string | When the device was created. |
| deleted | bool | If the device is deleted. |
| group | string | The group to which the device belongs to, default is null. |
| hostname | string | Hostname of the server. |
| imageId | string | Cloud Image ID from the cloud provider. |
| installedRam | string | The amount of ram as specified by the user. |
| ip | string | The IP address of the server. |
| isMonitored | boolean | An internal check making sure each machine is being monitored. |
| isNew | boolean | Whether the device is new or not. |
| lastPayLoadAt | dictionary | The id of your device. |
| lastPayLoadAt > sec | int | Numbers of seconds according to Unix time. |
| lastPayLoadAt > usec | int | This microseconds from that second where this was issued. |
| location | dictionary | A dictionary of location specifics. |
| location > countryCode | string | An international country code. |
| location > countryName | string | The name of country. |
| location > text | string | Text name of the place in the country, London for instance. |
| name | string | The name of your device. |
| os | dictionary | A dictionary of OS specifics. |
| os > code | string | An internal code for the OS. |
| os > name | string | The name of the OS. |
| pluginsEnabled | JSON list | A list of dictionaries containing which plugins the device is using. |
| privateIPs | JSON list | A list of the private IPs associated with the device. |
| provider | string | The provider associated with the device. |
| publicIPs | JSON list | A list of public IPs associated with the device. |
| swapSpace | string | The amount of swapspace as defined by the user. |
| CPUCores | string | The amount of cores as specified by the user. |
| type | string | Whether it is a device or a service. |
| updatedAt | string | When the device was last updated. |
| userId | string | The user associated with the device. |
| tags | JSON list | A JSON list with the tag IDs. |
Service Response Parameters
| Parameters | Type | Description |
|---|---|---|
| _id | string | The id of your service. |
| currentStatus | string | Whether the site is currently up and running or not. |
| body | string | HTTP Check - A body content string to send as part of the HTTP check. |
| name | string | The display name for the service. |
| slowThreshold | int | Request time millisecond threshold after which service is deemed slow. |
| timeout | int | How many seconds the service waits until timing out. Max 30. |
| checkType | string | The type of check: either http or tcp |
| checkUrl | string | HTTP Check - The URL to issue the request to. |
| checkMethod | string | HTTP Check - The HTTP method used to issue the check: either GET or POST. |
| checkLocations | json list | A 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. |
| notes | string | A box on the ui for the user to put details about the service. |
| group | string | The group the service belongs to. |
| type | string | Whether this is a service or a device. |
| updatedAt | string | When this service was last updated |
| createdAt | string | When this service was created |
| accountId | string | To which account this service belongs to. |
| deleted | string | Whether the device is deleted or not. |
| headers | JSON list | Specific headers that you want to send with the HTTP request. |
| validateCert | bool | If the service is HTTPS we validate the certificate and check whether it is valid or not. |
| tags | JSON list | A JSON list with the tag IDs. |
Alert Response Parameters
| Parameters | Type | Description |
|---|---|---|
| id | string | The ID of the alert. |
| account_id | string | The account to which the alert belongs to. |
| comparison | string | The comparison type for the alert, see table at Creating an alert. |
| createdAt | dict | When the alert was created in unix time and microseconds after that second. |
| deleted | bool | Whether the alert has been deleted. |
| enabled | bool | Whether the alert is enabled or not. |
| fix | bool | Controls whether you get notifications when the alert is fixed. |
| field | string | The metric sub-section. Take a look at Listing device alert metrics & Listing service alert metrics for a full explanation. |
| fullField | string | a combination of section and field. |
| group | string | To which group the alert belongs to. |
| lastTriggeredAt | dict | When the alert was last triggered in unix time and microseconds after that second |
| locationsThreshold | int | Only valid for services, the number of locations that are down for the alert to trigger. |
| open | bool | Set to true when an Alert is triggered. |
| section | string | The metric section. Take a look at Listing device alert metrics & Listing service alert metrics for a full explanation. |
| subject | string | Is the target you're measuring from, eg for disk usage it would be /dev for instance. |
| subjectId | string | The ID of the subject. |
| subjectType | string | Either a device, service, service group or device group. |
| updatedAt | string | When the alert was last updated. |
| valid | bool | Whether all fields are filled in correctly for the alert. |
| value | string | The value to trigger the alert based on the comparison. |
| wait | dict | JSON encoded object describing the amount of time to wait before first alert notification. See this section at Creating an alert |
| recipients | dict | JSON encoded list of objects describing recipients and actions. See this section at Creating an alert |
| repeat | dict | JSON encoded object describing how often to repeat the alert notifications. See this section at Creating an alert |
Overall (meta) Service Status Response Parameters
| Parameters | Type | Description |
|---|---|---|
| currentStatus | string | Whether the service is up or down |
| metrics | dictionary | a dictionary of status and time |
| metrics > status | float | The percentage of uptime for the service |
| metrics > time | float | The average response time for the service. |
Location Service Status Response Parameters
| Parameters | Type | Description |
|---|---|---|
| _id | string | The ID of the service |
| rtt | float | This is the round trip time for the service in seconds. |
| accountId | string | The account to which the service belongs to. |
| code | int | HTTP status code for the website the service checks. |
| content | string | Body of the request that is being sent |
| createdAt | string | Time when service was created |
| error | string | If there was an error, what kind of error appears here. |
| headers | dictionary | The headers that the request sent to the service. |
| location | string | The location from the request is being sent. |
| location_node | string | The actual server from the request is being sent. |
| service | dictionary | Contains all the details about the service check. |
| status | string | Whether the website is up or not at the last check. |
| success | bool | Whether the service succeeded in accessing website. |
| time | float | This is the response time in seconds. |
| type | string | Type of request, either HTTP or TCP. |
| updatedAt | string | When service was last updated. |
Users Response Parameters
| Parameters | Type | Description |
|---|---|---|
| admin | bool | Admin user or not. |
| firstName | string | User first name. |
| lastName | string | User last name. |
| login | string | Username for login |
| password | string | Password for login |
| emailAddresses | JSON list | JSON list of e-mail addresses. |
| phoneNumbers | JSON list | JSON list of phone numbers in international format with country code. |
| gravatar | string | The Gravatar that is tied to your email address. |
| updatedAt | string | When the user was last updated |
| createdAt | string | When the user was created |
| _id | string | The ID of the user |
| permissions | dict | A 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
| Parameters | Type | Description |
|---|---|---|
| name | string | The name of the dashboard. |
| accountId | string | The account to which the dashboard belongs. |
| _id | string | The ID of the dashboard. |
| layout | dict | Dictionary 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
| Parameters | Type | Description |
|---|---|---|
| _id | string | The id of the widget |
| type | string | The type of graph. |
| dashboardId | string | The dashboard to which the widget belongs |
| accountId | string | The account to which the widget belongs |
| config | dict | Configuration options, refer to the section of how to Configuring a widget to read more. |
Tags Response Parameters
| Parameters | Type | Description |
|---|---|---|
| _id | string | The ID of the tag. |
| name | string | The name of the tag. |
| color | string | The color of the tag in hexcode. |
| updatedAt | string | The date when the tag was last updated. |
| createdAt | string | The date when the tag was created. |
| accountId | string | The account to which the tag belongs. |
| deleted | boolean | Whether the tag has been deleted or not. |
Updated over 5 years ago