Skip to content

Commit dadc07f

Browse files
committed
feat: pause/resume event streams via CLI
1 parent 61d80da commit dadc07f

1 file changed

Lines changed: 70 additions & 5 deletions

File tree

docs/actions/live-events.mdx

Lines changed: 70 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -376,22 +376,87 @@ it to continue delivery. Pausing one event stream has no effect on your other ev
376376

377377
### Pause or resume a stream
378378

379+
```mdx-code-block
380+
<Tabs
381+
defaultValue="console"
382+
values={[
383+
{label: 'Ory Console', value: 'console'},
384+
{label: 'Ory CLI', value: 'cli'},
385+
]}>
386+
<TabItem value="console">
387+
```
388+
379389
1. Go to your project in the [Ory Console](https://console.ory.com).
380390
2. Click **Project settings** in the top navigation bar.
381391
3. Click **Event streams** in the left sidebar. The **Status** column shows whether each stream is **Active** or **Paused**.
382392
4. Open the **** menu next to the stream and click **Pause** or **Resume**.
383393

384-
You can also change the status through the Ory APIs. Updating an event stream is a partial update: send only the `status` field
385-
(`active` or `paused`) and every other setting keeps its current value. This is the recommended way to pause or resume a stream,
386-
because resubmitting the destination is not required.
394+
```mdx-code-block
395+
</TabItem>
396+
<TabItem value="cli">
397+
```
398+
399+
Pass the ID of the stream you want to pause or resume. Run `ory list event-streams` to look up the ID; its `STATUS` column shows
400+
whether each stream is currently `active` or `paused`.
401+
402+
```shell
403+
# Pause a stream: delivery stops, but the stream and its configuration are kept.
404+
ory pause event-stream "$EVENT_STREAM_ID" --project "$YOUR_PROJECT_ID"
405+
406+
# Resume a stream: delivery continues.
407+
ory resume event-stream "$EVENT_STREAM_ID" --project "$YOUR_PROJECT_ID"
408+
```
409+
410+
```mdx-code-block
411+
</TabItem>
412+
</Tabs>
413+
```
414+
415+
You can also change the status directly through the Ory APIs. Updating an event stream is a partial update: send only the `status`
416+
field (`active` or `paused`) and every other setting keeps its current value, so resubmitting the destination is not required. The
417+
Ory Console and the `ory pause`/`ory resume` CLI commands use this partial update for you.
387418

388419
When you resume a stream, Ory first verifies that the destination is reachable, the same check that runs when you create or update
389420
a stream.
390421

391422
### Create a stream as paused
392423

393-
When you create a stream in the Ory Console, set **Status** to **Paused** to save it without starting delivery. This is useful
394-
when you want to configure a stream before its destination is ready. Resume it later from the stream's **** menu.
424+
Creating a stream as paused is useful when you want to configure it before its destination is ready. Resume it once the
425+
destination is live.
426+
427+
```mdx-code-block
428+
<Tabs
429+
defaultValue="console"
430+
values={[
431+
{label: 'Ory Console', value: 'console'},
432+
{label: 'Ory CLI', value: 'cli'},
433+
]}>
434+
<TabItem value="console">
435+
```
436+
437+
In the **Create new Event Stream** dialog, set **Status** to **Paused** to save the stream without starting delivery. Resume it
438+
later from the stream's **** menu.
439+
440+
```mdx-code-block
441+
</TabItem>
442+
<TabItem value="cli">
443+
```
444+
445+
Pass `--status paused` to `ory create event-stream`. The flag works for both `https` and `sns` streams; when omitted, the stream
446+
is created `active`.
447+
448+
```shell
449+
ory create event-stream \
450+
--project "$YOUR_PROJECT_ID" \
451+
--type https \
452+
--https-endpoint https://example.com/my-event-endpoint \
453+
--status paused
454+
```
455+
456+
```mdx-code-block
457+
</TabItem>
458+
</Tabs>
459+
```
395460

396461
### What happens to events while a stream is paused
397462

0 commit comments

Comments
 (0)