Sign in

v34

latestOpenAPI 3.1.0AGPL-3.0-onlyraw.githubusercontent.com2026-08-018932140.9 KB
Scheduled Tasks

Create scheduled task

Creates a new recurring task. Action-target rules:

  • restart requires target_type: stack or target_type: container (with target_id and node_id)
  • auto_stop and auto_start accept target_type: stack or target_type: container
  • snapshot requires target_type: fleet
  • prune requires target_type: system

Requires admin role.

post/api/scheduled-tasks

Request body

namestring required
target_type'stack' | 'fleet' | 'system' | 'container' required
target_idstring

Stack or container name (required when target_type is stack or container).

node_idinteger

Target node ID (required when target_type is stack or container).

action'restart' | 'snapshot' | 'prune' required
cron_expressionstring required

Standard 5-field cron expression.

enabledboolean
prune_targetsstring[]

Resources to prune (only for prune action).

target_servicesstring[]

Specific services to restart (only for restart action).

prune_label_filterstring

Docker label filter for prune operations.

Example request

{
  "name": "Nightly restart",
  "cron_expression": "0 3 * * *"
}

Response

Task created.

idinteger required
namestring required
target_type'stack' | 'fleet' | 'system' | 'container' required
target_idstring nullable

Stack or container name (when target_type is stack or container).

node_idinteger nullable

Target node ID (when target_type is stack or container).

action'restart' | 'snapshot' | 'prune' required
cron_expressionstring required

Standard cron expression (5 fields).

enabled0 | 1 required
created_bystring required
created_atinteger required

Unix timestamp (seconds).

updated_atinteger required

Unix timestamp (seconds).

last_run_atinteger nullable
next_run_atinteger nullable
last_statusstring nullable
last_errorstring nullable
prune_targetsstring nullable

JSON-stringified array of prune targets (containers, images, networks, volumes).

target_servicesstring nullable

JSON-stringified array of service names to restart.

prune_label_filterstring nullable

Docker label filter for prune operations.

Example response

{
  "cron_expression": "0 3 * * *"
}