API Reference

List Accepted Agents

get
https://localhost:8501/lr-admin-api/agents

Returns details of all accepted Agents that match the specified criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 0

The starting point of records to be returned.

integer
1 to 1000
Defaults to 100

The number of results to be returned.

string
enum
Defaults to name

Sorts record by name, entityName, agentHostName, systemMonitorAgentType, lastHeartbeat, systemMonitorAgentVersion, SystemMonitorAgentStatus, id, lastDataProcessor, activeLogSources

string
enum
Defaults to ascending

Sorts records by ascending or descending.

Allowed:
string

Object name filter.

agentLicenseType
array of strings

Filters Agent records by license type.

agentLicenseType
Allowed:
searchScope
array of strings

Filters agents by search scope.

searchScope
Allowed:
string

Filters records by Entity name.

string
(\d[6-9]?).?((\d[0-9]?).?){0,2}(\d[0-9]{0,4})

The deployment version of the component.

agentType
array of strings

The type of agent.

agentType
Allowed:
isLoadBalanced
array of booleans

Filters results by load balanced status of the component.

isLoadBalanced
Allowed:
string
enum
Defaults to all

Filters records by object recordStatus.

Allowed:
boolean

Filters results by whether AIE records should be fetched.

hostId
array of integers

Filters results for one or more hosts.

hostId
date-time

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

string

Returns results having lastDataProcessor to the provided lastDataProcessor in query parameter.

integer

Returns agent records having number of active logsources associated to a particular agent.

Response

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?