> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/Finsys/dockhand/llms.txt
> Use this file to discover all available pages before exploring further.

# List Schedules

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

<ResponseField name="schedules" type="array">
  Array of schedule objects

  <Expandable title="ScheduleInfo properties">
    <ResponseField name="id" type="number" required>
      Unique schedule identifier
    </ResponseField>

    <ResponseField name="type" 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
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Display name for the schedule
    </ResponseField>

    <ResponseField name="entityName" type="string" required>
      Name of the entity being scheduled (container name, stack name, or environment name)
    </ResponseField>

    <ResponseField name="description" type="string">
      Optional description of what the schedule does
    </ResponseField>

    <ResponseField name="environmentId" type="number | null" required>
      Associated environment ID, or null for system jobs
    </ResponseField>

    <ResponseField name="environmentName" type="string | null" required>
      Associated environment name, or null for system jobs
    </ResponseField>

    <ResponseField name="enabled" type="boolean" required>
      Whether the schedule is currently enabled
    </ResponseField>

    <ResponseField name="scheduleType" type="string" required>
      Schedule frequency type:

      * `daily` - Runs once per day
      * `weekly` - Runs once per week
      * `custom` - Custom cron expression
    </ResponseField>

    <ResponseField name="cronExpression" type="string | null" required>
      Cron expression defining when the schedule runs. Standard 5-field format: `minute hour day month weekday`
    </ResponseField>

    <ResponseField name="nextRun" type="string | null" required>
      ISO 8601 timestamp of next scheduled execution, or null if disabled
    </ResponseField>

    <ResponseField name="lastExecution" type="object | null">
      Last execution data (if any)
    </ResponseField>

    <ResponseField name="recentExecutions" type="array" required>
      Array of recent execution data (up to 5 most recent)
    </ResponseField>

    <ResponseField name="isSystem" type="boolean" required>
      Whether this is a system schedule (cannot be deleted)
    </ResponseField>

    <ResponseField name="envHasScanning" type="boolean">
      (Container updates only) Whether the environment has vulnerability scanning enabled
    </ResponseField>

    <ResponseField name="vulnerabilityCriteria" type="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
    </ResponseField>
  </Expandable>
</ResponseField>

## 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

<CodeGroup>
  ```text Daily at 3 AM theme={null}
  0 3 * * *
  ```

  ```text Every Monday at 2:30 AM theme={null}
  30 2 * * 1
  ```

  ```text Every 6 hours theme={null}
  0 */6 * * *
  ```

  ```text First day of month at midnight theme={null}
  0 0 1 * *
  ```
</CodeGroup>

## Response Example

<ResponseExample>
  ```json theme={null}
  {
    "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"
      }
    ]
  }
  ```
</ResponseExample>