Delete Job APIedit

Warning

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

This API deletes an existing rollup job. The job can be started or stopped, in both cases it will be deleted. Attempting to delete a non-existing job will throw an exception

Requestedit

DELETE _xpack/rollup/job/<job_id>

Path Parametersedit

job_id (required)
(string) Identifier for the job

Request Bodyedit

There is no request body for the Delete Job API.

Authorizationedit

You must have manage or manage_rollup cluster privileges to use this API. For more information, see Security Privileges.

Examplesedit

If we have a rollup job named sensor, it can be deleted with:

DELETE _xpack/rollup/job/sensor

Which will return the response:

{
  "acknowledged": true
}

If however we try to delete a job which doesn’t exist:

DELETE _xpack/rollup/job/does_not_exist

A 404 resource_not_found exception will be thrown:

{
    "error" : {
        "root_cause" : [
            {
                "type" : "resource_not_found_exception",
                "reason" : "the task with id does_not_exist doesn't exist",
                "stack_trace": ...
            }
        ],
        "type" : "resource_not_found_exception",
        "reason" : "the task with id does_not_exist doesn't exist",
        "stack_trace": ...
    },
    "status": 404
}