List Schedules

curl --request GET \
  --url https://api.example.com/api/schedules

{
  "schedules": [
    {
      "id": 1,
      "type": "container_update",
      "name": "Update container: nginx",
      "entityName": "nginx",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "daily",
      "cronExpression": "0 3 * * *",
      "nextRun": "2026-03-05T03:00:00.000Z",
      "lastExecution": {
        "id": 123,
        "startedAt": "2026-03-04T03:00:00.000Z",
        "completedAt": "2026-03-04T03:01:45.000Z",
        "status": "success"
      },
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical_high"
    },
    {
      "id": 2,
      "type": "git_stack_sync",
      "name": "Git sync: my-stack",
      "entityName": "my-stack",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "weekly",
      "cronExpression": "0 2 * * 1",
      "nextRun": "2026-03-10T02:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false
    },
    {
      "id": 3,
      "type": "env_update_check",
      "name": "Update environment: Production",
      "entityName": "Production",
      "description": "Check, scan & auto-update containers",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "custom",
      "cronExpression": "0 4 * * *",
      "nextRun": "2026-03-05T04:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical"
    }
  ]
}

GET

api

schedules

List Schedules

curl --request GET \
  --url https://api.example.com/api/schedules

{
  "schedules": [
    {
      "id": 1,
      "type": "container_update",
      "name": "Update container: nginx",
      "entityName": "nginx",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "daily",
      "cronExpression": "0 3 * * *",
      "nextRun": "2026-03-05T03:00:00.000Z",
      "lastExecution": {
        "id": 123,
        "startedAt": "2026-03-04T03:00:00.000Z",
        "completedAt": "2026-03-04T03:01:45.000Z",
        "status": "success"
      },
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical_high"
    },
    {
      "id": 2,
      "type": "git_stack_sync",
      "name": "Git sync: my-stack",
      "entityName": "my-stack",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "weekly",
      "cronExpression": "0 2 * * 1",
      "nextRun": "2026-03-10T02:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false
    },
    {
      "id": 3,
      "type": "env_update_check",
      "name": "Update environment: Production",
      "entityName": "Production",
      "description": "Check, scan & auto-update containers",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "custom",
      "cronExpression": "0 4 * * *",
      "nextRun": "2026-03-05T04:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical"
    }
  ]
}

Returns all active schedules including container auto-updates, git stack syncs, environment update checks, image prune jobs, and system cleanup tasks.

Response

Returns an object containing an array of schedule information.

Response Fields

schedules

array

Array of schedule objects

Show ScheduleInfo properties

number

required

Unique schedule identifier

type

string

required

Schedule type. One of:

container_update - Container auto-update schedule
git_stack_sync - Git stack sync schedule
env_update_check - Environment update check schedule
image_prune - Image prune schedule
system_cleanup - System cleanup job

name

string

required

Display name for the schedule

entityName

string

required

Name of the entity being scheduled (container name, stack name, or environment name)

description

string

Optional description of what the schedule does

environmentId

number | null

required

Associated environment ID, or null for system jobs

environmentName

string | null

required

Associated environment name, or null for system jobs

enabled

boolean

required

Whether the schedule is currently enabled

scheduleType

string

required

Schedule frequency type:

daily - Runs once per day
weekly - Runs once per week
custom - Custom cron expression

cronExpression

string | null

required

Cron expression defining when the schedule runs. Standard 5-field format: minute hour day month weekday

nextRun

string | null

required

ISO 8601 timestamp of next scheduled execution, or null if disabled

lastExecution

object | null

Last execution data (if any)

recentExecutions

array

required

Array of recent execution data (up to 5 most recent)

isSystem

boolean

required

Whether this is a system schedule (cannot be deleted)

envHasScanning

boolean

(Container updates only) Whether the environment has vulnerability scanning enabled

vulnerabilityCriteria

string

(Container updates only) Criteria for blocking updates based on vulnerabilities:

never - Never block updates
any - Block if any vulnerabilities found
critical_high - Block if critical or high severity found
critical - Block only on critical severity
more_than_current - Block if more vulnerabilities than current image

Cron Expression Format

Cron expressions use standard 5-field format:

minute hour day month weekday
*      *    *   *     *

minute: 0-59
hour: 0-23 (24-hour format)
day: 1-31 (day of month)
month: 1-12
weekday: 0-7 (0 and 7 are Sunday)

Common Examples

0 3 * * *

Response Example

{
  "schedules": [
    {
      "id": 1,
      "type": "container_update",
      "name": "Update container: nginx",
      "entityName": "nginx",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "daily",
      "cronExpression": "0 3 * * *",
      "nextRun": "2026-03-05T03:00:00.000Z",
      "lastExecution": {
        "id": 123,
        "startedAt": "2026-03-04T03:00:00.000Z",
        "completedAt": "2026-03-04T03:01:45.000Z",
        "status": "success"
      },
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical_high"
    },
    {
      "id": 2,
      "type": "git_stack_sync",
      "name": "Git sync: my-stack",
      "entityName": "my-stack",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "weekly",
      "cronExpression": "0 2 * * 1",
      "nextRun": "2026-03-10T02:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false
    },
    {
      "id": 3,
      "type": "env_update_check",
      "name": "Update environment: Production",
      "entityName": "Production",
      "description": "Check, scan & auto-update containers",
      "environmentId": 1,
      "environmentName": "Production",
      "enabled": true,
      "scheduleType": "custom",
      "cronExpression": "0 4 * * *",
      "nextRun": "2026-03-05T04:00:00.000Z",
      "lastExecution": null,
      "recentExecutions": [],
      "isSystem": false,
      "envHasScanning": true,
      "vulnerabilityCriteria": "critical"
    }
  ]
}

Update Environment

Create Schedule

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

API Overview

Container Management

Stack Management

Image Management

Network & Volume

Environment Management

Scheduling & Automation

List Schedules

Response

Response Fields

Cron Expression Format

Common Examples

Response Example

Build docs developers (and LLMs) love

API Overview

Container Management

Stack Management

Image Management

Network & Volume

Environment Management

Scheduling & Automation

​Response

​Response Fields

​Cron Expression Format

​Common Examples

​Response Example

Build docs developers (and LLMs) love

Response

Response Fields

Cron Expression Format

Common Examples

Response Example