Throttle a delete by query operation

POST /_delete_by_query/{task_id}/_rethrottle

Copy endpoint

Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

Parameters

path Path Parameters

Name	Type
`task_id` required The ID for the task.	type TypesTaskId = string

query Query Parameters

Name	Type
`requests_per_second` required The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`.	number

Responses

200 application/json

interface TasksTypesTaskListResponseBase {
node_failures?:

TypesErrorCause

Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

interface TypesErrorCause {
type: string;
reason?: string | null;
stack_trace?: string;
caused_by?: TypesErrorCause;
root_cause?: TypesErrorCause[];
suppressed?: TypesErrorCause[];
}

[];
task_failures?:

TypesTaskFailure

interface TypesTaskFailure {
task_id: number;
node_id: TypesNodeId;
status: string;
reason: TypesErrorCause;
}

[];
nodes?: { };
tasks?:

TasksTypesTaskInfos

type TasksTypesTaskInfos = { } | TasksTypesTaskInfo[]

;
}