API Reference
Start typing to search…

List Summary of Accepted Agents

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

Returns a summary of all accepted Agents.

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

Allowed:
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
searchScope
array of strings

Filters agents by search scope.

searchScope
string

Filters records by Entity name.

string

The deployment version of the component.

agentType
array of strings

The type of agent.

agentType
isLoadBalanced
array of booleans

Filters results by load balanced status of the component.

isLoadBalanced
string
enum
Defaults to all

Filters records by object recordStatus.

Allowed:
boolean

Filters results by whether AIE records should be fetched.

Response

Updated 6 months ago

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