Skip to content

job/delete

Deletes one or more jobs and removes them from the queue.

Method and path

POST /job/delete

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1 and 2 users.

Request headers

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.
Content-Typeyesapplication/json.

Request body

FieldTypeRequiredDescription
job_idintegerarray<integer>yes

The endpoint also accepts a job id in the path, but the JSON body form is the stable documented variant.

Example request

bash
curl -X POST "$SIGNAL_API_BASE_URL/job/delete" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id": ["<job_id>", "<job_id>"]}'
json
{
  "job_id": [
    "<job_id>",
    "<job_id>"
  ]
}

Example response

Single job:

json
{
  "message": "Job <job_id> deleted"
}

Bulk delete:

json
"<deleted_count> jobs deleted"

Response fields

FieldTypeDescription
messagestringPresent for single-job deletion.
Response bodystringFor bulk deletion, the endpoint returns a plain JSON string message.

Notes

  • The endpoint removes queue entries before deleting the job record.
  • Linked rows in the job-to-project relation table are deleted before the job record is removed.

Doc rev.1.12.3 2026.05.08