Skip to content
Console
On this page

Mail domains

An Email Domain is an email domain Notify sends from and receives for.

An Email Domain is an email domain Notify sends from and receives for. It sends only after its DKIM and SPF records verify; every email is DKIM-signed with the domain's non-exportable key from Sylphx Keys, rotated with overlap. It receives only after every MX record of the domain points at the platform. No key material is ever returned.

Service Sylphx Notify · Resource type notify.sylphx.com/EmailDomain · Name pattern orgs/{org}/projects/{project}/envs/{env}/mail_domains/{mail_domain} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mail_domains/{mail_domain}.
uidstringedm_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specEmailDomainSpecDesired state. Required.
statusEmailDomainStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets an email domain.
GETlistLists email domains.
POSTcreateCreates an email domain.
PATCHupdateUpdates an email domain.
DELETEdeleteDeletes an email domain.
POSTverifyChecks the domain's DNS records now instead of on the next sweep.

get

Gets an email domain.

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

list

Lists email domains.

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

create

Creates an email domain.

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

update

Updates an email domain.

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

delete

Deletes an email domain.

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

verify

Checks the domain's DNS records now instead of on the next sweep.

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