Summary
Deletes a list of provided root jobs and all their related items
Description
Only succeeds on completed or cancelled root jobs. Ignores jobs that don't fit that criteria. Recursively deletes children, tasks, job data, job history, and large files. Does not return details of specific document deletion
Route
POST /operations-manager/jobs/bulk-delete
Roles
admin
apiwrite
engineering
operations
Parameters
Details Example Schema
Name
Type
Required
Description
jobIds
array
yes
Array of job ids to remove.
Copied to Clipboard
{
"jobIds": [
"45da240f694f7317aae9231e",
"70ae41eab6cff0da1c0fb589",
"46e878b0e4f0eab7ff11db0b"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"jobIds": {
"title": "jobIds",
"type": "array",
"items": {
"$ref": "common#/definitions/ObjectIdLikeString"
}
}
},
"required": [
"jobIds"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
object
The results of each root delete jobs operation and total number of items deleted per collection.
Copied to Clipboard
{
"message": "aliqua aliquip enim eiusmod",
"data": {
"jobsDeleted": 24073721,
"tasksDeleted": 32019682,
"jobHistoryDeleted": -21277039,
"jobDataDeleted": 62148238,
"jobDataLargeFilesDeleted": 44367125,
"results": []
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"jobsDeleted": {
"type": "integer"
},
"tasksDeleted": {
"type": "integer"
},
"jobHistoryDeleted": {
"type": "integer"
},
"jobDataDeleted": {
"type": "integer"
},
"jobDataLargeFilesDeleted": {
"type": "integer"
},
"results": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"metadata": {
"type": "object"
}
}
}
