Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a mail route
Gets a route.
Gets a route.
- Path
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— nothing is written. - Collection mail_routes
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the route to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/mail_domains/{mail_domain}/mail_routes/{mail_route}. |
uid | string | rte_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | RouteSpec | Desired state. Required. |
status | RouteStatus | Observed state. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#RouteSpec
| Field | Type | What it is |
|---|---|---|
match | RouteMatch | Which recipients the route matches. Required. |
actions | RouteAction[] | What happens to the mail: one or more mailbox and forward actions, or one reject. Required. |
spam | RouteSpamPolicy | What happens to mail the spam filter judges spam; DELIVER when unset. One of deliver, drop, reject. |
enabled | bool | A disabled route matches nothing. |
#RouteStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
#RouteMatch
| Field | Type | What it is |
|---|---|---|
address | string | A local part, for example support. A local part with a +tag also matches its route. One of the kind group. |
pattern | string | A glob on the local part, for example billing-*. One of the kind group. |
catch_all | bool | Every local part no other route matches. One of the kind group. |
#RouteAction
| Field | Type | What it is |
|---|---|---|
mailbox | string | Deliver to a mailbox of the environment. One of the action group. |
forward | string | Forward to an address. One of the action group. |
reject | string | Refuse at the recipient step with this message; stands alone. One of the action group. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mail_domains/mail-domain/mail_routes/mail-route" \
-H "Authorization: Bearer $SYLPHX_API_KEY"