List all permissible open collector

get

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

Returns details of all permissible open collector that match the specified criteria.

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.

orderBy

string

enum

Defaults to name

Sorts record by name, entityName, openCollectorHostName, ipAddress, activeBeats, lastHeartBeat, openCollectorStatus

Allowed:

dir

string

enum

Defaults to ascending

Sorts records by ascending or descending.

Allowed:

name

string

Object name filter.

entityId

array of integers

Filters User records by Entity Id.

entityId

hostId

array of integers

Filters results for one or more hosts.

hostId

ipAddress

string

IP address filter

recordStatus

string

enum

Defaults to all

Filters records by object recordStatus.

Allowed:

lastHeartbeat

date-time

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

activeBeats

integer

≥ 0

Returns openCollector records having number of active beats associated to a particular openCollector.

Responses

200Returns permissible open collector that match the specified criteria.

403A User without the correct permissions tried to fetch open collectors