Delete Pending Collections
Delete all collection runs currently queued for execution.
GET https://instance.securid.com/aveksa/command.submit?cmd=deletePendingCollections
note
Requires a user with System:Manage privilege. Runs that are already executing are not affected.
Request
Parameters
| deletePendingCollections | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
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=deletePendingCollections&format=json" \
-H "Authorization: Bearer <token>"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "deletePendingCollections",
"format": "json"
}
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: "deletePendingCollections",
format: "json"
};
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
Returns success whether or not there were any pending collections to delete.
{
"data": {
"type": "deletePendingCollections",
"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 'deletePendingCollections'. Token is invalid or expired</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.