--- title: "Update object" method: PUT path: "/objects/{object-id}" tags: ["Objects"] --- # Update object `PUT /objects/{object-id}` Updates object properties. Only provided fields are updated. Array fields are replaced entirely (not merged). ## Path parameters - `object-id` string, required ## Request body - ObjectModificationData — Fields that are not set will not be updated. Array fields are replaced fully (if new array does not contain old elements, they will be deleted). Note: Starting from version 4, isAutoBindEnabled and isAutoUnbindEnabled are replaced by autoBindFlags. - `name` string - `primaryName` string - `alias` string - `nameOnMap` string - `acl` AccessListElement[] — inheritAccessRights should be provided in the same request - `userId` integer - `accessRights` integer — Bit flags: - 0x00000001: READ - 0x00000002: MODIFY - 0x00000004: CREATE - 0x00000008: DELETE - 0x00000010: READ_ALARMS - 0x00000020: ACL - 0x00000040: UPDATE_ALARMS - 0x00000080: SEND_EVENTS - 0x00000100: CONTROL - 0x00000200: TERM_ALARMS - 0x00000400: PUSH_DATA - 0x00000800: CREATE_ISSUE - 0x00001000: DOWNLOAD - 0x00002000: UPLOAD - 0x00004000: MANAGE_FILES - 0x00008000: MAINTENANCE - 0x00010000: READ_AGENT - 0x00020000: READ_SNMP - 0x00040000: SCREENSHOT - 0x00080000: EDIT_MNT_JOURNAL - 0x00100000: CONFIGURE_AGENT - 0x00200000: EDIT_COMMENTS - 0x00400000: EDIT_RESP_USERS - 0x00800000: DELEGATED_READ - 0x01000000: MANAGE_POLICIES - 0x02000000: MANAGE_INCIDENTS - `inheritAccessRights` boolean — acl should be provided in the same request - `customAttributes` object — Object name is custom attribute name. All custom attributes must be included; attributes not in JSON will be deleted. - `autoBindFilter` string - `version` integer - `description` string - `agentPort` integer - `agentSecret` string - `agentProxy` integer - `snmpPort` integer - `snmpVersion` 'V1' | 'V2C' | 'V3' | 'DEFAULT' — Node SNMP version - `snmpAuthMethod` integer — snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpPrivMethod should be provided in the same request - `snmpPrivMethod` integer — snmpAuthName, snmpAuthPassword, snmpPrivPassword, snmpAuthMethod should be provided in the same request - `snmpAuthName` string — snmpAuthPassword, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request - `snmpAuthPassword` string — snmpAuthName, snmpPrivPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request - `snmpPrivPassword` string — snmpAuthName, snmpAuthPassword, snmpAuthMethod, snmpPrivMethod should be provided in the same request - `snmpProxy` integer - `icmpProxy` integer - `trustedNodes` integer[] - `geolocation` Geolocation - `type` integer — 0: UNSET, 1: MANUAL, 2: GPS, 3: NETWORK - `latitude` number, double - `longitude` number, double - `accuracy` integer — Accuracy in meters - `timestamp` integer — Unix timestamp - `mapBackground` string, uuid — mapBackgroundLocation, mapBackgroundZoom, mapBackgroundColor should be provided in the same request - `mapBackgroundLocation` Geolocation - `type` integer — 0: UNSET, 1: MANUAL, 2: GPS, 3: NETWORK - `latitude` number, double - `longitude` number, double - `accuracy` integer — Accuracy in meters - `timestamp` integer — Unix timestamp - `mapBackgroundZoom` integer — mapBackground, mapBackgroundLocation, mapBackgroundColor should be provided in the same request - `mapBackgroundColor` integer — mapBackground, mapBackgroundLocation, mapBackgroundZoom should be provided in the same request - `mapImage` string, uuid - `columnCount` integer - `script` string - `activationEvent` integer - `deactivationEvent` integer - `sourceObject` integer - `activeStatus` integer - `inactiveStatus` integer - `drillDownObjectId` integer - `pollerNode` integer - `requiredPolls` integer - `serviceType` integer - `ipProtocol` integer - `ipPort` integer - `ipAddress` string — Network service IP address - `request` string — Network service request string - `response` string — Network service expected response - `objectFlags` integer — 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. - `objectFlagsMask` integer — Bitmask that defines which bits in objectFlags will have effect. objectFlags should be provided in the same request. - `ifXTablePolicy` integer - `reportDefinition` string - `networkList` string[] — IP address list - `statusCalculationMethod` integer - `statusPropagationMethod` integer - `fixedPropagatedStatus` 'NORMAL' | 'WARNING' | 'MINOR' | 'MAJOR' | 'CRITICAL' | 'UNKNOWN' | 'UNMANAGED' | 'DISABLED' | 'TESTING' — Object status for fixed propagation - `statusShift` integer - `statusTransformation` string[] — Object status mapping list - `statusSingleThreshold` integer - `statusThresholds` integer[] - `expectedState` integer - `linkColor` integer - `connectionRouting` integer - `discoveryRadius` integer - `height` integer - `filter` string - `peerGatewayId` integer - `localNetworks` string[] — VPN local networks IP addresses. remoteNetworks should be provided in the same request. - `remoteNetworks` string[] — VPN remote networks IP addresses. localNetworks should be provided in the same request. - `postalAddress` PostalAddress - `country` string - `region` string - `city` string - `district` string - `streetAddress` string - `postcode` string - `agentCacheMode` 'DEFAULT' | 'ON' | 'OFF' - `agentCompressionMode` 'DEFAULT' | 'ENABLED' | 'DISABLED' - `mapObjectDisplayMode` 'ICON' | 'SMALL_LABEL' | 'LARGE_LABEL' | 'STATUS' | 'FLOOR_PLAN' - `physicalContainerObjectId` integer - `rackImageFront` string, uuid — rackImageRear, rackPosition, rackHeight, rackOrientation should be provided in the same request - `rackImageRear` string, uuid — rackImageFront, rackPosition, rackHeight, rackOrientation should be provided in the same request - `rackPosition` integer — rackImageFront, rackImageRear, rackHeight, rackOrientation should be provided in the same request - `rackHeight` integer — 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 - `dashboards` integer[] - `rackNumberingTopBottom` boolean - `controllerId` integer - `chassisId` integer - `sshProxy` integer - `sshLogin` string - `sshPassword` string - `sshPort` integer - `sshKeyId` integer - `zoneProxies` integer[] - `urls` object[] - `seedObjectIds` integer[] - `macAddress` string — Sensor MAC address - `deviceClass` integer - `vendor` string - `serialNumber` string - `deviceAddress` string - `metaType` string - `sensorProxy` integer - `xmlConfig` string - `snmpPorts` string[] - `responsibleUsers` integer[] - `icmpStatCollectionMode` 'DEFAULT' | 'ON' | 'OFF' - `icmpTargets` string[] — ICMP ping target IP addresses - `chassisPlacement` string - `etherNetIPPort` integer - `etherNetIPProxy` integer - `certificateMappingMethod` 'SUBJECT' | 'PUBLIC_KEY' | 'COMMON_NAME' | 'TEMPLATE_ID' — certificateMappingData should be provided in the same request - `certificateMappingData` string — certificateMappingMethod should be provided in the same request - `categoryId` integer - `geoLocationControlMode` 'NO_CONTROL' | 'RESTRICTED_AREAS' | 'ALLOWED_AREAS' - `geoAreas` integer[] - `instanceDiscoveryMethod` integer — Business service instance discovery method: - 1: IDM_AGENT_LIST - 2: IDM_AGENT_TABLE - 5: IDM_SCRIPT - `instanceDiscoveryData` string — Business service instance discovery data - `instanceDiscoveryFilter` string — Business service instance discovery data filtering script - `autoBindFilter2` string — Second binding script used for DCI binding (currently used in business service) - `autoBindFlags` integer — 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 - `objectStatusThreshold` integer — Business service default threshold for auto-created object checks: - 0: Default - 1: Warning - 2: Minor - 3: Major - 4: Critical - `dciStatusThreshold` integer — Business service default threshold for auto-created DCI checks: - 0: Default - 1: Warning - 2: Minor - 3: Major - 4: Critical - `sourceNode` integer — ID of source node for business service instance discovery methods ## Response `200` Object updated successfully ## Other responses - `400` — Invalid request - `401` — Access denied - `404` — Object not found --- [API](https://skmtc.net/netxms/apis/netxms-rest-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-rest-api/versions/5743b9619c90/schema)