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

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

## get

Gets a subscription.

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

**CLI**

```bash
sylphx events subscriptions get orgs/acme/projects/shop/envs/production/subscriptions/subscription
```

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

## list

Lists subscriptions.

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

**CLI**

```bash
sylphx events subscriptions list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions` · scope `events:read` · effect `read` · [Request, response and examples](/docs/api/subscriptions/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 subscription.

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

**CLI**

```bash
sylphx events subscriptions create --parent orgs/acme/projects/shop/envs/production --spec.topic …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/subscriptions/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.topic` | `string` | The Topic to read. Required. |
| `--spec.types` | `string` | Match these CloudEvents types; empty matches all. A trailing `*` matches a prefix. Repeat the flag for each value. |
| `--spec.sources` | `string` | Match these sources; empty matches all. Repeat the flag for each value. |
| `--spec.queue` | `string` | A Queue. |
| `--spec.webhook-endpoint` | `string` | A Webhook Endpoint. |
| `--spec.realtime-channel` | `string` | A Realtime Channel. |
| `--spec.paused` | `bool` | Whether matching is paused; events published while paused are not delivered. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## update

Updates a subscription.

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

**CLI**

```bash
sylphx events subscriptions update orgs/acme/projects/shop/envs/production/subscriptions/subscription
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions/subscription` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/subscriptions/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.types` | `string` | Match these CloudEvents types; empty matches all. A trailing `*` matches a prefix. Repeat the flag for each value. |
| `--spec.sources` | `string` | Match these sources; empty matches all. Repeat the flag for each value. |
| `--spec.queue` | `string` | A Queue. |
| `--spec.webhook-endpoint` | `string` | A Webhook Endpoint. |
| `--spec.realtime-channel` | `string` | A Realtime Channel. |
| `--spec.paused` | `bool` | Whether matching is paused; events published while paused are not delivered. |
| `--allow-missing` | `bool` | Create the subscription when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## delete

Deletes a subscription.

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

**CLI**

```bash
sylphx events subscriptions delete orgs/acme/projects/shop/envs/production/subscriptions/subscription --yes
```

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

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the subscription does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--yes` | `bool` | Do not ask before this destructive call. |