Deploy a bot

Deploy a bot on one or more devices using the bots id and the ids of the BOT_RUNNER devices.

Prerequisites

Make sure that your Control Room Deployment settings are enabled and there are Callback URLs listed. See, Callback URLs for bot deployment.

You need to identify the bot ids to be deployed and the device ids to deploy them to.
Roles and license

You need to authenticate as a user that has an Unattended bot runner license.

  • URL: http://<your_control_room_url>/v2/automations/deploy
  • Method: POST

Procedure

  1. Add an authentication token to the request header.
    Note: Use the Enterprise 11 Authentication API to generate a JSON Web Token.
  2. Enter the URL for the API http://<your_control_room_url>/v2/automations/deploy.
  3. Select the POST method.
  4. Enter the following parameters in the request body. 
    {
  "fileId": "12",
  "deviceIds": [
    "6",
    "7"
  ]
}
    • fileId: The unique identifier for the bot.
    • deviceIds: The unique identifiers of the device on which the bot is run.
    Note: You can have only on fileId in the request, but you can have multipledeviceIds.

    Response body:

    A successful response returns the unique indentifier for the automation.
    {
  "automationId": "8"
}