Patch Agent Record

patch

https://localhost:8501/lr-admin-api/agents

Patches values in an agent based on the Id and other required details. Searches existing agent by Id. Returns a 404 error if the Id does not exist. Otherwise, updates the provided values for the agent and returns the agent Id with response 200.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The body of the Agent, including attributes to update.

The summary of an agent.

rimEnabled

boolean | null

enum

If set to true, enables Registry Integrity Monitoring.

Allowed:

disableFlushThrottle

boolean | null

enum

Allowed:

heartbeatWarningInterval

integer | null

msgBuffer

integer | null

netflowServerCrypto

boolean | null

enum

Allowed:

passphrase

password | null

syslogServerCrypto

boolean | null

enum

Allowed:

tcpNodeDelay

boolean | null

enum

Allowed:

tcpRecvBufferSize

integer | null

tcpSendBufferSize

integer | null

tcpReuse

boolean | null

enum

Allowed:

entityId

integer | null

policyId

integer | null

snmpCommunityStrings

array of strings

The SNMP community strings.

snmpCommunityStrings

general

object

netFlowServer

object

networkConnectionMonitor

object

processMonitor

object

secureSyslogServer

object

sFlowServer

object

tlsCertificates

object

fileIntegrityMonitor

object

uniDirectionalAgent

object

userActivityMonitor

object

snmpTrapReceiver

object

syslogServer

object

snmpV3Credentials

array of objects

snmpV3Credentials

agentToMediators

array of objects

Data processors for the agent. At least one data processor is required.

agentToMediators

agentVersionHistory

array of objects

agentVersionHistory

integer

-2147483648 to 2147483647

The Object Id generated by LogRhythm. Required for PUT operations (updates).

guid

string | null

name

string | null

required

The name of the System Monitor.

hostId

integer | null

required

The Host Id of the Agent.

agentType

string | null

enum

The type of agent.

Allowed:

syslogEnabled

boolean | null

enum

The syslog status for the Agent.

Allowed:

netflowEnabled

boolean | null

enum

The status for the IPFIX/Netflow server.

Allowed:

recordStatusName

string | null

enum

The database status.

Allowed:

licenseType

string | null

enum

The license Types for LR components.

searchScope

string | null

enum

The search scope for Agents.

Allowed:

isLoadBalanced

boolean | null

The load balanced status for the agent.

loadBalancedGroup

object

osType

string | null

enum

The Agent server type on which the OS is installed.

Allowed:

fimPolicies

array of integers

The File Integrity Monitor Policy Ids for the agent.

fimPolicies

rimPolicies

array of integers

The Registry Integrity Monitor Policy Ids for the agent.

rimPolicies

dldPolicy

integer | null

The Data Loss Defender Policy Id for the agent.

shortDesc

string | null

A short description for the agent.

longDesc

string | null

A long description for the Agent.

agentDPLoadBalancing

boolean | null

Describes whether the agent is in pinned mode or pool mode. If true, it is in pool mode.

dataProcessorPool

object

status

string | null

enum

Defaults to Enabled

The status of the component.

Allowed:

lastHeartbeat

date-time

The time of component's last heartbeat.

version

string

The component's version

capabilities

string

enum

The capabilities of the Agent.

Allowed:

Responses

200Returns the updated agent details.

403A User without the correct permissions tried to create an Agent.

404The Host Id provided for the Agent is invalid or is for a Host for which the current User does not have permissions.

409Agent already exists for the given Host Id.