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.34, the following WLM API endpoints are deprecated and are planned to be discontinued (EoL) along with the v.41 release :
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • GET /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consumers
    • POST /v3/wlm/queues/{id}/participants
    • PUT /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PUT /v3/wlm/queues/{id}/workitems/{workItemId}
    Replace the above API endpoints with the following API endpoints:
    • POST /v4/wlm/workitemmodel
    • GET /v4/wlm/workitemmodels/{id}
    • GET /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • POST /v4/wlm/queues/{id}/participants
    • PUT /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PUT /v4/wlm/queues/{id}/workitems/{workItemId}
  • From Automation 360 v.34, the Bot Scheduler API endpoints: /v1/schedule/automations are deprecated and are replaced with /v2/schedule/automations. The v1 version is planned to be discontinued (EoL) in January 2028.

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

The different API versions below 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.

v1 Endpoints

Modules Description
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 retrieve 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 Deprecated Use the v1 Bot Scheduler APIs (Automation APIs) to create, update, delete, and return details on scheduled automations.
Trigger API Use the Trigger APIs to map triggers to users or roles for an attended Bot Runner user. You can also create and delete event triggers.
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.
Policy Management API Use the Policy Management APIs to manage code analysis, policies, and rules within Control Room.
AI Agent Studio API Use the AI Agent Studio APIs to define and connect to custom 모델 연결 models. You can also retrieve and delete the custom 모델 연결.
ACC Automations API Use the Automation Command Center Automations API endpoints to get KPI, ranking, run history, duration, and failure analytics for automations along with detailed execution search.

v2 Endpoints

Modules Description
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, retrieve, update, and delete credentials, Credential attribute values, Lockers, and Keys.
Bot Execution Orchestrator API Use the v2 Bot Execution Orchestrator API to monitor devices.
Repository Management API Use the Repository Management APIs to perform specific tasks on objects (bots, folders, and files) that you have permission to access in the Control Room.
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.
Automations API Use the v2 Bot Scheduler APIs (Automation APIs) to create, update, delete, and return details on scheduled automations.
Policy Management API Use the v2 Policy Management APIs to manage code analysis, policies, and rules within Control Room.

v3 Endpoints

Modules Description
Bot deploy API Use the v3 Bot Deploy API to deploy bots from the public workspace to Bot Runner devices.
Workload Management API Use the v3 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 Use the v3 Bot Execution Orchestrator APIs to monitor automation activity progress.

v4 Endpoints

Modules Description
Bot deploy API (V4) Use the v4 Bot Deploy API to deploy bots from the public workspace to Bot Runner devices.
Workload Management API Use the v4 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 v4 migration APIs to migrate TaskBots and MetaBots that were created in Enterprise client versions Enterprise 11 and Enterprise 10 to Automation 360.
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:

API deprecation policy

API 지원 중단은 API 사용이 더 이상 권장되지 않지만 작동은 한다는 것을 나타냅니다. 개발자들은 최신 지원 버전의 API로 마이그레이션하는 것이 좋습니다. API는 원활한 전환을 위해 EoL(지원 종료) 날짜와 릴리스 버전까지 제공됩니다.

API EoL(지원 종료)이란 API가 더 이상 작동하지 않고, 더 이상 사용할 수 없게 되는 날짜와 릴리스 버전을 나타냅니다. 개발자들은 이 날짜 전에 최신 지원 버전의 API로 마이그레이션을 완료했어야 합니다.

다음 시나리오에서는 API 지원 중단이 필요할 수 있습니다.

  • 보안 취약점: 이전 API 버전에는 최신 버전에서 수정된 알려진 보안 취약점이 포함되어 있습니다.
  • 기술 부채 이전 API 버전은 더 이상 지원되지 않는 오래된 기술, 접근 방식 또는 프레임워크를 기반으로 구축될 수 있어 유지 관리나 개선이 어렵습니다.
  • 성능: 이전 API 버전은 최신 유스케이스나 규모 증가에 최적화되어 있지 않아 성능 저하와 느린 응답 시간을 초래합니다.
  • 사용자 경험: 지원 중단된 API 버전에는 사용자가 탐색하기 어렵게 만드는 혼란스럽거나 중복된 엔드포인트가 포함될 수 있습니다.

API는 최소 2년 동안 지원됩니다. 2년 후 API 지원 중단이 발표될 수 있으며, API는 최소 1년(4번의 릴리스) 동안 제공되어 최신 버전으로 전환할 충분한 시간을 제공합니다.

Note: 위 정책은 공개 API의 보안 취약점으로 인한 사용 중단에는 적용되지 않습니다. 이러한 케이스에서는 위험을 완화하기 위해 즉각적인 조치가 필요하며, 가능한 한 빨리 이러한 변경 사항을 알리기 위해 모든 노력을 기울일 것입니다.