Delete job by ID

DELETE

/api/queue/{name}/jobs/{id}

const url = 'https://example.com/api/queue/conversion/jobs/example';
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/example \
  --header 'Authorization: Bearer <token>'

Removes a specific job from a queue

Authorizations

bearerAuth

Parameters

Path Parameters

name

required

Queue name

string

Example

conversion

required

Job ID

string

Responses

200

Job removed successfully

application/json

object

status

required

Operation status

string

message

required

Status message

string

Example

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

400

Failed to remove job

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"
}