Sign in

v1

latestOpenAPI 3.0.2GNU Free Documentation License2026-07-176924101.2 KB
Objects

Create new object

Creates a new object with the specified parameters

post/objects

Request body

objectTypeinteger required

Object type codes:

  • 1: SUBNET
  • 2: NODE
  • 3: INTERFACE
  • 4: NETWORK
  • 5: CONTAINER
  • 6: ZONE
  • 7: SERVICEROOT
  • 8: TEMPLATE
  • 9: TEMPLATEGROUP
  • 10: TEMPLATEROOT
  • 11: NETWORKSERVICE
  • 12: VPNCONNECTOR
  • 13: CONDITION
  • 14: CLUSTER
  • 15: BUSINESSSERVICEPROTOTYPE
  • 16: ASSET
  • 17: ASSETGROUP
  • 18: ASSETROOT
  • 19: NETWORKMAPROOT
  • 20: NETWORKMAPGROUP
  • 21: NETWORKMAP
  • 22: DASHBOARDROOT
  • 23: DASHBOARD
  • 24: DASHBOARDTEMPLATE
  • 27: BUSINESSSERVICEROOT
  • 28: BUSINESSSERVICE
  • 29: COLLECTOR
  • 30: CIRCUIT
  • 31: MOBILEDEVICE
  • 32: RACK
  • 33: ACCESSPOINT
  • 34: WIRELESSDOMAIN
  • 35: CHASSIS
  • 36: DASHBOARDGROUP
  • 37: SENSOR
  • 10000: CUSTOM
namestring required

Object name

parentIdinteger required

Parent object ID this object to be created under

commentsstring

Object comment

creationFlagsinteger

Bit flags for object creation:

  • 0x0001: DISABLE_ICMP
  • 0x0002: DISABLE_NXCP
  • 0x0004: DISABLE_SNMP
  • 0x0008: CREATE_UNMANAGED
  • 0x0010: ENTER_MAINTENANCE
  • 0x0020: AS_ZONE_PROXY
  • 0x0040: DISABLE_ETHERNET_IP
  • 0x0080: SNMP_SETTINGS_LOCKED
  • 0x0100: EXTERNAL_GATEWAY
  • 0x0200: DISABLE_SSH
  • 0x0400: DISABLE_MODBUS_TCP
  • 0x0800: DISABLE_VNC
primaryNamestring

Node primary name (IP address or DNS name)

agentPortinteger

Node agent port

snmpPortinteger

Node SNMP port

etherNetIpPortinteger

Node EtherNet/IP port

sshPortinteger

Node SSH port

ipAddressstring

Interface IP address

agentProxyIdinteger

Node agent proxy ID

snmpProxyIdinteger

Node SNMP proxy ID

etherNetIpProxyIdinteger

Node EtherNet/IP 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 type:

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

Network Service IP port

requeststring

Network Service request string

responsestring

Network Service expected response

linkedNodeIdinteger

Linked node ID for NodeLink object

templateboolean

If service check object is a template

macAddressstring

Interface or sensor MAC address

ifIndexinteger

Interface index

ifTypeinteger

Interface type

moduleinteger

Interface module number

portinteger

Interface port number

physicalPortboolean

Whether interface has a physical port

createStatusDciboolean

Whether a 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 SSH password

deviceClassinteger

Sensor device class

vendorstring

Sensor vendor

commProtocolinteger

Sensor communication protocol

xmlConfigstring

Sensor XML configuration

xmlRegConfigstring

Sensor XML registration configuration

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:

  • 1: IDM_AGENT_LIST
  • 2: IDM_AGENT_TABLE
  • 5: IDM_SCRIPT

Response

Object created successfully

idinteger

ID of the created object