job/off

Deactivates one or more jobs.

Method and path

POST /job/off

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1 and 2 users.

Request headers

Header	Required	Description
X-Api-Key or X_API_KEY	yes	API key.
Content-Type	yes	application/json.

Request body

Field	Type	Required	Description
job_id	integer	array<integer>	yes

Example request

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

{
  "job_id": "<job_id>"
}

Example response

Single job:

{
  "id": "<job_id>",
  "type": "<job_type>",
  "active": false,
  "freq": "<frequency_seconds>",
  "label": "Example Job",
  "notes": "Example notes",
  "search": "<search_string_or_json>",
  "lastrun": "<datetime_or_null>"
}

Bulk update:

[
  {
    "id": "<job_id>",
    "type": "<job_type>",
    "active": false,
    "freq": "<frequency_seconds>",
    "label": "Example Job",
    "notes": "Example notes",
    "search": "<search_string_or_json>",
    "lastrun": "<datetime_or_null>"
  }
]

Notes

• The endpoint removes matching queue entries after deactivation.
• For single-job requests, non-admin users are additionally restricted to jobs linked to accessible projects.