Drain a queue

POST

/api/jobs/queues/{name}/drain

Remove all waiting, prioritized, and delayed jobs from a queue. Active jobs keep running, and delayed jobs owned by a Job Scheduler are kept — draining a scheduler queue does not unschedule its recurring work.

Parameters

Path Parameters

name*

Queue name

Type

string

Required

Min Length

1

Responses

Queue drained

Content-Type

application/json

{

  

"success": true,

  

"queue": "string"

}

POST

/api/jobs/queues/{name}/drain

Samples