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

# Get node agent communication configuration

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

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.

## Path parameters

- `object-id` integer, required

## Response `200`

Agent communication configuration.

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

## Other responses

- `400` — Property group not applicable to object class.
- `401` — Unauthorized
- `403` — User does not have read access to the object
- `404` — Object with given ID does not exist

## Changes

- **2026-06-08** `9126f5dc2867` — 2 info
  - added the optional property `certificateMappingData` to the response with the `200` status
  - added the optional property `certificateMappingMethod` to the response with the `200` status
- **2026-06-07** `d6268953447f` — 1 info
  - endpoint added
- **2026-05-08** `c6aaf3632e48` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/objects/:object-id/agent/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-api/revisions/b04ea2fbcedb/schema)