Agent groups

An agent group is simply a collection of agents. Agents in one group share the load and ensure high availability.

You need to set up an agent group, every time you are creating an authentication for an on-prem service.

Retrieve Agent Groups

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

Returns paginated list of agent groups from a workspace using workspace-id

SecuritybearerAuth
Request
path Parameters
workspace-id
required
string
query Parameters
first
integer <int32>
last
integer <int32>
cursor
string
Responses
200
Response Schema: application/json
Array of objects (PublicOnPremAgentGroupHttpResponse)
required
object (BasePageInfo_PublicOnPremAgentGroupHttpResponse)
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",
      • "name": "string",
      • "workspaceId": "string"
      }
    ],
  • "pageInfo": {
    • "startCursor": "string",
    • "endCursor": "string",
    • "hasNextPage": true,
    • "hasPreviousPage": true
    }
}
Create Agent Group
post/core/v1/workspaces/{workspace-id}/on-prem-agent-groups
Creates an agent group in the specified workspace


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
Request Body schema: application/json
required
name
required
string
 
Responses 
200
Response Schema: application/json
id
required
string
 
name
required
string
 
workspaceId
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",
  • "name": "string",
  • "workspaceId": "string"
}
Delete Agent Group
delete/core/v1/workspaces/{workspace-id}/on-prem-agent-groups/{agent-group-id}
Deletes an agent group using agent-group-id and workspace-id


SecuritybearerAuth 
Request 
path Parameters
workspace-id
required
string
 
agent-group-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"
}