Control Room APIs

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

重要:
  • 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:

Versions Endpoints
v1
v2
v3
v4
注: 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.

注: 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: