Get Run Status
Get the status of a collection or review generation run.
GET https://instance.securid.com/aveksa/command.submit?cmd=getRunStatus
note
Requires a user with System:Manage privilege.
Request
Parameters
| getRunStatus | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
The numeric ID of the run. Retrieve this from the run-id field returned by any collect command. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
overall-status | The current status of the run. Confirmed values: New Running Completed Aborted |
start-time | The time the run started. |
completed-time | The time the run ended. Present when overall-status is Completed or Aborted. For aborted runs, completed-time equals start-time. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getRunStatus&format=json&run-id=1001" \
-H "Authorization: Bearer <token>"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "getRunStatus",
"format": "json",
"run-id": "1001"
}
headers = {
'Authorization': 'Bearer <token>'
}
response = requests.get(url, params=params, headers=headers)
if response.status_code == 200:
data = response.json()
print(data)
else:
print(f"Request failed with status code {response.status_code}")
const axios = require('axios');
const url = "https://instance.securid.com/aveksa/command.submit";
const params = {
cmd: "getRunStatus",
format: "json",
"run-id": "1001"
};
const headers = {
'Authorization': 'Bearer <token>'
};
axios.get(url, { params, headers })
.then(response => {
if (response.status === 200) {
console.log(response.data);
} else {
console.log(`Request failed with status code ${response.status}`);
}
})
.catch(error => {
console.error('Error:', error);
});
Response
- 200 Running
- 200 Completed
- 200 Aborted
- 200 (Properties)
- 401 Invalid Token
- 404 Invalid run-id
- 412 Missing run-id
- 412 Non-numeric run-id
completed-time is absent while the run is in progress.
{
"data": {
"type": "getRunStatus",
"overall-status": "Running",
"start-time": "2026-01-15 10:00:00"
}
}
{
"data": {
"type": "getRunStatus",
"overall-status": "Completed",
"start-time": "2026-01-15 10:00:00",
"completed-time": "2026-01-15 10:05:00"
}
}
completed-time is present for aborted runs and equals start-time.
{
"data": {
"type": "getRunStatus",
"overall-status": "Aborted",
"start-time": "2026-01-15 10:00:00",
"completed-time": "2026-01-15 10:00:00"
}
}
Default format when format is omitted.
overall-status=Running
start-time=2026-01-15 10:00:00
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'getRunStatus'. Token is invalid or expired</body>
</html>
Returned when the run-id does not match any run.
<html>
<head>
<title>Error</title>
</head>
<body>The run-id 999999 is invalid.
Query String=cmd=getRunStatus&format=json&run-id=999999</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter run-id is required.
Query String=cmd=getRunStatus&format=json</body>
</html>
Returned when run-id is not a valid integer.
<html>
<head>
<title>Error</title>
</head>
<body>The parameter run-id was unable to be parsed into a long.
Query String=cmd=getRunStatus&format=json&run-id=abc</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.