API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
API Reference

List self-hosted agents

get
https://{tenant}.katalon.io/v2/tc/ees/agents

Lists agents that match the search. Include an account, organization,
or project condition in q. The x-project-id header does not add a
search filter.

Requires either the KreAgent:Read permission or the Execution:Read permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

RSQL filter with an account, organization, or project scope.

string

Comma-separated sort fields. Prefix a field with - for descending order.

string
required

Numeric string for the page to request. Send 0 for the first page.

integer

Number of items to request for the result list.

Headers
uuid

Account UUID when needed to select the account context.

int64

Organization ID when needed to select the organization context.

int64
required

Project ID. Required on every request.

Responses

default

Any other error. The error body can vary.

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 hour ago

Did this page help you?