API Reference

Create a new beat.

post
https://localhost:8501/lr-admin-api/beats

* Creates a new beat if Id specified is -1, and then returns the LogRhythm generated beat Id.

* beatsTemplateId will be ignored and system will fetch beatsTemplateId on the basis of BeatTypeId provided.

* Entity information provided in the request will be ignored since the entity will automatically be mapped based on the open collector information. * Host information provided in the request will be ignored since the Host will automatically be mapped based on the beatToAgent's SystemMonitorId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The body of the beat, including all required attributes.

integer
required
-2147483648 to 2147483647

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

beatType
object
required
integer
-2147483648 to 2147483647

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

string
required
length between 4 and 12

The name of the beat.

beatToAgent
object
required
openCollector
object
required
entity
object
parentLogSource
object
string
required

The JSON of the data provided by the user.

date-time

The time of component's last heartbeat.

string
enum

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

Allowed:
date-time

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

date-time

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

Responses

Updated 8 months ago

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

Updated 8 months ago