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

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

## get

Gets a realtime channel.

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

**CLI**

```bash
sylphx events realtime-channels get orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
```

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

## list

Lists realtime channels.

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

**CLI**

```bash
sylphx events realtime-channels list orgs/acme/projects/shop/envs/production
```

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

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

**CLI**

```bash
sylphx events realtime-channels create --parent orgs/acme/projects/shop/envs/production
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/realtime_channels/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.publishable-ok` | `bool` | Allow clients holding a publishable key (`events:realtime:subscribe`) to connect. |
| `--spec.history-retention` | `duration` | How far back a cursor may resume; default 24h, at most 7d. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## update

Updates a realtime channel.

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

**CLI**

```bash
sylphx events realtime-channels update orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
```

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel` · scope `events:write` · effect `write` · [Request, response and examples](/docs/api/realtime_channels/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.publishable-ok` | `bool` | Allow clients holding a publishable key (`events:realtime:subscribe`) to connect. |
| `--spec.history-retention` | `duration` | How far back a cursor may resume; default 24h, at most 7d. |
| `--allow-missing` | `bool` | Create the realtime channel when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## publish

Publishes one message to the channel: it is appended to the channel's history and pushed to every connected client. A retry with the same Idempotency-Key returns the first message.

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

**CLI**

```bash
sylphx events realtime-channels publish orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:publish` · scope `events:publish` · effect `write` · [Request, response and examples](/docs/api/realtime_channels/publish)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--message-type` | `string` | The message name, 1 to 255 of `[A-Za-z0-9._:-]`. Required. |
| `--data` | `json` | The payload; at most 64 KiB as JSON. |
| `--client-id` | `string` | The publisher's client id, shown to subscribers. |

## issue-token

Mints a subscribe token (`rtt_…`) for this channel alone, at most an hour long, for a browser or device that holds no key. A token that names a client id enters the channel's presence while it is connected.

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

**CLI**

```bash
sylphx events realtime-channels issue-token orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:issueToken` · scope `events:publish` · effect `write` · [Request, response and examples](/docs/api/realtime_channels/issue_token)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--ttl` | `duration` | How long the token lives; default and at most 1 hour, at least 1 minute. |
| `--client-id` | `string` | The client this token is for; with it, the connection enters presence. |
| `--client-data` | `json` | The client's presence data, at most 4 KiB as JSON. |

## delete

Deletes a realtime channel.

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

**CLI**

```bash
sylphx events realtime-channels delete orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel --yes
```

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

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the realtime channel does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--force` | `bool` | Also delete the channel's history. Without it, a channel with retained messages is still deleted and its history stops being readable. |
| `--yes` | `bool` | Do not ask before this destructive call. |