--- title: "Update object" method: PATCH path: "/objects/{object-id}" tags: ["Objects"] --- # Update object `PATCH /objects/{object-id}` Request to update object. ## Path parameters - `object-id` string, required ## Request body - ObjectModification - `name` string - `primaryName` string - `alias` string - `nameOnMap` string - `acl` AccessListElement[] — inheritAccessRights should be provided in the same request - `userId` integer - `accessRights` integer — Bit flag field. Available options: * OBJECT ACCESS READ: 0x00000001 * OBJECT ACCESS MODIFY: 0x00000002 * OBJECT ACCESS CREATE: 0x00000004 * OBJECT ACCESS DELETE: 0x00000008 * OBJECT ACCESS READ ALARMS: 0x00000010 * OBJECT ACCESS ACL: 0x00000020 * OBJECT ACCESS UPDATE ALARMS: 0x00000040 * OBJECT ACCESS SEND EVENTS: 0x00000080 * OBJECT ACCESS CONTROL: 0x00000100 * OBJECT ACCESS TERM ALARMS: 0x00000200 * OBJECT ACCESS PUSH DATA: 0x00000400 * OBJECT ACCESS CREATE ISSUE: 0x00000800 * OBJECT ACCESS DOWNLOAD: 0x00001000 * OBJECT ACCESS UPLOAD: 0x00002000 * OBJECT ACCESS MANAGE FILES: 0x00004000 * OBJECT ACCESS MAINTENANCE: 0x00008000 * OBJECT ACCESS READ AGENT: 0x00010000 * OBJECT ACCESS READ SNMP: 0x00020000 * OBJECT ACCESS SCREENSHOT: 0x00040000 - `inheritAccessRights` boolean — acl should be provided in the same request - `customAttributes` CustomAttribute - `value` string - `flags` integer — Available options: * INHERITABLE: 1 - `autoBindFilter` string - `version` integer - `description` string - `agentPort` integer - `agentSecret` string - `agentProxy` integer - `snmpPort` integer - `snmpVersion` string — Node SNMP version: * V1 * V2C * V3 * DEFAULT - `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 — Available options: * UNSET: 0 * MANUAL: 1 * GPS: 2 * NETWORK: 3 - `latitude` number - `longitude` number - `accuracy` integer — Location accuracy in meters - `timestamp` integer — UNIX timestamp - `mapBackground` string — UUID. mapBackgroundLocation, mapBackgroundLocation, mapBackgroundZoom, mapBackgroundColor should be provided in the same request. - `mapBackgroundLocation` Geolocation - `type` integer — Available options: * UNSET: 0 * MANUAL: 1 * GPS: 2 * NETWORK: 3 - `latitude` number - `longitude` number - `accuracy` integer — Location accuracy in meters - `timestamp` integer — UNIX timestamp - `mapBackgroundZoom` integer — mapBackground, mapBackgroundLocation, mapBackgroundLocation, mapBackgroundColor should be provided in the same request. - `mapBackgroundColor` integer — mapBackground, mapBackgroundLocation, 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 IP request - `response` string — Network service IP response - `objectFlags` integer — 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. - `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` string — Object status: * NORMAL * WARNING * MINOR * MAJOR * CRITICAL * UNKNOWN * UNMANAGED * DISABLED * TESTING - `statusShift` integer - `statusTransformation` unknown[] — ObjectStatus[] Object status mapping list. Possible values: * NORMAL * WARNING * MINOR * MAJOR * CRITICAL * UNKNOWN * UNMANAGED * DISABLED * TESTING - unknown - `statusSingleThreshold` integer - `statusThresholds` integer[] - `expectedState` integer - `linkColor` integer - `connectionRouting` integer - `discoveryRadius` integer - `height` integer - `filter` string - `peerGatewayId` integer - `localNetworks` string[] — VPN networks IP address. remoteNetworks should be provided in the same request. - `remoteNetworks` string[] — VPN networks IP address. localNetworks should be provided in the same request. - `postalAddress` unknown - `agentCacheMode` string — Possible values: * DEFAULT * ON * OFF - `agentCompressionMode` string — Possible values: * DEFAULT * ENABLED * DISABLED - `mapObjectDisplayMode` string — Possible values: * 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` string — Possible values: * 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` unknown - `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` string — Possible values: * DEFAULT * ON * OFF - `icmpTargets` string[] — ICMP ping targets IP addresses - `chassisPlacement` string - `etherNetIPPort` integer - `etherNetIPProxy` integer - `certificateMappingMethod` string — Possible values: * 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` unknown - `geoAreas` integer[] - `instanceDiscoveryMethod` integer — Business service instance discovery method Possible values: * IDM_AGENT_LIST - 1 * IDM_AGENT_TABLE - 2 * IDM_SCRIPT - 5 - `instanceDiscoveryData` string — Business service instance discovery data - `instanceDiscoveryFilter` string — Business service instance discovery data filtering script - `autoBindFilter2` integer — Second binding script used for DCI binding. Currently used in business service - `autoBindFlags` integer — 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 - `objectStatusThreshold` integer — Business service default threshold for auto created object checks Possible values: * Default - 0 * Warning - 1 * Minor - 2 * Major - 3 * Critical - 4 - `dciStatusThreshold` integer — Business service default threshold for auto created DCI checks Possible values: * Default - 0 * Warning - 1 * Minor - 2 * Major - 3 * Critical - 4 - `sourceNode` integer — Id of source node for business service instance discovery methods ## Response `200` If object was updated successfully. ## Changes - **2023-02-23** `9c09a2aad349` — 1 info - endpoint added [Change history](https://skmtc.dev/netxms/apis/netxms-rest-api/changes/objects/:object-id/patch.md) --- [API](https://skmtc.dev/netxms/apis/netxms-rest-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-rest-api/revisions/9c09a2aad349/schema)