Control Room APIs

The Automation Anywhere Control Room provides APIs that enable you to customize how you (and your automations) interact with Automation Anywhere.

Important:
  • From Automation 360 v.33, the Authentication APIs: POST v1/authentication and POST v1/authentication/token are discontinued and will stop working. To ensure uninterrupted access, update your applications to use the v2 versions of the Authentication APIs: POST v2/authenticationand POST v2/authentication/token.
  • From Automation 360 v.33, the User Management APIs: v1/usermanagement are discontinued and will stop working. To ensure uninterrupted access, update your applications to use the v2 versions of the User Management APIs v2/usermanagement.

You can view and navigate to all the Control Room API modules and the associated endpoints in the following API reference table:

Version1 Endpoint Description
v1 Authentication API Use the v1 Authentication APIs to verify the authenticity and integrity of JSON Web Tokens (JWTs), as well as to terminate active user sessions.
Audit API Use the Audit APIs to retrive audit log data from your Control Room.
Device API Use the Device APIs to identify all available users with unattended Bot Runner licenses, or filter for users by name.
Automations API Use the Bot Scheduler APIs (Automation APIs) to create, update, delete, and return details on scheduled automations.
Trigger API Use the Trigger APIs to create and delete event triggers.You can also map triggers to users or roles for an attended Bot Runner.
API Task Execution API Use the API-Task Execution APIs to generate an API Task execution URL along with a token to start an API-Task execution through an API endpoint.
v2 Authentication API Use the v2 Authentication APIs to generate and refresh JSON Web Tokens (JWT) that are required for authorization in all Enterprise Control Room APIs.
User Management API Use the User Management APIs to view and delete roles and users in your Control Room.
Credential Vault API Use the Credential Vault APIs to create, retreive, update, and delete credentials, Credential attribute values, Lockers, and Keys.
Bot Execution Orchestrator API Use the Credential Vault APIs to create, retreive, update, and delete credentials, Credential attribute values, Lockers, and Keys.
Repository Management API Use the v2 Bot Execution Orchestrator API to monitor devices.
BotInsight API Use the Bot Insight APIs to access real-time business insights and digital workforce performance data to use content-level productivity data from the automations that are deployed.
BLM API Use the Bot Lifecycle Management (BLM) APIs to export and import bots with dependent files and command packages for comprehensive automation lifecycle management.
Device Pool API Use the Device Pool APIs to create, list, update, and delete device pools.
License API Use the License APIs to retrieve Control Room license details and manually sync the Control Room with the license server after license reallocation or renewal.
Process Composer API Use the Processor Composer APIs to create a new request from processes, retrieve initial form, and request by reference ID.
v3 Bot deploy API Use the Bot Deploy API to deploy bots from the public workspace to Bot Runner devices.
Workload Management API Use the Workload Management (WLM) APIs to programmatically manage and create work item models, queues, work items, and automations in your Control Room.
Migration API (Bot migration) Use the v3 migration APIs to migrate TaskBots and MetaBots that were created in Enterprise client versions Enterprise 11 and Enterprise 10 to Automation 360.
Bot Execution Orchestrator API The v3 Bot Execution Orchestrator APIs are used to monitor automation activity progress.
v4 Bot deploy API (V4) Use the v4 Bot Deploy API to deploy bots from the public workspace to Bot Runner devices.
Migration API (Bot migration) Use the v4 migration APIs to migrate TaskBots and MetaBots that were created in Enterprise client versions Enterprise 11 and Enterprise 10 to Automation 360.

1API versions represent different iterations of APIs over time. As an API evolves, new features or improvements are introduced. To manage these changes and maintain compatibility with existing applications, developers use versioning..

Note: To avoid errors and ensure smooth processing of your requests, remember that all JSON parameter names are case-sensitive. For more information, refer to the relevant sections of the API reference documentation for clear guidelines and examples to help you construct your queries and request bodies with the correct casing.

Getting started with Control Room APIs

All requests must include an X-Authorization header with the JSON authentication token, or an Authorization header with a Bearer token for requests to the Control Room. The following sections provide details about the Control Room APIs available endpoints, methods, resources, authentication protocols, parameters, and headers, as well as examples of common requests and responses.

Note: The Bearer token is supported as of the Automation 360 v.27 release and later. It is unsupported and ignored in any previous releases. You must obtain the Bearer token from our OAuth services. To authorize your access, use either X-Authorization (using Authentication API) or Authorization (using OAuth). You cannot use both in the same API.
You can use Control Room Swagger documentation to view and run the APIs. Access the Control Room Swagger documentation by using the link https://{control-room}/swagger/ and replace {control-room} with your Control Room instance. The following sections provide useful information about how to write a Control RoomAPI request: To learn how to test Control Room APIs in Swagger and Postman, watch the following video: