API Reference

Update Log Source

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

Updates a log source based on the Id and other required details. Searches existing log source by Id. Returns a 404 error if the Id does not exist. Otherwise, updates the log source and returns the log source Id with response 200.

* In case of non Flat File logsource type, WatchFileRenameOnRollover will always be set to true."

* Put logsource endpoint will not update the beat information provided in the request body."

* The value of the eventLogFilter property must be in a valid XML format; if updating this property is not necessary, do not include it in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
-2147483647 to 2147483647

The Object Id stored in the database.

Body Params

The body of the log source, including all required attributes.

integer
-2147483648 to 2147483647

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

integer
required
-2147483648 to 2147483647

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

string
length ≤ 255

The name of the System Monitor agent.

string
required
length ≤ 200

The log message source name stored in the database.

host
object
required
entity
object
logSourceType
object
required
mpePolicy
object
required
string
length ≤ 255

A brief description of the component.

string
length ≤ 2000

A full description of the component.

string
enum

A record status of retired or active.

Allowed:
string
enum

Status for enable, paused, or unregistered

Allowed:
boolean
enum
Defaults to false
Allowed:
logSourceIdentifiers
array of objects
logSourceIdentifiers
integer
boolean
enum
Defaults to false
Allowed:
string
enum
required

The name of the available MPE processsing modes.

Allowed:
boolean
enum
Defaults to false
Allowed:
integer
1 to 50000
Defaults to 100
integer
date-time

The date when the object was last modified. This is ignored when saving the records.

boolean
enum
Defaults to false
Allowed:
integer | null
string
integer
integer
date-time | null
date-time | null
integer
string
enum
Allowed:
integer
Defaults to 100
integer | null
string
string
string
enum
Defaults to Increment
Allowed:
string
string
string
string
string
string
integer | null
integer | null
integer | null
integer | null
integer | null
string
string
string
string
string
string
string
string
integer
boolean
enum
Defaults to false
Allowed:
string | null
string | null
string
enum
Defaults to none
Allowed:
integer | null
integer
0 to 600
Defaults to 120
string | null
integer | null
integer | null
boolean
enum
Defaults to false
Allowed:
string
enum
Allowed:
date-time
integer | null
string
boolean
enum
Defaults to true
Allowed:
logSourceBeat
object
string | null
Responses

Updated 9 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?