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

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: To learn how to test Control Room APIs in Swagger and Postman, watch the following video:

Redoc view for API modules

You can now view the API modules in a redoc view. This view provides an intuitive interface where you can easily find information on using the Control Room APIs with comprehensive description and relevant code samples that you can reuse.

The layout is updated to a three-panel view which categorizes the API information into the following panes:
  • Table of contents in the left pane.
  • Introduction and descriptions in the center pane.
  • Reusable code samples in the right pane.
This view includes details of each endpoint and examples on how to use them.