kimdre/doco-cd v0.87.0

on GitHub

What's Changed

Fixed a bug that caused jobs to always be scheduled with UTC timezone instead of the local/set timezone.

This release also adds two new API endpoints to list and trigger scheduled jobs (introduced in v0.86.0), see also the REST API documentation.

What is the jobName for a scheduled job?
jobName is the runtime name of the scheduled target:

• Docker (standalone): the container name (for example my-stack-backup-1)
• Docker Swarm: the service name (for example my-stack_backup)

How do I find the jobName for a scheduled job?
You can get the jobName from the scheduler logs ("job":"...") or from GET /v1/api/jobs.

• If multiple jobs share the same jobName, provide stack to disambiguate for the run endpoint.
• If the matched job is disabled, the run endpoint returns a conflict response.

Common run endpoint outcomes

• 200 OK: run triggered and completed (wait=true).
• 202 Accepted: run accepted and running in background (wait=false).
• 404 Not Found: no scheduled job matched jobName (and optional stack).
• 409 Conflict: matched job is disabled or the selection is ambiguous.

Example Request

Trigger a job by container name

curl --request POST \
  --url 'https://cd.example.com/v1/api/job/my-stack-backup-1/run?wait=true' \
  --header 'x-api-key: your-api-key'

Trigger a job by service name in a specific stack

curl --request POST \
  --url 'https://cd.example.com/v1/api/job/backup/run?stack=my-stack&wait=true' \
  --header 'x-api-key: your-api-key'

List all scheduled jobs for a specific stack

curl --request GET \
  --url 'https://cd.example.com/v1/api/jobs?stack=my-stack' \
  --header 'x-api-key: your-api-key'

✨ Features

• feat(api): add API endpoints for managing scheduled jobs by @kimdre in #1329

Full Changelog: v0.86.0...v0.87.0