Agents

To achieve high availability and load balancing agents can be added to an on-prem agent group.

Agents in the same group can both:

  • Distribute work between them to maintain performance

  • Act as backups if any agent goes down

List Agents

get/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents

Returns paginated list of agent instances from an agent group using agent-group-id and workspace-id

SecuritybearerAuth
Request
path Parameters
workspace-id
required
string
agent-group-id
required
string
query Parameters
first
integer <int32>
last
integer <int32>
cursor
string
Responses
200
Response Schema: application/json
Array of objects (PublicOnPremAgentInstanceHttpResponse)
required
object (BasePageInfo_PublicOnPremAgentInstanceHttpResponse)
400

Invalid Input

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

409

Concurrency Conflict

413

Content Too Large

429

Limit Exceeded

500

Internal Error

Request samples 
Response samples 
application/json
{
  • "elements": [
    • {
      • "id": "string",
      • "agentGroupId": "string",
      • "name": "string",
      • "registered": true,
      • "connected": true,
      • "enabled": true
      }
    ],
  • "pageInfo": {
    • "startCursor": "string",
    • "endCursor": "string",
    • "hasNextPage": true,
    • "hasPreviousPage": true
    }
}
Create Agent
post/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents
Adds an agent instance under an agent group using agent-group-id and workspace-id


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
agent-group-id
required
string
 
Request Body schema: application/json
required
name
required
string
 
Responses 
200
Response Schema: application/json
id
required
string
 
agentGroupId
required
string
 
name
required
string
 
registrationToken
required
string
 
400
Invalid Input


401
Unauthorized


403
Forbidden


404
Not Found


408
Request Timeout


409
Concurrency Conflict


413
Content Too Large


429
Limit Exceeded


500
Internal Error


Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "agentGroupId": "string",
  • "name": "string",
  • "registrationToken": "string"
}
Retrieve Agent
get/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}
Get details of an agent instance using agent-id


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
agent-group-id
required
string
 
agent-id
required
string
 
Responses 
200
Response Schema: application/json
id
required
string
 
agentGroupId
required
string
 
name
required
string
 
registered
required
boolean
 
connected
required
boolean
 
enabled
required
boolean
 
400
Invalid Input


401
Unauthorized


403
Forbidden


404
Not Found


408
Request Timeout


409
Concurrency Conflict


413
Content Too Large


429
Limit Exceeded


500
Internal Error


Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "agentGroupId": "string",
  • "name": "string",
  • "registered": true,
  • "connected": true,
  • "enabled": true
}
Update Agent
patch/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}
Updates an agent instance using agent-id


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
agent-group-id
required
string
 
agent-id
required
string
 
Request Body schema: application/json
required
enabled
boolean
 
Responses 
200
Response Schema: application/json
id
required
string
 
agentGroupId
required
string
 
name
required
string
 
registered
required
boolean
 
connected
required
boolean
 
enabled
required
boolean
 
400
Invalid Input


401
Unauthorized


403
Forbidden


404
Not Found


408
Request Timeout


409
Concurrency Conflict


413
Content Too Large


429
Limit Exceeded


500
Internal Error


Request samples 
application/json
{
  • "enabled": true
}
Response samples 
application/json
{
  • "id": "string",
  • "agentGroupId": "string",
  • "name": "string",
  • "registered": true,
  • "connected": true,
  • "enabled": true
}
Delete Agent
delete/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}/agents/{agent-id}
Delete an agent instance using agent-id


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
agent-group-id
required
string
 
agent-id
required
string
 
Responses 
204
400
Invalid Input


401
Unauthorized


403
Forbidden


404
Not Found


408
Request Timeout


409
Concurrency Conflict


413
Content Too Large


429
Limit Exceeded


500
Internal Error


Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "code": "string"
}