Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete

Reference

sylphx notify mail_routes

Every sylphx notify mail_routes command: its argument, its flags and a run line.

Checked 2026-09-28

The mail_routes commands of Sylphx Notify, as the CLI spells them: the same calls as the mail_routes API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a route.

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

CLI

Shell

sylphx notify mail-routes get orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:read · effect read · Request, response and examples

#list

Lists an email domain's routes.

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

CLI

Shell

sylphx notify mail-routes list orgs/acme/projects/shop/envs/production/mail_domains/mail-domain

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes · scope notify:read · effect read · Request, response and examples

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 route.

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

CLI

Shell

sylphx notify mail-routes create --parent orgs/acme/projects/shop/envs/production/mail_domains/mail-domain

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes · scope notify:write · effect write · Request, response and examples

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.match.address`	`string`	A local part, for example `support`. A local part with a `+tag` also matches its route.
`--spec.match.pattern`	`string`	A glob on the local part, for example `billing-*`.
`--spec.match.catch-all`	`bool`	Every local part no other route matches.
`--spec.actions`	`json`	What happens to the mail: one or more mailbox and forward actions, or one reject. Required. Repeat the flag for each value.
`--spec.spam`	`enum`	What happens to mail the spam filter judges spam; `DELIVER` when unset. One of `deliver`, `drop`, `reject`.
`--spec.enabled`	`bool`	A disabled route matches nothing.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a route.

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

CLI

Shell

sylphx notify mail-routes update orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:write · effect write · Request, response and examples

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.match.address`	`string`	A local part, for example `support`. A local part with a `+tag` also matches its route.
`--spec.match.pattern`	`string`	A glob on the local part, for example `billing-*`.
`--spec.match.catch-all`	`bool`	Every local part no other route matches.
`--spec.actions`	`json`	What happens to the mail: one or more mailbox and forward actions, or one reject. Required. Repeat the flag for each value.
`--spec.spam`	`enum`	What happens to mail the spam filter judges spam; `DELIVER` when unset. One of `deliver`, `drop`, `reject`.
`--spec.enabled`	`bool`	A disabled route matches nothing.
`--allow-missing`	`bool`	Create the route when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a route.

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

CLI

Shell

sylphx notify mail-routes delete orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route · scope notify:write · effect destructive · Request, response and examples

Flags

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

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links