Table of Contents

API : Tools: Scheduled jobs : Enabled

Introduction

Pauses or resumes a recurring job. A paused job stays in the list but is never picked up by the scheduler.

Resuming clears the failure counter and recomputes when from the recurrence, so a job that was auto-paused after repeated failures is not given up on again immediately.

Request

URL https://api.telecomx.dk/tools/scheduledjobs/:id/enabled
Method POST
Access level Admin

Body

Field Type Required Description
enabled Boolean Yes True to resume the schedule, false to pause it.

Query example

https://api.telecomx.dk/tools/scheduledjobs/6a2a6b21db0276bd0a548391/enabled

Response

{ "success": true }

Errors

Error code Message Description
400 invalid_data The id is not a valid ObjectId, or the job does not recur
403 access_denied Insufficient access level
404 not_found No job has that id
500 internal_error <Unspecified>