...
Other response codes that may occur include the following:
Response Code | Code Description | HTTP Status Code | Details |
---|---|---|---|
OK | 200 | Information retrieved successfully. | |
UT-1010 | Element Filter Expired | 410 | The filter you are referencing is expired. Created filters persist, by default, for 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. |
...
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 is expired. Created filters persist, by default, for five minutes. |
UT-1012 | Element Group Filter Expired | 410 | The group filter you are referencing is expired. Created filters persist, by default, for 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. |
...
Other response codes that may occur include the following:
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. |
...
Property | Description | Requirements |
---|---|---|
name | display name for the Element anywhere in the up.time Web interface |
|
description | optional description for the Element |
|
hostname | resolvable network hostname or IP address of the Element |
|
groupId | the Element Group the Element is placed in upon creation |
|
type | the basic Element type:
|
|
collectionMethod | array of data-collection properties describing how up.time communicates with the Element |
|
connectionType | the connection method for the Element:
|
|
useGlobalConnectionSettings | Boolean determining whether the up.time Agent Global Configuration is enabled in Global Element Settings if |
|
port | the port through which the up.time Agent communicates with the Monitoring Station |
|
useSSL | Boolean indicating whether the up.time Agent securely communicates with the Monitoring Station using SSL |
|
...
Other response codes that may occur include the following:
Error Code | Error | HTTP Code | Details |
---|---|---|---|
OK | 200 | Operation performed successfully. | |
UT-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
UT-1029 | Duplicate Hostname | 400 | Another Element (which you may not have permission to view) already exists with this hostname. |
UT-1030 | Duplicate Element Name | 400 | Another Element (which you may not have permission to view) already exists with this display name. |
UT-1033 | License Violation | 400 | Adding this Element exceeds the current license. |
UT-1035 | Add Element Error | 400 | An exception occurred when trying to add the Element. Verify the Element details, such as hostname, are correct. |
UT-1037 | Duplicate VMware UUID | 400 | The Element added already exists as part of the VMware vCenter inventory. |
UT-1040 | Spaces in Hostname | n/a | The Element hostname cannot contain whitespace. |
UT-1043 | Missing Field | n/a (JSON validation) | One or more of the Element ID, name, hostname, or group ID 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. |
...
Field | Description | Requirements | ||
---|---|---|---|---|
name | display name for the Element anywhere in the up.time Web interface |
| ||
description | optional description for the Element |
| ||
hostname | resolvable network hostname or IP address of the Element |
| ||
groupId | the Element Group the Element is placed in upon creation |
| ||
type | the basic Element type:
|
| ||
collectionMethod | array of data-collection properties describing how up.time communicates with the Element |
| ||
connectionType | the connection method for the Element:
|
| ||
useGlobalConnectionSettings | Boolean determining whether the up.time Agent Global Configuration is enabled in Global Element Settings if |
| ||
wmiDomain | the Windows domain in which WMI is implemented |
| ||
wmiUsername | the name of the account with access to WMI on the Windows domain |
| ||
wmiPassword | the password for the username above
|
|
...
Other response codes that may occur include the following:
Error Code | Error | HTTP Code | Details |
---|---|---|---|
OK | 200 | Operation performed successfully. | |
UT-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
UT-1029 | Duplicate Hostname | 400 | Another Element (which you may not have permission to view) already exists with this hostname. |
UT-1030 | Duplicate Element Name | 400 | Another Element (which you may not have permission to view) already exists with this display name. |
UT-1033 | License Violation | 400 | Adding this Element exceeds the current license. |
UT-1035 | Add Element Error | 400 | An exception occurred when trying to add the Element. Verify the Element details, such as hostname, are correct. |
UT-1037 | Duplicate VMware UUID | 400 | The Element added already exists as part of the VMware vCenter inventory. |
UT-1040 | Spaces in Hostname | n/a | The Element hostname cannot contain whitespace. |
UT-1043 | Missing Field | n/a (JSON validation) | One or more of the Element ID, name, hostname, or group ID 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. |
UT-1034 | WMI Not Supported | 400 | You are most likely trying to add a WMI-based Element to a non-Windows host. |
...
Field | Description | Requirements |
---|---|---|
name | display name for the Element anywhere in the up.time Web interface |
|
description | optional description for the Element |
|
hostname | resolvable network hostname or IP address of the Element |
|
groupId | the Element Group the Element is placed in upon creation |
|
type | the basic Element type:
|
|
collectionMethod | array of data-collection properties describing how up.time communicates with the Element |
|
connectionType | the connection method for the Element:
|
|
useGlobalConnectionSettings | Boolean determining whether Global SNMP Configuration Settings are set in Global Element Settings if |
|
snmpVersion | the SNMP version used to connect to the network device:
|
|
snmpPort | the port on which the device is listening |
|
snmpV2ReadCommunity | the SNMP community to use for the connection, typically set to public |
|
isPingable | determines whether up.time can contact the device using the ping utility |
|
...
Other response codes that may occur include the following:
Error Code | Error | HTTP Code | Details |
---|---|---|---|
OK | 200 | Operation performed successfully. | |
UT-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
UT-1029 | Duplicate Hostname | 400 | Another Element (which you may not have permission to view) already exists with this hostname. |
UT-1030 | Duplicate Element Name | 400 | Another Element (which you may not have permission to view) already exists with this display name. |
UT-1033 | License Violation | 400 | Adding this Element exceeds the current license. |
UT-1035 | Add Element Error | 400 | An exception occurred when trying to add the Element. Verify the Element details, such as hostname, are correct. |
UT-1040 | Spaces in Hostname | n/a | The Element hostname cannot contain whitespace. |
UT-1043 | Missing Field | n/a (JSON validation) | One or more of the Element ID, name, hostname, or group ID 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. |
...
Field | Description | Requirements | ||
---|---|---|---|---|
name | display name for the Element anywhere in the up.time Web interface |
| ||
description | optional description for the Element |
| ||
hostname | resolvable network hostname or IP address of the Element |
| ||
groupId | the Element Group the Element is placed in upon creation |
| ||
type | the basic Element type:
|
| ||
collectionMethod | array of data-collection properties describing how up.time communicates with the Element |
| ||
connectionType | the connection method for the Element:
|
| ||
useGlobalConnectionSettings | Boolean determining whether Global SNMP Configuration Settings are set in Global Element Settings if |
| ||
snmpVersion | the SNMP version used to connect to the network device:
|
| ||
snmpPort | the port on which the device is listening |
| ||
snmpV3Username | the name required to connect to the network device |
| ||
snmpV3AuthenticationPassword | the password required to connect to the network device
|
| ||
snmpV3AuthenticationMethod | determines how encrypted data moving between the network device and up.time is authenticated:
|
| ||
snmpV3PrivacyPassword | the password used to encrypt data moving between the network device and up.time
|
| ||
snmpV3PrivacyType | determines how data moving between the network device and up.time is encrypted:
|
| ||
isPingable | determines whether up.time can contact the device using the ping utility |
|
...
Other response codes that may occur include the following:
Error Code | Error | HTTP Code | Details |
---|---|---|---|
OK | 200 | Operation performed successfully. | |
UT-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
UT-1029 | Duplicate Hostname | 400 | Another Element (which you may not have permission to view) already exists with this hostname. |
UT-1030 | Duplicate Element Name | 400 | Another Element (which you may not have permission to view) already exists with this display name. |
UT-1033 | License Violation | 400 | Adding this Element exceeds the current license. |
UT-1035 | Add Element Error | 400 | An exception occurred when trying to add the Element. Verify the Element details, such as hostname, are correct. |
UT-1040 | Spaces in Hostname | n/a | The Element hostname cannot contain whitespace. |
UT-1043 | Missing Field | n/a (JSON validation) | One or more of the Element ID, name, hostname, or group ID 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. |
...
Other response codes that may occur include the following:
Response Code | Code Description | HTTP Status Code | Details |
---|---|---|---|
No Content | 204 | 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-1025 | Invalid Request Body JSON | 400 | The JSON object is not well formed. |
UT-1026 | VM Not Deleted | 403 | VMs and ESX hosts that are ignored cannot be deleted. |
UT-1027 | Element Not Deleted | 403 | You are trying to delete an ESX host that is part of a cluster. |
UT-1032 | Manual Monitor Not Deleted | 403 | Manually monitored hosts cannot be deleted. |
...
DELETE https://youruptime/api/v1/elements/16