Agent Instances

Query agent instances

get/agent-runtime/agent-instances

Request

Query parameters

agentDefinitionIdstring

Filter agent instances based on the agent definition id

agentDefinitionKeystring

Filter agent instances based on the agent definition key

idstring

Filter agent instances based on the agent instance id

orderstring

From the paginate request. The sort order, either 'asc' or 'desc'. Defaults to 'asc'.

referenceIdstring

Filter agent instances based on the reference id

referenceTypestring

Filter agent instances based on the reference type

sizeinteger

From the paginate request. Number of rows to fetch, starting from start. Defaults to 10.

sortstring

Property to sort the results on

startinteger

From the paginate request. Index of the first row to fetch. Defaults to 0.

startUserIdstring

Filter agent instances started by the given user

tenantIdstring

Filter agent instances based on the tenant id

tenantIdLikestring

Filter agent instances based on a tenant id like the given one

Response

Indicates the request was successful.

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Changes

No recorded changes to this operation across all 1 revision of this API.