Skip to main content
Version: 24.05

Jobs - API Documentation

Overview​

Jobs endpoints let global administrators list the scheduled background jobs of the server and suspend or resume a job.

Endpoint Index​

Access & Permissions​

  • Both endpoints require a global administrator.
  • Both endpoints require the app_id parameter, even though jobs are not tied to an app.

Feature Behavior​

  • Job statuses are returned as text: SCHEDULED, RUNNING, DONE, CANCELLED, ABORTED, PAUSED, WAITING or SUSPENDED.
Implementation details

Database Collections

CollectionPurpose
countly.jobsStores scheduled jobs and their run history.