API Reference
Start typing to search…

Patch Log Source

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

Patches 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, patches 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."

* Patch 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.

Path Params
integer
required
-2147483647 to 2147483647

The Object Id stored in the database.

Body Params

The body of the log source, including only updated fields.

integer | null
-2147483648 to 2147483647
integer | null
-2147483648 to 2147483647
string | null

The name of the System Monitor agent.

string | null

The log message source name stored in the database.

host
object
entity
object
logSourceType
object
mpePolicy
object
string | null

A brief description of the component.

string | null

A full description of the component.

string | null
enum

A record status of retired or active.

Allowed:
string | null
enum

Status for enable, paused, or unregistered

Allowed:
boolean | null
enum
Allowed:
logSourceIdentifiers
array of objects
logSourceIdentifiers
integer | null
boolean | null
enum
Allowed:
string | null
enum

The name of the available MPE processsing modes.

Allowed:
boolean | null
enum
Allowed:
integer | null
1 to 50000
integer | null
date-time | null

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

boolean | null
enum
Allowed:
integer | null
string | null
integer | null
integer | null
date-time | null
date-time | null
integer | null
integer | null
integer | null
string | null
string | null
string | null
enum
Allowed:
string | null
string | null
string | null
string | null
string | null
string | null
integer | null
integer | null
integer | null
integer | null
integer | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
integer | null
boolean | null
enum
Allowed:
string | null
string | null
string | null
enum
Allowed:
integer | null
integer | null
0 to 600
string | null
integer | null
integer | null
boolean | null
enum
Allowed:
string | null
enum
Allowed:
date-time | null
integer | null
string | null
boolean | null
enum
Allowed:
logSourceBeat
object
string | null
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