Sign in

v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB
Objects

Update node agent communication configuration

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.

patch/v1/objects/{object-id}/agent

Path parameters

object-idinteger required

Request body

portinteger

Agent TCP port.

proxyinteger nullable

ID of the node used as agent proxy, or 0 for no proxy.

sharedSecretstring nullable

Agent shared secret (write-only).

forceEncryptionboolean

Require encryption for agent communication.

tunnelOnlyboolean

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.

certificateMappingDatastring nullable

Certificate mapping data (interpretation depends on certificateMappingMethod).

Response

Agent configuration updated; full updated object returned.

aliasstring

Object alias

categoryinteger

Object category ID

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'
guidstring uuid

Object GUID

idinteger

Object ID

namestring

Object name

timestampstring date-time

Object last change timestamp

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8