List Summary of Accepted Agents

get

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

Returns a summary of all accepted Agents.

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 records by name or Id.

Allowed:

dir

string

enum

Defaults to ascending

Sorts records by ascending or descending.

Allowed:

name

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:

entity

string

Filters records by Entity name.

version

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:

recordStatus

string

enum

Defaults to all

Filters records by object recordStatus.

Allowed:

fetchAIERecords

boolean

Filters results by whether AIE records should be fetched.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns accepted Agents with matching criteria.