Page History

...

Property	Description	Requirements
name	display name for the Element anywhere in the Uptime Infrastructure Monitor Web interface	required property must be unique maximum 50 characters
description	optional description for the Element	maximum 255 characters
hostname	resolvable network hostname or IP address of the Element	required property must be unique maximum 255 characters contains no whitespace characters
groupId	the Element Group the Element is placed in upon creation	required property must match valid `groupId` end-user's user group is able to see the Element group
type	the basic Element type: Server Network Device	required property must match one of the basic Element types (in this case, `Server`)
collectionMethod	array of data-collection properties describing how Uptime Infrastructure Monitor communicates with the Element	required property
connectionType	the connection method for the Element: agent wmi snmp	required property must match one of the Element connection methods (in this case, `agent`)
useGlobalConnectionSettings	Boolean determining whether the Uptime Infrastructure Monitor Agent Global Configuration is enabled in Global Element Credentials Settings if `true`, all other connection properties are ignored	defaults to `false` if property is not defined
port	the port through which the Uptime Infrastructure Monitor Agent communicates with the Monitoring Station	required if useGlobalConnectionSettings property is `false` must be a valid port number (default 9998)
useSSL	Boolean indicating whether the Uptime Infrastructure Monitor Agent securely communicates with the Monitoring Station using SSL	required if useGlobalConnectionSettings property is `false` must be Boolean

...

Field Description Requirements

name

display name for the Element anywhere in the Uptime Infrastructure Monitor Web interface

required property
must be unique
maximum 50 characters

description

optional description for the Element

maximum 255 characters

hostname

resolvable network hostname or IP address of the Element

required property
must be unique
maximum 255 characters
contains no whitespace characters

groupId

the Element Group the Element is placed in upon creation

required property
must match valid groupId
end-user's user group is able to see the Element group

type

the basic Element type:

Server
Network Device

required property
must match one of the basic Element types (in this case, Server)

collectionMethod

array of data-collection properties describing how Uptime Infrastructure Monitor communicates with the Element

required property

connectionType

the connection method for the Element:

agent
wmi
snmp

required property
must match one of the Element connection methods (in this case, wmi)

useGlobalConnectionSettings

Boolean determining whether the Uptime Infrastructure Monitor Agent Global Configuration is enabled in Global Element Credentials Settings

if true, all other connection properties are ignored

defaults to false if property is not defined

wmiDomain

the Windows domain in which WMI is implemented

required if useGlobalConnectionSettings property is false

wmiUsername

the name of the account with access to WMI on the Windows domain

required if useGlobalConnectionSettings property is false

wmiPassword

the password for the username above

Info
the plain-text password is passed to Uptime Infrastructure Monitor using an encrypted connection

required if useGlobalConnectionSettings property is false

...

Field	Description	Requirements
name	display name for the Element anywhere in the Uptime Infrastructure Monitor Web interface	required property must be unique maximum 50 characters
description	optional description for the Element	maximum 255 characters
hostname	resolvable network hostname or IP address of the Element	required property must be unique maximum 255 characters contains no whitespace characters
groupId	the Element Group the Element is placed in upon creation	required property must match valid `groupId` end-user's user group is able to see the Element group
type	the basic Element type: Server Network Device	required property must match one of the basic Element types (in this case, `Server`)
collectionMethod	array of data-collection properties describing how Uptime Infrastructure Monitor communicates with the Element	required property
connectionType	the connection method for the Element: agent wmi snmp	required property must match one of the Element connection methods (in this case, `snmp`)
useGlobalConnectionSettings	Boolean determining whether Global SNMP Configuration Settings are set in Global Element Credentials Settings if `true`, all other connection properties are ignored	defaults to `false` if property is not defined
snmpVersion	the SNMP version used to connect to the network device: v2 v3	required if `useGlobalConnectionSettings` is `false` must match one of the valid SNMP versions (in this case, `v2`)
snmpPort	the port on which the device is listening	required if `useGlobalConnectionSettings` is `false` must be a valid port number (default `161`)
snmpV2ReadCommunity	the SNMP community to use for the connection, typically set to `public`	required if `useGlobalConnectionSettings` is `false`
isPingable	determines whether Uptime Infrastructure Monitor can contact the device using the ping utility	required if `useGlobalConnectionSettings` is `false` must be Boolean

...

Field Description Requirements

name

display name for the Element anywhere in the Uptime Infrastructure Monitor Web interface

required property
must be unique
maximum 50 characters

description

optional description for the Element

maximum 255 characters

hostname

resolvable network hostname or IP address of the Element

required property
must be unique
maximum 255 characters
contains no whitespace characters

groupId

the Element Group the Element is placed in upon creation

required property
must match valid groupId
end-user's user group is able to see the Element group

type

the basic Element type:

Server
Network Device

required property
must match one of the basic Element types (in this case, Server)

collectionMethod

array of data-collection properties describing how Uptime Infrastructure Monitor communicates with the Element

required property

connectionType

the connection method for the Element:

agent
wmi
snmp

required property
must match one of the Element connection methods (in this case, snmp)

useGlobalConnectionSettings

Boolean determining whether Global SNMP Configuration Settings are set in Global Element Credentials Settings

if true, all other connection properties are ignored

defaults to false if property is not defined

snmpVersion

the SNMP version used to connect to the network device:

v2
v3

required property
must match one of the valid SNMP versions (in this case, v3)

snmpPort

the port on which the device is listening

required if useGlobalConnectionSettings is false
must be a valid port number (default 161)

snmpV3Username

the name required to connect to the network device

required if useGlobalConnectionSettings is false

snmpV3AuthenticationPassword

the password required to connect to the network device

Info
the plain-text password is passed to Uptime Infrastructure Monitor using an encrypted connection

required if useGlobalConnectionSettings is false

snmpV3AuthenticationMethod

determines how encrypted data moving between the network device and Uptime Infrastructure Monitor is authenticated:

MD5
SHA

required if useGlobalConnectionSettings is false
must match one of the valid authentication methods

snmpV3PrivacyPassword

the password used to encrypt data moving between the network device and Uptime Infrastructure Monitor

Info
the plain-text password is passed to Uptime Infrastructure Monitor using an encrypted connection

required if useGlobalConnectionSettings is false

snmpV3PrivacyType

determines how data moving between the network device and Uptime Infrastructure Monitor is encrypted:

DES
AES

required if useGlobalConnectionSettings is false
must match one of the valid privacy types

isPingable

determines whether Uptime Infrastructure Monitor can contact the device using the ping utility

required if useGlobalConnectionSettings is false
must be Boolean

...

DELETE https://youruptime/api/v1/elements/16

Page tree

Versions Compared

Old Version 11

New Version 12

Key