Agent Instances

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

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

Response Examples

{
  "elements": [
    {
      "id": "string",
      "agentGroupId": "string",
      "name": "string",
      "registered": true,
      "connected": true,
      "enabled": true
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Create Agent

Adds an agent instance under an agent group using agent-group-id and workspace-id

Request Examples

{
  "name": "string"
}

Response Examples

{
  "id": "string",
  "agentGroupId": "string",
  "name": "string",
  "registrationToken": "string"
}

Retrieve Agent

Get details of an agent instance using agent-id

Response Examples

{
  "id": "string",
  "agentGroupId": "string",
  "name": "string",
  "registered": true,
  "connected": true,
  "enabled": true
}

Update Agent

Updates an agent instance using agent-id

Request Examples

{
  "enabled": true
}

Response Examples

{
  "id": "string",
  "agentGroupId": "string",
  "name": "string",
  "registered": true,
  "connected": true,
  "enabled": true
}

Delete Agent

Delete an agent instance using agent-id

Response Examples

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