---
title: "Update node agent communication configuration"
method: PATCH
path: "/v1/objects/{object-id}/agent"
tags: ["Objects"]
---

# Update node agent communication configuration

`PATCH /v1/objects/{object-id}/agent`

Update the node's NetXMS agent communication settings: TCP port, proxy node, shared
secret, the force-encryption and agent-over-tunnel-only flags, the agent DCI cache
mode and the protocol compression mode. Merge-patch semantics: any subset of fields
can be sent; omitted fields are left unchanged. `sharedSecret` is write-only and is
never returned by GET unless sensitive data is explicitly requested.

This property group applies to Node objects only; sending it to any other object
class returns 400.

## Path parameters

- `object-id` integer, required

## Request body

- AgentConfig — NetXMS agent communication property group for a node. Returned by GET /v1/objects/{id}/agent and embedded as `ObjectDetails.agent`; accepted by PATCH /v1/objects/{id}/agent with merge-patch semantics (omitted fields are left unchanged).
  - `port` integer — Agent TCP port.
  - `proxy` integer, nullable — ID of the node used as agent proxy, or 0 for no proxy.
  - `sharedSecret` string, nullable — Agent shared secret (write-only).
  - `forceEncryption` boolean — Require encryption for agent communication.
  - `tunnelOnly` boolean — Accept agent connections only through an established agent tunnel.
  - `cacheMode` 'default' | 'on' | 'off' — Agent-side DCI value caching mode.
  - `compressionMode` 'default' | 'enabled' | 'disabled' — Agent communication protocol compression mode.
  - `certificateMappingMethod` 'subject' | 'publicKey' | 'commonName' | 'templateId' — Method used to map the agent's certificate to this node for authentication.
  - `certificateMappingData` string, nullable — Certificate mapping data (interpretation depends on certificateMappingMethod).

## Response `200`

Agent configuration updated; full updated object returned.

- ObjectDetails
  - `alias` string — Object alias
  - `category` integer — Object category ID
  - `chassisPlacementConfig` ChassisPlacement — Placement geometry of an object within a chassis. Returned both in the chassis layout and as the `chassisPlacementConfig` property of a node.
    - `image` string, uuid — GUID of the image representing the component
    - `height` integer — Component height
    - `heightUnits` integer — Units for height (0 = rack units, 1 = millimeters)
    - `width` integer — Component width
    - `widthUnits` integer — Units for width (0 = horizontal pitch, 1 = millimeters)
    - `positionHeight` integer — Vertical position of the top-left corner
    - `positionHeightUnits` integer — Units for vertical position (0 = rack units, 1 = millimeters)
    - `positionWidth` integer — Horizontal position of the top-left corner
    - `positionWidthUnits` integer — Units for horizontal position (0 = horizontal pitch, 1 = millimeters)
    - `orientation` integer — Orientation (1=front, 2=rear)
  - `class` 'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
  - `customAttributes` CustomAttribute[] — Custom attributes defined on the object (including those inherited from parent objects).
    - `name` string — Attribute name.
    - `value` string — Attribute value.
    - `flags` object — Attribute flags as named booleans.
      - `inheritable` boolean — Attribute is inherited by child objects.
      - `redefined` boolean — Inherited attribute is redefined on this object.
      - `conflict` boolean — Attribute is inherited from multiple parents with differing values.
    - `sourceObject` integer — ID of the object an inherited attribute originates from; 0 if defined directly on this object.
  - `guid` string, uuid — Object GUID
  - `id` integer — Object ID
  - `name` string — Object name
  - `responsibleUsers` object[] — Users or groups responsible for the object (the object's own list; entries inherited from parent objects are not included).
    - `userId` integer — User or group ID
    - `tag` string — Responsible user tag
  - `timestamp` string, date-time — Object last change timestamp
  - `status` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
  - `pollStates` PollState[] — Per-poll-type state. Present only for pollable objects (e.g. nodes, sensors, interfaces); one entry per poll type the object accepts.
    - `name` string — Poll type name (e.g. "status", "configuration", "instance", "discovery", "topology", "routing-table", "icmp", "autobind", "map-update").
    - `pending` boolean — True if a poll of this type is currently queued or in flight.
    - `lastCompleted` string, date-time, nullable — Timestamp of the most recent successful completion, or null if this poll type has never completed since server start.
    - `timer` object — Poll duration statistics in milliseconds. Omitted when the poll type has never completed (lastCompleted is null).
      - `last` integer — Duration of the most recent completed poll (ms).
      - `average` integer — Rolling average poll duration (ms).
      - `min` integer — Minimum observed poll duration (ms).
      - `max` integer — Maximum observed poll duration (ms).

## Other responses

- `400` — Malformed request body, invalid value, or property group not applicable to object class.
- `401` — Unauthorized
- `403` — User does not have modify access to the object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)