DELETE /queue/{guid}
Remove a queue job from the system
/queue/{guid}
DELETE
Remove a queue job from the system
| Key | Type | Example | Description |
|---|---|---|---|
| guid required | string |
"example-string"
|
Unique identifier of the queue job to delete
|
| Key | Type | Example | Description |
|---|---|---|---|
| authorization required | string |
"Bearer access_token"
|
Access token
|
| Key | Type | Example | Description |
|---|---|---|---|
| reason optional | string |
"example-string"
|
Reason for deletion
|
| force optional | boolean |
false
|
Force deletion even if job is running
|
{
"guid": "example-string"
}
{
"error": "ERROR"
}
| Status | Error Code | Description |
|---|---|---|
404 |
ERROR |
Queue job not found |
409 |
ERROR |
Cannot delete running job without force flag |
| Permission | Description |
|---|---|
Bearer token |
Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
queue_remove |
Required scope: queue_remove |
Back to Queue Return to the Queue category to view other endpoints All API Categories Browse all available API categories