Delete Pending Run
Delete a single run that is queued for execution.
GET https://instance.securid.com/aveksa/command.submit?cmd=deletePendingRun
note
Requires a user with System:Manage privilege. Only runs in New (queued) state can be deleted. Runs that have already started or completed return a 400 error.
Request
Parameters
| deletePendingRun | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
The numeric ID of the run to delete. Retrieve this from the run-id field returned by any collect command. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
status | Result of the operation. Returns success on success. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=deletePendingRun&format=json&run-id=1001" \
-H "Authorization: Bearer <token>"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "deletePendingRun",
"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: "deletePendingRun",
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 (JSON)
- 200 (Properties)
- 401 Invalid Token
- 400 Not Pending
- 404 Invalid run-id
- 412 Missing run-id
- 500 Non-numeric run-id
{
"data": {
"type": "deletePendingRun",
"status": "success"
}
}
Default format when format is omitted.
status=success
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'deletePendingRun'. Token is invalid or expired</body>
</html>
Returned when the run has already started or completed and is no longer in a deletable state.
<html>
<head>
<title>Error</title>
</head>
<body>Provided run-id is not in pending state, run-id=1001, please provide a valid run-id
Query String=cmd=deletePendingRun&format=json&run-id=1001</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=deletePendingRun&format=json&run-id=999999</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter run-id is required.
Query String=cmd=deletePendingRun&format=json</body>
</html>
Returned when run-id is not a valid integer. The server exposes a raw Java exception instead of a structured error (BUG-017).
<html>
<head>
<title>Error</title>
</head>
<body>java.lang.NumberFormatException: For input string: "abc"</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.