Summary
Cancels Jobs
Description
Cancel Active Jobs.
Route
POST /operations-manager/jobs/cancel
Roles
admin
engineering
apiwrite
operations
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| jobIds |
array |
yes |
The ids of the Jobs to cancel. |
Copied to Clipboard
{
"jobIds": [
"0e1db63ffa914ebc16fe0e64",
"6263abf4da4044381bb7d4c5",
"df9e00c38a412cd46ce9c0bf",
"d9e3560a50b02a88f82d2e0e",
"2fa26217e6a08d0e69e83b16"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"jobIds": {
"type": "array",
"title": "jobIds",
"items": {
"$ref": "common#/definitions/ObjectIdLikeString"
}
}
},
"required": [
"jobIds"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| resultMessage |
object |
The result of the cancel operation. |
Copied to Clipboard
{
"message": "Successfully retrieved search results",
"data": {
"description": "Any successfully retrieved information related to the request."
}
}
