A successful request to this endpoint updates the threshold for the specified local agent, and returns the updated local agent details.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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 credentials are combined to form a Base64 encoded string.
You need to provide the following required query parameters to retrieve local agent details:
id: The alphanumeric ID of the local agent. You can find this in the Configurations > Test Environment in Katalon True Platform.
Response
The response will contain the details of the local agent based on the provided id.
See the following example:
{
"id": 0,
"name": "string",
"ip": "string",
"uuid": "string",
"lastPing": "2025-01-20T01:41:55.574Z",
"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 properties:
| Property | Type | Description |
|---|---|---|
id | Integer | The unique ID of the local agent. |
name | String | The name of the local agent. |
ip | String | The IP address of the local agent. |
uuid | String | The unique UUID of the local agent. |
lastPing | String | The timestamp of the last ping from the agent. |
os | String | The operating system of the local agent. |
teamId | Integer | The team ID associated with the local agent. |
hostname | String | The hostname of the local agent. |
active | Boolean | The status indicating if the agent is currently active. |
threshold | Integer | The threshold value for the local agent, if applicable. |
numExecutingJobs | Integr | The number of jobs currently being executed by the agent. |
numAssignedJobs | Integer | The number of jobs assigned to the agent but not yet executed. |
agentVersion | String | The version of the agent currently installed. |
deleted | Boolean | Indicates whether the agent has been deleted. |
Try it!
- Enter the required (and optional, if applicable) fields below.
- Select the language in Language.
- Enter your user name or API credentials.
- Review your API call and click Try it!