---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx workflows schedules"
description: "The sylphx workflows schedules commands of Sylphx Workflows: every verb, with its argument, its flags and a run line."
type: reference
product: jobs
summary: "Every sylphx workflows schedules command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `schedules` commands of Sylphx Workflows, as the CLI spells them: the same
calls as [the `schedules` API page](/docs/api/schedules), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a schedule.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows schedules get orgs/acme/projects/shop/envs/production/schedules/schedule
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule` · scope `workflows:read` · effect `read` · [Request, response and examples](/docs/api/schedules/get)

## list

Lists schedules.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx workflows schedules list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules` · scope `workflows:read` · effect `read` · [Request, response and examples](/docs/api/schedules/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels and filterable fields. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a schedule.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx workflows schedules create --parent orgs/acme/projects/shop/envs/production --spec.workflow …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/schedules/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.workflow` | `string` | The Workflow the Schedule starts, in the same environment. Required. |
| `--spec.input` | `json` | The input of every Run, at most 64 KiB of JSON. |
| `--spec.calendar.cron` | `string` | A 5-field cron expression, for example `0 3 * * *`. |
| `--spec.calendar.time-zone` | `string` | IANA time zone; default `UTC`. |
| `--spec.interval.every` | `duration` | The period, 1s to 365d. |
| `--spec.interval.offset` | `duration` | Phase offset within each period. |
| `--spec.jitter` | `duration` | Random delay added to each fire, at most min(interval, 1h). |
| `--spec.overlap-policy` | `enum` | What a fire does while a previous Run is still running. One of `skip`, `buffer_one`, `buffer_all`, `cancel_other`, `allow`. |
| `--spec.catchup-window` | `duration` | Missed fires older than this are skipped; 10s to 365d. |
| `--spec.paused` | `bool` | Whether fires are paused. |
| `--spec.pause-note` | `string` | Why the Schedule is paused; shown in status. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a schedule.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows schedules update orgs/acme/projects/shop/envs/production/schedules/schedule --spec.workflow …
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/schedules/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.workflow` | `string` | The Workflow the Schedule starts, in the same environment. Required. |
| `--spec.input` | `json` | The input of every Run, at most 64 KiB of JSON. |
| `--spec.calendar.cron` | `string` | A 5-field cron expression, for example `0 3 * * *`. |
| `--spec.calendar.time-zone` | `string` | IANA time zone; default `UTC`. |
| `--spec.interval.every` | `duration` | The period, 1s to 365d. |
| `--spec.interval.offset` | `duration` | Phase offset within each period. |
| `--spec.jitter` | `duration` | Random delay added to each fire, at most min(interval, 1h). |
| `--spec.overlap-policy` | `enum` | What a fire does while a previous Run is still running. One of `skip`, `buffer_one`, `buffer_all`, `cancel_other`, `allow`. |
| `--spec.catchup-window` | `duration` | Missed fires older than this are skipped; 10s to 365d. |
| `--spec.paused` | `bool` | Whether fires are paused. |
| `--spec.pause-note` | `string` | Why the Schedule is paused; shown in status. |
| `--allow-missing` | `bool` | Create the schedule when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a schedule.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows schedules delete orgs/acme/projects/shop/envs/production/schedules/schedule --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule` · scope `workflows:write` · effect `destructive` · [Request, response and examples](/docs/api/schedules/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the schedule does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |

## pause

Pauses a Schedule: no fire starts a Run until it is resumed.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows schedules pause orgs/acme/projects/shop/envs/production/schedules/schedule
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:pause` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/schedules/pause)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--pause-note` | `string` | Why the Schedule is paused. |
| `--etag` | `string` | Act only if the current etag matches. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## resume

Resumes a paused Schedule; missed fires follow `catchup_window`.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx workflows schedules resume orgs/acme/projects/shop/envs/production/schedules/schedule
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/schedules/schedule:resume` · scope `workflows:write` · effect `write` · [Request, response and examples](/docs/api/schedules/resume)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Act only if the current etag matches. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |