Skip to main content
Uzumaki
Navigator | Tier 3
August 26, 2026
Solved

Using the control room API to monitor running bots

  • August 26, 2026
  • 3 replies
  • 26 views

Just curious if anyone has had any success using control room APIs to keep track of bots that are currently running. I am trying to develop a system to detect bots that have been running for excessively long so that they can be auto shut down and wanted to know if anyone has had success doing this using control room APIs or another method.

Best answer by Aaron.Gleason

@Uzumaki Yes! I believe this has been discussed in the past on this message board, but let’s look at the API calls needed.

/v2/authentication (obviously)

/v3/activity/list - searches automation executions

This API call requires some sort of a filter, which can be just a paging filter. Here’s the filter I chose as a test:

{
"filter": {
"operator": "eq",
"value": "RUN_FAILED",
"field": "status"
},
"page": {
"offset": 0,
"length": 100
}
}

Unfortunately, a “ne” (not equal) filter of “COMPLETED” on the “status” field is not allowed.  🤨

Values are (case-sensitive!): UPDATE, INPROGRESS, PENDING_EXECUTION, QUEUED, RUN_FAILED, DEPLOY_FAILED, COMPLETED, and I think there are others. The INPROGRESS flag might be what you need to see processes in action.

You’ll receive back from the API things like the id of the bot run, the startDateTime and endDateTime, status, userId, and other possibly helpful information.

{
"page": {
"offset": 0,
"total": 108290,
"totalFilter": 82624
},
"list": [
{
"id": "afc898d8-ccd7-4c12-b133-7204816ba38a",
"automationName": "AARI requestId-100045417, ref-6049-6, deployOwnerId-100055566",
"fileName": "Scheduling Agent",
"filePath": "",
"type": "AARI",
"startDateTime": "2026-08-26T15:23:26.895609Z",
"endDateTime": "2026-08-26T15:23:39.968966Z",
"command": "ai-agent-planner",
"status": "COMPLETED",
"progress": 100,
"automationId": "",
"userId": "100055566",
"deviceId": "-1",
"currentLine": 1,
"totalLines": 1,
"fileId": "100169324",
"modifiedBy": "100055566",
"createdBy": "100055566",
"modifiedOn": "2026-08-26T15:23:40.339396Z",
"createdOn": "2026-08-26T15:23:22.105788Z",
"deploymentId": "400f45eb-6e07-4fea-bf6d-b56057b35219",
"queueName": "",
"queueId": "",
"usingRdp": false,
"message": "",
"canManage": true,
"deviceName": "",
"userName": "lidya4125619",
"tenantUuid": "0a663e91-9a57-1638-819a-8506cc8b003a",
"automationPriority": "PRIORITY_MEDIUM",
"callbackInfo": "",
"runElevated": false,
"botLabel": "",
"currentBotName": "Scheduling Agent",
"rolesWithAccess": [],
"workspaceType": "UNKNOWN",
"systemBot": false,
"initiationType": "AARI",
"activityType": "API_TASK",
"deviceHostType": "",
"error": {
"message": "",
"details": "",
"correctiveAction": "",
"code": "",
"messageValues": [],
"detailsValues": [],
"correctiveActionValues": []
},
"userGroupName": "",
"description": ""
}...

Hope that helps!

3 replies

Uzumaki
UzumakiAuthor
Navigator | Tier 3
August 26, 2026

Got it figured out. In progress automation metadata can be viewed using the information provided in the best answer here:
 

 

Aaron.Gleason
Automation Anywhere Team
Automation Anywhere Team
August 26, 2026

@Uzumaki Yes! I believe this has been discussed in the past on this message board, but let’s look at the API calls needed.

/v2/authentication (obviously)

/v3/activity/list - searches automation executions

This API call requires some sort of a filter, which can be just a paging filter. Here’s the filter I chose as a test:

{
"filter": {
"operator": "eq",
"value": "RUN_FAILED",
"field": "status"
},
"page": {
"offset": 0,
"length": 100
}
}

Unfortunately, a “ne” (not equal) filter of “COMPLETED” on the “status” field is not allowed.  🤨

Values are (case-sensitive!): UPDATE, INPROGRESS, PENDING_EXECUTION, QUEUED, RUN_FAILED, DEPLOY_FAILED, COMPLETED, and I think there are others. The INPROGRESS flag might be what you need to see processes in action.

You’ll receive back from the API things like the id of the bot run, the startDateTime and endDateTime, status, userId, and other possibly helpful information.

{
"page": {
"offset": 0,
"total": 108290,
"totalFilter": 82624
},
"list": [
{
"id": "afc898d8-ccd7-4c12-b133-7204816ba38a",
"automationName": "AARI requestId-100045417, ref-6049-6, deployOwnerId-100055566",
"fileName": "Scheduling Agent",
"filePath": "",
"type": "AARI",
"startDateTime": "2026-08-26T15:23:26.895609Z",
"endDateTime": "2026-08-26T15:23:39.968966Z",
"command": "ai-agent-planner",
"status": "COMPLETED",
"progress": 100,
"automationId": "",
"userId": "100055566",
"deviceId": "-1",
"currentLine": 1,
"totalLines": 1,
"fileId": "100169324",
"modifiedBy": "100055566",
"createdBy": "100055566",
"modifiedOn": "2026-08-26T15:23:40.339396Z",
"createdOn": "2026-08-26T15:23:22.105788Z",
"deploymentId": "400f45eb-6e07-4fea-bf6d-b56057b35219",
"queueName": "",
"queueId": "",
"usingRdp": false,
"message": "",
"canManage": true,
"deviceName": "",
"userName": "lidya4125619",
"tenantUuid": "0a663e91-9a57-1638-819a-8506cc8b003a",
"automationPriority": "PRIORITY_MEDIUM",
"callbackInfo": "",
"runElevated": false,
"botLabel": "",
"currentBotName": "Scheduling Agent",
"rolesWithAccess": [],
"workspaceType": "UNKNOWN",
"systemBot": false,
"initiationType": "AARI",
"activityType": "API_TASK",
"deviceHostType": "",
"error": {
"message": "",
"details": "",
"correctiveAction": "",
"code": "",
"messageValues": [],
"detailsValues": [],
"correctiveActionValues": []
},
"userGroupName": "",
"description": ""
}...

Hope that helps!

Uzumaki
UzumakiAuthor
Navigator | Tier 3
August 26, 2026

This is great, I appreciate the thorough response. This is exactly what I’m trying to accomplish, filter by status eq INPROGRESS and comparing start time to current time. My org is considering active batch to run this check and fire off notifications to the team and/or auto shut down the automation.