...
Section | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
...
Field | Type | Description |
---|---|---|
elementId | Integer | ID of the Element this child service monitor is related to; can be null for unassigned monitors |
id | Integer | ID for the child service monitor |
isHidden | Boolean | hidden monitors are internal monitors that up.time Uptime Infrastructure Monitor uses, and can generally be ignored |
isMonitored | Boolean | monitoring status for the child service monitor |
name | String | name of the child service monitor |
...
Code Block |
---|
[
{
"description": "Collects basic performance data",
"elements":
[
{
"id": 1,
"isMonitored": true,
"name": "win-dleith"
},
{
"id": 2,
"isMonitored": true,
"name": "rd-vc2"
}
],
"groupId": null,
"id": 1,
"monitors":
[
{
"elementId": 1,
"id": 2,
"isHidden": false,
"isMonitored": true,
"name": "PING-localhost"
},
...
],
"name": "My Infrastructure",
},
{
"description": "",
"elements":
[
...
],
"groupId": 1,
"id": 2,
"monitors":
[
...
],
"name": "Discovered Virtual Machines",
},
{
"description": "",
"elements":
[
...
],
"groupId": 1,
"id": 3,
"monitors":
[
...
],
"name": "Discovered Hosts",
},
...
] |
...
Field | Type | Description |
---|---|---|
elementId | Integer | ID of the Element this child service monitor is related to; can be null for unassigned monitors |
id | Integer | ID for the child service monitor |
isHidden | Boolean | hidden monitors are internal monitors that up.time Uptime Infrastructure Monitor uses, and can generally be ignored |
isMonitored | Boolean | monitoring status for the child service monitor |
name | String | name of the child service monitor |
...
Code Block |
---|
[
{
"description": "Collects basic performance data",
"elements":
[
{
"id": 1,
"isMonitored": true,
"name": "win-dleith"
},
{
"id": 2,
"isMonitored": true,
"name": "rd-vc2"
}
],
"groupId": null,
"id": 1,
"monitors":
[
{
"elementId": 1,
"id": 2,
"isHidden": false,
"isMonitored": true,
"name": "PING-localhost"
},
...
],
"name": "My Infrastructure",
},
{
"description": "",
"elements":
[
...
],
"groupId": 1,
"id": 2,
"monitors":
[
...
],
"name": "Discovered Virtual Machines",
},
{
"description": "",
"elements":
[
...
],
"groupId": 1,
"id": 3,
"monitors":
[
...
],
"name": "Discovered Hosts",
},
...
] |
...
Field | Type | Description |
---|---|---|
elementId | Integer | ID of the Element this monitor is related to |
id | Integer | ID of the service monitor |
isHidden | Boolean | hidden monitors are internal monitors that up.time Uptime Infrastructure Monitor uses, and can generally be ignored |
isHostCheck | Boolean | returns true if this service monitor is the host check for its parent Element |
isMonitored | Boolean | monitoring status for the service monitor |
name | String | name of the service monitor |
message | String | output message produced the last time the service monitor was executed |
status | String | last known status of this service monitor |
lastCheckTime | String - Date Time | the last time this service monitor was executed successfully |
lastTransitionTime | String - Date Time | the last time this service monitor changed status, which can be used to determine time at its current status |
...
Retrieve status for Element group ID 1 (by default, the My Infrastructure group):
GET https://youruptime/api/v1/groups/1/status
Code Block |
---|
{ "elementStatus": [ { "id": 1, "isMonitored": true, "lastCheckTime": "20122016-09-17T14:14:17", "lastTransitionTime": "20122016-09-13T11:34:24", "message": "", "name": "win-dleith", "powerState": "On", "status": "OK" }, ... ] "id": 1, "monitorStatus": [ { "elementId": 1, "id": 7, "isHidden": false, "isHostCheck": false, "isMonitored": true, "lastCheckTime": "20122016-09-17T14:13:56", "lastTransitionTime": "20122016-09-17T14:05:56", "message": "", "name": "Default File System Capacity", "status": "UNKNOWN" }, ... ] "name": "My Infrastructure", "topologyParentStatus": [ { "id": 2, "isMonitored": true, "lastCheckTime": "20122016-09-17T14:14:17", "lastTransitionTime": "20122016-09-13T11:34:24", "message": "", "name": "rd-vc2", "powerState": null, "status": "OK" }, ... ] } |