Objects

Update object

Request to update object.

patch/objects/{object-id}

Path parameters

object-idstring required

Object information identified by provided ID or GUID.

Request body

namestring
primaryNamestring
aliasstring
nameOnMapstring
inheritAccessRightsboolean

acl should be provided in the same request

autoBindFilterstring
versioninteger
descriptionstring
agentPortinteger
agentSecretstring
agentProxyinteger
snmpPortinteger
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
serviceTypeinteger
ipProtocolinteger
ipPortinteger
ipAddressstring

Network service IP address

requeststring

Network service IP request

responsestring

Network service IP response

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
heightinteger
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.

{"stackTrail":"components:schemas:objectModification:properties:postalAddress","oasType":"schema","type":"unknown","description":":ref:`PostalAddress<postal-address-fields>`\n"}
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
controllerIdinteger
chassisIdinteger
sshProxyinteger
sshLoginstring
sshPasswordstring
sshPortinteger
sshKeyIdinteger
zoneProxiesinteger[]
{"stackTrail":"components:schemas:objectModification:properties:urls","oasType":"schema","type":"unknown","description":"ObjectUrl[]\n"}
seedObjectIdsinteger[]
macAddressstring

Sensor mac address

deviceClassinteger
vendorstring
serialNumberstring
deviceAddressstring
metaTypestring
sensorProxyinteger
xmlConfigstring
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:objectModification:properties:geoLocationControlMode","oasType":"schema","type":"unknown","description":"GeoLocationControlMode\nPossible values:\n \n * NO_CONTROL\n * RESTRICTED_AREAS\n * ALLOWED_AREAS\n"}
geoAreasinteger[]
instanceDiscoveryMethodinteger

Business service instance discovery method
Possible values:

* IDM_AGENT_LIST - 1
* IDM_AGENT_TABLE - 2
* IDM_SCRIPT - 5
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

If object was updated successfully.

Changes