...
| Field | Type | Description |
|---|---|---|
| description | String | Description of this Element. |
| groupId | Integer | ID for this ElementsElement's parent Element group. |
| hostname | String | Hostname used to contact this Element. |
| id | Integer | ID for this Element. |
| isMonitored | Boolean | Monitoring status for this Element. |
| monitors | Array | An array listing all monitors that belong to this Element (see Monitors Array below for details). |
| name | String | The display name of this Element. |
| tags | Array | An array listing all views/tags that this Element belongs to (see Tags Array below for details). |
| topologicalChildren | Array | An array listing all Elements that are a topological dependency of this Element in up.time (see Topological Children Array below for details). |
| topologicalParents | Array | An array listing all Elements that are topological parents of this Element in up.time (see Topological Parents Array below for details). |
| typeName | String | A basic type definition for the Element. The following types are supported:
|
| typeOs | String | Returns basic operating system information for this Element:
Elements of other types are not currently supported by the API. |
| typeSubtype | String | Basic type information for this Element. This value should be used for matching Elements based on subtype. The following subtypes are supported:
|
| typeSubtypeName | String | Detailed descriptions of the subtype, ideally used for display purposes. The values provided for this field are open to change and should not be used for matching purposes. |
...
| 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 uses, and can generally be ignored |
| isMonitored | Boolean | monitoring status for the service monitor |
| name | String | name of the service monitor |
...
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1010 | Element Filter Expired | 410 | The filter you are referencing has is expired. Created filters persist, by default, for 5 five minutes. |
| UT-1013 | Invalid Element Filter | 400 | The JSON used to create an Element filter is invalid, and could not be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1028 | URL ID Body Mismatch | 400 | The Element ID in the URL and the JSON object do not match. |
...
| Field | Type | Description |
|---|---|---|
| description | String | Description of this Element. |
| groupId | Integer | ID for this ElementsElement's parent Element group. |
| hostname | String | Hostname used to contact this Element. |
| id | Integer | ID for this Element. |
| isMonitored | Boolean | Monitoring status for this Element. |
| monitors | Array | An array listing all monitors that belong to this Element (see Monitors Array below for details). |
| name | String | The display name of this Element. |
| tags | Array | An array listing all views/tags that this Element belongs to (see Tags Array below for details). |
| topologicalChildren | Array | An array listing all Elements that are a topological dependency of this Element in up.time (see Topological Children Array below for details). |
| topologicalParents | Array | An array listing all Elements that are topological parents of this Element in up.time (see Topological Parents Array below for details). |
| typeName | String | A basic type definition for the Element. The following types are supported:
|
| typeOs | String | Returns basic operating system information for this Element:
Elements of other types are not currently supported by the API. |
| typeSubtype | String | Basic type information for this Element. This value should be used for matching Elements based on subtype. The following subtypes are supported:
|
| typeSubtypeName | String | Detailed descriptions of the subtype, ideally used for display purposes. The values provided for this field are open to change and should not be used for matching purposes. |
...
| 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 uses, and can generally be ignored |
| isMonitored | Boolean | monitoring status for the service monitor |
| name | String | name of the service monitor |
...
Other response codes that may occur include the following:
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1000 | Element Does Not Exist | 404 | A specifically referenced Element ID does not exist. In such a case, referencing
The Element ID endpoint may be omitted, was inputted incorrectly, or is ignored in up.time. |
| UT-1010 | Element Filter Expired | 410 | The filter you are referencing has is expired. Created filters persist, by default, for 5 five minutes. |
| UT-1012 | Element Group Filter Expired | 410 | The group filter you are referencing has is expired. Created filters persist, by default, for 5 five minutes. |
| UT-1013 | Invalid Element Filter | 400 | The JSON used to create an Element filter is invalid, and could not be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1015 | Invalid Element Group Filter | 400 | The JSON used to create an Element group filter is invalid, and could not be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1028 | URL ID Body Mismatch | 400 | The Element ID in the URL and the JSON object do not match. |
...
To determine the status of an Element's topological parent, refer to the Element listing's topologicalParents array. Consider the following example:
GET https://youruptime/api/v1/elements/42
The response indicates this Element's parent, RDBuilds, has an ID of 40:
...
Use the status task on the Element (in this case, ID=40) to retrieve its status:
GET https://youruptime/api/v1/elements/40/status
| Code Block |
|---|
{
"id": 40,
"isMonitored": true,
"lastCheckTime": "2015-01-15T09:07:45",
"lastTransitionTime": "2015-01-14T22:22:05",
"message": "",
"monitorStatus": [
{
"acknowledgedComment": null,
"elementId": 40,
"id": 133,
"isAcknowledged": false,
"isHidden": false,
"isHostCheck": false,
"isMonitored": true,
"lastCheckTime": "2015-01-15T09:08:58",
"lastTransitionTime": "2015-01-14T22:18:18",
"message": "up.time agent running on RDBuilds, up.time agent 5.3.0 (build 3) linux",
"name": "UPTIME-RDBbuilds",
"status": "OK"
},
{
"acknowledgedComment": null,
"elementId": 40,
"id": 135,
"isAcknowledged": false,
"isHidden": true,
"isHostCheck": false,
"isMonitored": true,
"lastCheckTime": "2015-01-15T09:08:25",
"lastTransitionTime": "2015-01-14T22:22:45",
"message": "Information received from Agent: up.time agent 5.3.0 (build 3) linux ",
"name": "Platform Performance Gatherer",
"status": "OK"
},
{
"acknowledgedComment": null,
"elementId": 40,
"id": 134,
"isAcknowledged": false,
"isHidden": false,
"isHostCheck": true,
"isMonitored": true,
"lastCheckTime": "2015-01-15T09:07:45",
"lastTransitionTime": "2015-01-14T22:22:05",
"message": "Ping completed: 5 sent, 0.0% loss, 0.4ms average round trip time",
"name": "PING-RDBuilds",
"status": "OK"
},
{
"acknowledgedComment": null,
"elementId": 40,
"id": 136,
"isAcknowledged": false,
"isHidden": true,
"isHostCheck": false,
"isMonitored": true,
"lastCheckTime": "2015-01-15T03:45:01",
"lastTransitionTime": "2015-01-15T03:45:01",
"message": "Information received from Agent: up.time agent 5.3.0 (build 3) linux ",
"name": "Configuration Update Gatherer",
"status": "OK"
}
],
"name": "RDBuilds",
"powerState": null,
"status": "OK",
"topologyParentStatus": []
} |
...
| 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 uses, and can generally be ignored |
| isMonitored | Boolean | monitoring status for the service monitor |
| name | String | name of the service monitor |
| message | String | the output message produced the last time the service monitor was executed |
| status | String | the 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; this field can be used to determine time in the current status |
...
| Info |
|---|
Note: This field has is deprecated. You should instead use the |
...
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| OK | 200 | Information retrieved successfully. | |
| UT-1000 | Element Does Not Exist | 404 | A specifically referenced Element ID does not exist. In such a case, referencing
The Element ID endpoint may be omitted, was inputted incorrectly, or is ignored in up.time. |
| UT-1010 | Element Filter Expired | 410 | The filter you are referencing has is expired. Created filters persist, by default, for 5 five minutes. |
| UT-1012 | Element Group Filter Expired | 410 | The group filter you are referencing has is expired. Created filters persist, by default, for 5 five minutes. |
| UT-1013 | Invalid Element Filter | 400 | The JSON used to create an Element filter is invalid, and could not be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1015 | Invalid Element Group Filter | 400 | The JSON used to create an Element group filter is invalid, and could not be parsed. Check to ensure you are posting well-formed JSON. |
| UT-1028 | URL ID Body Mismatch | 400 | The Element ID in the URL and the JSON object do not match. |
...
| Property | Description | Requirements |
|---|---|---|
| id | the id of the Element you want to update |
|
| name | display name for the Element anywhere in the up.time Web interface |
|
| description | description for the Element |
|
| hostname | resolvable network hostname or IP address of the Element |
|
| groupId | the Element Group to which the Element belongs to |
|
| isMonitored | enables and disables monitoring for the Element, determining whether it appears in Global Scan and other dashboards |
|
...
| Response Code | Code Description | HTTP Status Code | Details |
|---|---|---|---|
| UT-0200 | OK | 200 | Operation performed successfully. |
| UT-1000 | Element Does Not Exist | 404 | A specifically referenced Element ID does not exist. In such a case, referencing
The Element ID endpoint may be omitted, was inputted incorrectly, or is ignored in up.time. |
| UT-1002 | Element Group Does Not Exist | 400 | The referenced group ID does not exist. |
| UT-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
| UT-1028 | URL ID Body Mismatch | 400 | The Element ID in the URL and the JSON object do not match. |
| UT-1029 | Duplicate Hostname | 200 | Another Element (which you may not have permission to view) already exists with this hostname. |
| UT-1030 | Duplicate Element Name | 200 | Another Element (which you may not have permission to view) already exists with this display name. |
| UT-1033 | License Violation | 400 | Setting this Element to isMonitored exceeds the current license. |
| UT-1040 | Spaces in Hostname | n/a | The Element hostname cannot contain whitespace. |
| UT-1041 | Proxy Error | 400 | This error can occur when your deployment includes a UI instance. |
| UT-1042 | HMC Violation | 400 | This error can occur when updating a pSeries-based Element that uses the HMC. |
| UT-1043 | Missing Field | n/a (JSON validation) | One or more of the Element ID, name, or hostname is missing. |
| UT-1044 | Field Number out of Range | n/a | The declared Element group ID needs to be equal to or greater than 1. |
| UT-1045 | Field Too Long | n/a | One or more of the Element's name, description, or hostname exceed the maximum number of characters. |
...
DELETE https://youruptime/api/v1/elements/16