Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Create device pool API

  • Updated: 1/29/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Create device pool API

Device pools are a logical grouping of devices or similar Bot Runner machines on which you can run your workload management automations or scheduled automations. Create a device pool using an API with a unique name and add unattended Bot Runners to the device pool.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

Ensure you have the following:

  • AAE_Pool_Admin role and View and manage ALL device(s) permission
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • Endpoint URLs:
    • <your_control_room_url>/v2/devices/pools
    • <your_control_room_url>/v2/devices/list

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v2/devices/pools.
    If you want to search or get a list of all the available deviceIds, use the following endpoint URL: https://<your_control_room_url>/v2/devices/list

    Request device details

    For example:
    POST https://192.0.2.0/v2/devices/pools

    The this example request body enables you to add automation scheme, unattended Bot Runners, owners, and consumers in the device pool.

    Request body:
    {
      "name": "Finance-device-pool",
      "description": "Pool for Finance RPA",
      "deviceIds": [
        "1",
        "10"
      ],
      "automationScheme": "ROUND_ROBIN",
      "ownerIds": [
        "1",
        "24",
        "26"
      ],
      "consumerIds": [
        "21",
        "22"
      ]
    }
  3. Send the request.
    When the request is successful, a unique device pool id is returned in the response body. The details of the devices, owners, and consumers associated with the device pool are also provided.
    In this example, the response body returns the unique device pool id as 4.
    Response body:
    {
      "id": "4",
      "name": "Finance-device-pool",
      "description": "Pool for Finance RPA",
      "automationScheme": "ROUND_ROBIN",
      "status": "CONNECTED",
      "timeSlice": "5",
      "timeSliceUnit": "MINUTES",
      "deviceIds": [
        "1",
        "10"
      ],
      "ownerIds": [
        "1",
        "24",
        "26"
      ],
      "consumerIds": [
        
      ],
      "detailedStatus": "SOME_CONNECTED",
      "updatedBy": "24",
      "updatedOn": "2020-05-26T09:26:54.556280800Z",
      "createdBy": "24",
      "createdOn": "2020-05-26T09:26:54.556280800Z",
      "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c",
      "tenantId": "4"
    }
    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.

Next steps

If you are performing the steps to Create workload automation, next Run bot with queue API.

If you are performing the steps to Deploy a bot, next Deploy bots API.

Send Feedback