Pause a scheduled job

POST 
/api/v1/scheduler/pause-job

Pauses future scheduling for the job. A dispatch already admitted or in flight can still complete; pausing is not remote-effect cancellation.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Manage jobs

Request

Responses

200

Scheduled job paused

Replace scheduleId with the ID returned when the job was created.

Section ID: DOC-CP-scheduling-api-pauseJob#example-scheduled-jobs-pauseJob-request

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718"
}

Guide request for 3. Let the user take a temporary break. Replace example resource identifiers with your own authorized values.

Section ID: DOC-CP-scheduling-api-pauseJob#example-cookbook-core-platform-scheduling-managing-04-1-request

Request example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "reason": "Target service under maintenance"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-scheduling-api-pauseJob#example-scheduled-jobs-pauseJob-response

Response example

{
  "scheduleId": "sched_a1b2c3d4e5f60718",
  "tenantId": "example_123",
  "projectId": "example_123",
  "ownerSubject": "example",
  "name": "example",
  "description": "example",
  "scheduleType": "SCHEDULE_TYPE_CRON",
  "cronExpression": "0 9 * * *",
  "timezone": "example",
  "scheduledAt": "2026-09-16T12:00:00Z",
  "intervalSeconds": 1,
  "target": {
    "url": "https://example.com/callback",
    "method": "example",
    "kind": "example",
    "payload": {
      "example": "value"
    }
  },
  "state": "SCHEDULE_STATUS_ACTIVE",
  "retryPolicy": {
    "maxAttempts": 1,
    "initialBackoffMs": 1,
    "maxBackoffMs": 1
  },
  "metadata": {
    "example": "value"
  },
  "autoPauseThreshold": 1,
  "externalId": "example_123",
  "createdAt": "2026-09-16T12:00:00Z",
  "createdBySubject": "example",
  "updatedAt": "2026-09-16T12:00:00Z",
  "updatedBySubject": "example",
  "pausedAt": "2026-09-16T12:00:00Z",
  "pausedBySubject": "example",
  "pausedReason": "example",
  "resumedAt": "2026-09-16T12:00:00Z",
  "resumedBySubject": "example",
  "deletedAt": "2026-09-16T12:00:00Z",
  "deletedBySubject": "example",
  "lastTriggeredAt": "2026-09-16T12:00:00Z",
  "nextTriggerAt": "2026-09-16T12:00:00Z",
  "triggerCount": "1",
  "failureCount": "1",
  "consecutiveFailureCount": "1"
}

Document ID: DOC-CP-scheduling-api-pauseJob. Section identities and revisions.

Section	Stable reference
Pause a scheduled job	DOC-CP-scheduling-api-pauseJob#overview
Request	DOC-CP-scheduling-api-pauseJob#request
Responses	DOC-CP-scheduling-api-pauseJob#responses