Scheduler executions API — view history and retry jobs

API reference for Alphabet scheduler execution endpoints: view history, get execution details, cancel running jobs, and retry failed executions.

Execution records track every run of a scheduler job, capturing status, timing, output, and retry information. Use these endpoints to monitor job health, diagnose failures, cancel in-progress runs, and queue retries.

List executions for a job

GET /api/v1/scheduler/jobs/{jobId}/executions

Returns a paged history of executions for a specific job. You can filter by status and date range.

Path parameters

jobId · guid · required

The unique identifier of the job whose executions you want to list.

Query parameters

pageNumber · integer

Page number to retrieve (1-based). Defaults to 1.

pageSize · integer

Number of records per page. Defaults to 20.

status · string

Filter by execution status. One of: Pending, Running, Succeeded, Failed, Cancelled.

fromDate · datetime

Return executions that started at or after this ISO 8601 timestamp.

toDate · datetime

Return executions that started at or before this ISO 8601 timestamp.

Response

200 OK — returns PagedResponseDto<JobExecutionDto>.

id · guid

Unique identifier for the execution.

jobId · guid

Identifier of the job this execution belongs to.

status · string

Execution status: Pending, Running, Succeeded, Failed, or Cancelled.

startedAt · datetime

Timestamp when the execution began.

completedAt · datetime

Timestamp when the execution finished (null if still running).

duration · string

Wall-clock time the execution took to complete.

retryCount · integer

Number of retry attempts made for this execution.

Example

curl -X GET "https://api.example.com/api/v1/scheduler/jobs/b2e4c1d0-1234-4abc-8def-000000000001/executions?status=Failed&pageSize=10" \
  -H "Authorization: Bearer <token>"

---

Get execution details

GET /api/v1/scheduler/executions/{executionId}

Returns the full detail record for a single execution, including output, error message, duration, retry count, and final status.

Path parameters

executionId · guid · required

The unique identifier of the execution.

Response

200 OK — returns a JobExecutionDto with full detail fields.

id · guid

Unique identifier for the execution.

jobId · guid

Identifier of the parent job.

status · string

Final status: Pending, Running, Succeeded, Failed, or Cancelled.

startedAt · datetime

Timestamp when the execution began.

completedAt · datetime

Timestamp when the execution finished.

duration · string

Total elapsed time.

retryCount · integer

Number of retry attempts made.

output · string

Captured output or response body from the job run.

errorMessage · string

Error detail if the execution failed.

404 Not Found — returns ProblemDetails when no execution with that ID exists.

---

Cancel an execution

POST /api/v1/scheduler/executions/{executionId}/cancel

Attempts to cancel a still-running execution. If the execution has already completed, succeeded, or failed, the API returns a 409 Conflict.

Path parameters

executionId · guid · required

The unique identifier of the execution to cancel.

Response

200 OK — the execution was cancelled successfully.

409 Conflict — returns ProblemDetails when the execution is no longer in a cancellable state.

Cancellation is best-effort. Depending on the job type and how far along execution is, the underlying work may have already completed before the cancellation takes effect.

---

Retry a failed execution

POST /api/v1/scheduler/executions/{executionId}/retry

Queues a new execution for the same job, using the selected failed execution as the retry parent. Returns the new execution ID so you can track the retry attempt.

Path parameters

executionId · guid · required

The unique identifier of the failed execution to retry.

Response

202 Accepted — returns the new execution ID (guid) in the response body. The Location header points to /api/v1/scheduler/executions/{newExecutionId}.

400 Bad Request — returns ProblemDetails if the retry could not be queued (e.g. the source execution does not exist or is not in a failed state).

Example

# Retry a failed execution
curl -X POST "https://api.example.com/api/v1/scheduler/executions/e9d3a2f1-0000-4111-bbb2-cccccccccccc/retry" \
  -H "Authorization: Bearer <token>"

---

Get dashboard statistics

GET /api/v1/scheduler/dashboard/stats

Returns aggregate health and activity metrics for the scheduler, useful for building monitoring dashboards.

Response

200 OK — returns DashboardStatsDto.

totalJobs · integer

Total number of jobs registered in the scheduler.

enabledJobs · integer

Number of jobs currently in an enabled (active) state.

successRate · number

Percentage of executions that succeeded over the recent window.

upcomingExecutions · integer

Count of executions scheduled to run in the near future.

recentFailures · integer

Count of failed executions in the recent window.

---

Get repeatedly failing jobs

GET /api/v1/scheduler/jobs/failed?threshold=3

Returns jobs whose consecutive failure count meets or exceeds the specified threshold. Use this endpoint to surface jobs that need attention.

Query parameters

threshold · integer

Minimum consecutive failure count to include a job in the results. Defaults to 3.

Response

200 OK — returns an array of JobDto objects for jobs meeting the failure threshold.

---

Get execution timeline

GET /api/v1/scheduler/executions/timeline?hours=24

Returns time-bucketed execution counts for the specified look-back window. Use this data to render execution trend charts.

Query parameters

hours · integer

Number of hours to look back from now. Defaults to 24.

Response

200 OK — returns an array of TimelinePointDto.

timestamp · datetime

The start of this time bucket.

succeeded · integer

Number of executions that succeeded in this bucket.

failed · integer

Number of executions that failed in this bucket.

running · integer

Number of executions still running at this bucket boundary.