Get a local agent

Request

This request uses the GET method, which is used to retrieve information about a specific local agent from the specified resource.

For basic authorization, replace this with your actual username and password (or API key) in the header request in the username:password or username:api_key format. Your user creds are combined to form a Base64 encoded string.

The request data is provided as a JSON object. You need to provide the following required query parameters:

id: the alphanumeric ID of the local agent ID. You can find this in the Configurations > Test Environment in Katalon TestOps.

Response

This API response provides a comprehensive summary of the test result, including information about the test case, execution details, platform, attachments, and more.

See the following example:

{
  "id": 12014256,
  "name": "My Agent",
  "ip": null,
  "uuid": "string",
  "lastPing": "2023-12-20T09:37:38.218Z"
  "os": "string",
  "teamId": 0,
  "hostname": "string",
  "active": true,
  "threshold": 0,
  "numExecutingJobs": 0,
  "numAssignedJobs": 0,
  "agentVersion": "string",
  "deleted": true
}

Refer to the following table about the response body parameters:

Property	Type	Description
`id`	string	The agent ID.
`name`	string	Label name of the agent.
`ip`	string	The IP address associated with the agent.
`uuid`	string	Universally Unique Identifier for the agent.
`lastPing`	string	The timestamp of the agent's last ping, indicating the time it communicated with the system.
`os`	string	The operating system on which the agent is running.
`teamId`	string	Identifier for the team to which the agent belongs.
`hostname`	string	The hostname associated with the agent.
`active`	Boolean	Indicates whether the agent is currently active or not.
`threshold`	integer	Agent threshold.
`numExecutingJobs`	integer	The number of jobs currently being executed by the agent.
`numAssignedJobs`	integer	The number of jobs assigned to the agent.
`agentVersion`	integer	The version of the agent.
`deleted`	Boolean	Indicates whether the agent is marked as deleted or not.

Try it!

Enter the agent ID below.
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!