Clean jobs from queue

DELETE

/api/queue/{name}/jobs

const url = 'https://example.com/api/queue/conversion/jobs?jobState=completed';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url 'https://example.com/api/queue/conversion/jobs?jobState=completed' \
  --header 'Authorization: Bearer <token>'

Removes all jobs in a specific state from the queue

Authorizations

bearerAuth

Parameters

Path Parameters

name

required

Queue name

string

Example

conversion

Query Parameters

jobState

required

Job state to clean (required)

string

Allowed values: completed failed

Responses

200

Jobs cleaned successfully

application/json

object

status

required

Operation status

string

message

required

Status message

string

Example

{
  "status": "Success",
  "message": "Job removed from queue"
}

400

Missing jobState parameter or failed to remove jobs

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}