Objects

Create object

Request to create new object

post/objects

Request body

objectTypeinteger

Possible options:

* SUBNET: 1
* NODE: 2
* INTERFACE: 3
* NETWORK: 4
* CONTAINER: 5
* ZONE: 6
* SERVICEROOT: 7
* TEMPLATE: 8
* TEMPLATEGROUP: 9
* TEMPLATEROOT: 10
* NETWORKSERVICE: 11
* VPNCONNECTOR: 12
* CONDITION: 13
* CLUSTER: 14
* OBJECT_BUSINESSSERVICE_PROTOTYPE: 15
* NETWORKMAPROOT: 19
* NETWORKMAPGROUP: 20
* NETWORKMAP: 21
* DASHBOARDROOT: 22
* DASHBOARD: 23
* BUSINESSSERVICEROOT: 27
* BUSINESSSERVICE: 28
* NODELINK: 29
* SLMCHECK: 30
* MOBILEDEVICE: 31
* RACK: 32
* ACCESSPOINT: 33
* CHASSIS: 35
* DASHBOARDGROUP: 36
* SENSOR: 37  
namestring

Object name

parentIdinteger

Parent object id this object to be created under

commentsstring

Object comment

creationFlagsinteger

Bit flags for object creation. Possible options:

* DISABLE ICMP: 0x0001
* DISABLE NXCP: 0x0002
* DISABLE SNMP: 0x0004
* CREATE UNMANAGED: 0x0008
* ENTER MAINTENANCE: 0x0010
* AS ZONE PROXY: 0x0020
* DISABLE ETHERNET IP: 0x0040
* SNMP SETTINGS LOCKED: 0x0080
* EXTERNAL GATEWAY: 0x0100
primaryNamestring

Node primary name (IP address or dns name)

agentPortinteger

Node agent port

snmpPortinteger

Node SNMP port

etherNetIpPortinteger

Node ethernetIP port

sshPortinteger

Node ssh port

ipAddressstring

Network service IP address

agentProxyIdinteger

Node agent proxy id

snmpProxyIdinteger

Node SNMP proxy id

etherNetIpProxyIdinteger

Node ethernetIP proxy id

icmpProxyIdinteger

Node ICMP proxy id

sshProxyIdinteger

Node ssh proxy id

mapTypeinteger

Network map type

seedObjectIdsinteger[]

Network map seed objects

zoneUINinteger

Subnet/Node/Zone zone UIN

serviceTypeinteger

Network service types:

* CUSTOM - 0
* SSH - 1
* POP3 - 2
* SMTP - 3
* FTP - 4
* HTTP - 5
* HTTPS - 6
* TELNET - 7
ipPortinteger

Network Service IP port

requeststring

Network service IP request

responsestring

Network service IP response

linkedNodeIdinteger

Linked object for Node Link object

templateboolean

If service check object is template

macAddressstring

Sensor mac address

ifIndexinteger

Interface index

ifTypeinteger

Interface type

moduleinteger

Interface module number

portinteger

Interface port

physicalPortboolean

IF interface has physical port

createStatusDciboolean

IF status DCI should be created for network service

deviceIdstring

Mobile device ID

heightinteger

Rack height

controllerIdinteger

Chassis controller node id

sshLoginstring

Node ssh login

sshPasswordstring

Node password

deviceClassinteger

Sensor device class

vendorstring

Sensor vendor

commProtocolinteger

Sensor communication protocol

xmlConfigstring

Sensor XML config

xmlRegConfigstring

Sensor XML registration config

serialNumberstring

Sensor serial number

deviceAddressstring

Sensor device address

metaTypestring

Sensor meta type

descriptionstring

Sensor description

sensorProxyinteger

Sensor proxy node id

instanceDiscoveryMethodinteger

Business service instance discovery method
Possible values:

* IDM_AGENT_LIST - 1
* IDM_AGENT_TABLE - 2
* IDM_SCRIPT - 5
aliasstring
nameOnMapstring
inheritAccessRightsboolean

acl should be provided in the same request

autoBindFilterstring
versioninteger
agentSecretstring
agentProxyinteger
snmpVersionstring

Node SNMP version:

* V1
* V2C
* V3
* DEFAULT
snmpAuthMethodinteger

snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpPrivMethod should be provided in the same request

snmpPrivMethodinteger

snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpAuthMethod should be provided in the same request

snmpAuthNamestring

snmpAuthPassword, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request

snmpAuthPasswordstring

snmpAuthName, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request

snmpPrivPasswordstring

snmpAuthName, snmpAuthPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request

snmpProxyinteger
icmpProxyinteger
trustedNodesinteger[]
mapBackgroundstring

UUID.

mapBackgroundLocation, mapBackgroundLocation, mapBackgroundZoom, mapBackgroundColor should be provided in the same request.

mapBackgroundZoominteger

