Sign in
admin-river
admin

Delete matching jobs from a River queue

Changed on
post/admin/river/queues/{name}/clear

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/admin/river/queues/{name}/clear
  • Auth: API key in cookie evelogin

Request body

limitinteger
statesstring[] nullable required

Final or waiting states to delete. Running jobs cannot be cleared.

Response

OK

deletedinteger required
queuestring required

Changes