Control Room APIs
- Updated: 2024/03/22
Control Room APIs
The Automation Anywhere Control Room provides APIs that enable you to customize how you (and your automations) interact with Automation Anywhere.
You use Control Room APIs to:
- Manage bot deployments
- Create and manage credentials in the Credential Vault
- Create and manage user accounts and roles
- Create and manage queues
API endpoints
You can view all the Control Room API modules and the associated endpoints in the
following table:
Versions | Endpoints |
---|---|
v1 | |
v2 | |
v3 | |
v4 |
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.
The Control Room supports several REST API clients. You can use Control Room swagger to view and run the APIs. Access the Control Room swagger 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:
- Some APIs require you to filter, paginate, and sort the results to get the desired output. For more information on filtering, pagination, and sorting, see Filtering, pagination, and sorting.
- API response codes in the responses are described in the API response codes.
- The Comparing Automation 360 and Enterprise 11 APIs compares the Enterprise 11 and Automation 360 APIs.