Scheduled Tasks

Update scheduled task

Updates task configuration. Same validation rules as creation apply. Requires admin role.

put/api/scheduled-tasks/{id}

Path parameters

idinteger required

Numeric resource ID.

Request body

namestring

target_type'stack' | 'fleet' | 'system' | 'container'

target_idstring

Stack or container name when target_type is stack or container.

node_idinteger

action'restart' | 'snapshot' | 'prune'

cron_expressionstring

enabledboolean

prune_targetsstring[]

target_servicesstring[]

prune_label_filterstring

Response

Task updated.

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 * * *"
}

Changes

Changed in 5 of the 36 revisions of this API.1510

Jul 3, 2026c02adce2861311See the full diff
- ●
  added the new container enum value to the target_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new container enum value to the request property target_type
  request-property-enum-value-added
Jun 4, 2026d58cf9d6195b4See the full diff
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500
  response-property-enum-value-removed
Apr 5, 20267464894ea58244See the full diff
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 500
  response-property-enum-value-added
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 500
  response-property-enum-value-removed
Apr 5, 2026a202861afa641See the full diff
- ○
  endpoint added
  endpoint-added
Apr 3, 202682927cbcc9f71See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation

Full history