Get all beats details available in the system.

get

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

Returns all the beats details available.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

integer

Defaults to 0

The starting point of records to be returned.

count

integer

1 to 1000

Defaults to 100

The number of results to be returned.

dir

string

enum

Defaults to ascending

Sorts records by ascending or descending.

Allowed:

orderBy

string

enum

Defaults to name

Sorts beats by name, entityName, lastHeartbeat, status, systemMonitorAgentName, openCollectorName

Allowed:

name

string

Object name filter.

entityId

array of integers

Filters User records by Entity Id.

entityId

systemMonitorId

integer

Filters results for a specific System Monitor Id in resources.

messageSourceTypeId

integer

Filters results for a specific Message Source Type Id in resources.

openCollectorId

array of integers

Filters beats records by open collector id.

openCollectorId

activeLogSources

integer

≥ 0

Filters results based on active Log sources count for beats.

status

string

enum

Defaults to all

Filters records by object status.

Allowed:

lastHeartbeat

date-time

Returns results having lastHeartbeat greater or equal to than the one provided in query parameter.

Responses

200Returns all the beats details available.

403A user without the correct permissions tries to get beats.