Sign in

v1

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

Update object

Updates object properties. Only provided fields are updated. Array fields are replaced entirely (not merged).

put/objects/{object-id}

Path parameters

object-idstring required

Object ID or GUID

Request body

namestring
primaryNamestring
aliasstring
nameOnMapstring
inheritAccessRightsboolean

acl should be provided in the same request

customAttributesobject

Object name is custom attribute name. All custom attributes must be included; attributes not in JSON will be deleted.

autoBindFilterstring
versioninteger
descriptionstring
agentPortinteger
agentSecretstring
agentProxyinteger
snmpPortinteger
snmpVersion'V1' | 'V2C' | 'V3' | 'DEFAULT'

Node SNMP version

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, mapBackgroundZoom, mapBackgroundColor should be provided in the same request

mapBackgroundZoominteger

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

mapBackgroundColorinteger

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

mapImagestring uuid
columnCountinteger
scriptstring
activationEventinteger
deactivationEventinteger
sourceObjectinteger
activeStatusinteger
inactiveStatusinteger
drillDownObjectIdinteger
pollerNodeinteger
requiredPollsinteger
serviceTypeinteger
ipProtocolinteger
ipPortinteger
ipAddressstring

Network service IP address

requeststring

Network service request string

responsestring

Network service expected response

objectFlagsinteger

Object flags specific for each object type. objectFlagsMask should be provided in the same request. Possible values can be found in NXSL documentation under each object.

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
fixedPropagatedStatus'NORMAL' | 'WARNING' | 'MINOR' | 'MAJOR' | 'CRITICAL' | 'UNKNOWN' | 'UNMANAGED' | 'DISABLED' | 'TESTING'

Object status for fixed propagation

statusShiftinteger
statusTransformationstring[]

Object status mapping list

statusSingleThresholdinteger
statusThresholdsinteger[]
expectedStateinteger
linkColorinteger
connectionRoutinginteger
discoveryRadiusinteger
heightinteger
filterstring
peerGatewayIdinteger
localNetworksstring[]

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

remoteNetworksstring[]

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

agentCacheMode'DEFAULT' | 'ON' | 'OFF'
agentCompressionMode'DEFAULT' | 'ENABLED' | 'DISABLED'
mapObjectDisplayMode'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

rackOrientation'FILL' | 'FRONT' | 'REAR'

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

dashboardsinteger[]
rackNumberingTopBottomboolean
controllerIdinteger
chassisIdinteger
sshProxyinteger
sshLoginstring
sshPasswordstring
sshPortinteger
sshKeyIdinteger
zoneProxiesinteger[]
urlsobject[]
seedObjectIdsinteger[]
macAddressstring

Sensor MAC address

deviceClassinteger
vendorstring
serialNumberstring
deviceAddressstring
metaTypestring
sensorProxyinteger
xmlConfigstring
snmpPortsstring[]
responsibleUsersinteger[]
icmpStatCollectionMode'DEFAULT' | 'ON' | 'OFF'
icmpTargetsstring[]

ICMP ping target IP addresses

chassisPlacementstring
etherNetIPPortinteger
etherNetIPProxyinteger
certificateMappingMethod'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
geoLocationControlMode'NO_CONTROL' | 'RESTRICTED_AREAS' | 'ALLOWED_AREAS'
geoAreasinteger[]
instanceDiscoveryMethodinteger

Business service instance discovery method:

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

Business service instance discovery data

instanceDiscoveryFilterstring

Business service instance discovery data filtering script

autoBindFilter2string

Second binding script used for DCI binding (currently used in business service)

autoBindFlagsinteger

Auto bind bit flags:

  • 0x0001: First script for auto bind is enabled
  • 0x0002: First script for auto unbind is enabled
  • 0x0004: Second script for auto bind is enabled
  • 0x0008: Second script for auto unbind is enabled
objectStatusThresholdinteger

Business service default threshold for auto-created object checks:

  • 0: Default
  • 1: Warning
  • 2: Minor
  • 3: Major
  • 4: Critical
dciStatusThresholdinteger

Business service default threshold for auto-created DCI checks:

  • 0: Default
  • 1: Warning
  • 2: Minor
  • 3: Major
  • 4: Critical
sourceNodeinteger

ID of source node for business service instance discovery methods

Response

Object updated successfully