API Reference
Start typing to search…

Update Agent Record

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

Updates 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 agent and returns the agent Id with response 200.

Required fields for this operation:

  • id: The agent ID to update (must be a valid, existing agent ID)
  • name: The name of the System Monitor
  • hostId: The Host ID where the agent is installed (must be a valid host ID that the user has permissions to access)
  • recordStatusName: The record status (Active or Retired)
  • agentToMediators: At least one data processor must be specified in this array

Note: Omitting any of these required fields will result in a 400 Bad Request error.

Body Params

The body of the Agent, including all attributes.

boolean
enum
Defaults to false

If set to true, enables Registry Integrity Monitoring.

Allowed:
boolean
enum
Defaults to false
Allowed:
integer
Defaults to 60
integer
Defaults to 1000
boolean
enum
Defaults to false
Allowed:
password
length ≤ 56
boolean
enum
Defaults to false
Allowed:
boolean
enum
Defaults to true
Allowed:
integer
Defaults to 524288
integer
Defaults to 524288
boolean
enum
Defaults to true
Allowed:
integer
integer
Defaults to -1
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
required

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

agentToMediators*
agentVersionHistory
array of objects
agentVersionHistory
integer
required
-2147483648 to 2147483647

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

string | null
string
required
length ≤ 255

The name of the System Monitor.

integer
required

The Host Id of the Agent.

string
enum
Defaults to Windows

The type of agent.

Allowed:
boolean
enum
Defaults to false

The syslog status for the Agent.

Allowed:
boolean
enum
Defaults to false

The status for the IPFIX/Netflow server.

Allowed:
string
enum
required

The database status. Required for PUT operations. Valid values are "Active" or "Retired".

Allowed:
string
enum

The license Types for LR components.

string
enum
Defaults to ParentEntitySearch

The search scope for Agents.

Allowed:
boolean

The load balanced status for the agent.

loadBalancedGroup
object
string
enum
Defaults to None

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
integer | null

The Data Loss Defender Policy Id for the agent.

string | null

A short description for the agent.

string | null

A long description for the Agent.

boolean

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

dataProcessorPool
object
string
enum
Defaults to Enabled

The status of the component.

Allowed:
date-time

The time of component's last heartbeat.

string

The component's version

string
enum

The capabilities of the Agent.

Allowed:
Responses

Updated 4 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago