Sign in
Objects

Get node agent communication configuration

Return the node's NetXMS agent communication settings (the same shape accepted by the matching PATCH). The sharedSecret is included only when the caller has modify or read-credentials access to the object.

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

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

Path parameters

object-idinteger required

Response

Agent communication configuration.

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

Changes

Changed in 3 of the 115 revisions of this API.13

  • 9126f5dc28672See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d6268953447f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • c6aaf3632e481See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog