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

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

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "workspaceId": "string"
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Create Agent Group

Creates an agent group in the specified workspace

Request Examples

{
  "name": "string"
}

Response Examples

{
  "id": "string",
  "name": "string",
  "workspaceId": "string"
}

Delete Agent Group

Deletes an agent group using agent-group-id and workspace-id

Response Examples

{
  "message": "string",
  "code": "string"
}