mapBackground, mapBackgroundLocation, mapBackgroundLocation, mapBackgroundColor should be provided in the same request.

mapBackgroundColorinteger

mapBackground, mapBackgroundLocation, mapBackgroundLocation, mapBackgroundZoom should be provided in the same request.

mapImagestring

UUID

columnCountinteger
scriptstring
activationEventinteger
deactivationEventinteger
sourceObjectinteger
activeStatusinteger
inactiveStatusinteger
drillDownObjectIdinteger
pollerNodeinteger
requiredPollsinteger
ipProtocolinteger
objectFlagsinteger

Object flags specific for each object. Possible values can be found in NXSL documentation under each object. (Example: Node flags https://www.netxms.org/documentation/nxsl-latest/#_constants_6)

objectFlagsMask should be provided in the same request.

objectFlagsMaskinteger

Bitmask that defines which bits in objectFlags will have effect. objectFlags should be provided in the same request.

ifXTablePolicyinteger
reportDefinitionstring
networkListstring[]

IP address list

statusCalculationMethodinteger
statusPropagationMethodinteger
fixedPropagatedStatusstring

Object status:

* NORMAL
* WARNING
* MINOR
* MAJOR
* CRITICAL
* UNKNOWN
* UNMANAGED
* DISABLED
* TESTING
statusShiftinteger
statusSingleThresholdinteger
statusThresholdsinteger[]
expectedStateinteger
linkColorinteger
connectionRoutinginteger
discoveryRadiusinteger
filterstring
peerGatewayIdinteger
localNetworksstring[]

VPN networks IP address. remoteNetworks should be provided in the same request.

remoteNetworksstring[]

VPN networks IP address. localNetworks should be provided in the same request.

agentCacheModestring

Possible values:

* DEFAULT
* ON
* OFF
agentCompressionModestring

Possible values:

* DEFAULT
* ENABLED
* DISABLED
mapObjectDisplayModestring

Possible values:

* ICON
* SMALL_LABEL
* LARGE_LABEL
* STATUS
* FLOOR_PLAN
physicalContainerObjectIdinteger
rackImageFrontstring

UUID.

rackImageRear, rackPosition, rackHeight, rackOrientation should be provided in the same request.

rackImageRearstring

UUID.

rackImageFront, rackPosition, rackHeight, rackOrientation should be provided in the same request.

rackPositioninteger

rackImageFront, rackImageRear, rackHeight, rackOrientation should be provided in the same request.

rackHeightinteger

rackImageFront, rackImageRear, rackPosition, rackOrientation should be provided in the same request.

rackOrientationstring

Possible values:

* FILL
* FRONT
* REAR

rackImageFront, rackImageRear, rackPosition, rackHeight should be provided in the same request.

dashboardsinteger[]
rackNumberingTopBottomboolean
chassisIdinteger
sshProxyinteger
sshKeyIdinteger
zoneProxiesinteger[]
urlsstring[]

Object Urls

snmpPortsstring[]
responsibleUsersinteger[]
icmpStatCollectionModestring

Possible values:

* DEFAULT
* ON
* OFF
icmpTargetsstring[]

ICMP ping targets IP addresses

chassisPlacementstring
etherNetIPPortinteger
etherNetIPProxyinteger
certificateMappingMethodstring

Possible values:

* SUBJECT
* PUBLIC_KEY
* COMMON_NAME
* TEMPLATE_ID

certificateMappingData should be provided in the same request.

certificateMappingDatastring

certificateMappingMethod should be provided in the same request.

categoryIdinteger
{"stackTrail":"components:schemas:objectCreationAndModification:allOf:properties:geoLocationControlMode","oasType":"schema","type":"unknown","description":"GeoLocationControlMode\nPossible values:\n \n * NO_CONTROL\n * RESTRICTED_AREAS\n * ALLOWED_AREAS\n"}
geoAreasinteger[]
instanceDiscoveryDatastring

Business service instance discovery data

instanceDiscoveryFilterstring

Business service instance discovery data filtering script

autoBindFilter2integer

Second binding script used for DCI binding. Currently used in business service

autoBindFlagsinteger

Auto bind bit flags
First script is currently used for object bind/unbind, second for dci bind/unbind. Possible values:

* First script for auto bind is enabled - 0x0001
* First script for auto unbind is enabled - 0x0002
* Second script for auto bind is enabled - 0x0004
* Second script for auto unbind is enabled - 0x0008
objectStatusThresholdinteger

Business service default threshold for auto created object checks
Possible values:

* Default - 0
* Warning - 1 
* Minor - 2 
* Major - 3 
* Critical - 4 
dciStatusThresholdinteger

Business service default threshold for auto created DCI checks
Possible values:

* Default - 0
* Warning - 1 
* Minor - 2 
* Major - 3 
* Critical - 4 
sourceNodeinteger

Id of source node for business service instance discovery methods

Response

New object ID.

object required

Changes