DELETE /queue/{guid}
Remove a queue job from the system
/queue/{guid}
DELETE
Remove a queue job from the system
Key | Type | Example | |
---|---|---|---|
:guid required | string |
"example-guid"
|
Key | Type | Example | |
---|---|---|---|
authorization required | string |
"Bearer your-jwt-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"
}
{
"success": false,
"error": "ERROR_KEY"
}
Error Code | Description |
---|---|
HTTP_404 | Queue job not found |
HTTP_409 | Cannot delete running job without force flag |
permission | description |
---|---|
BearerAuth |
JWT access token obtained from login endpoint required |
Back to Queue Return to the Queue category to view other endpoints All API Categories Browse all available API categories