Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.authenticate

POST /{namespace}/domains/{domain}/authenticate

Authenticate writes a Domain’s SPF, DKIM and DMARC records and verifies them before its first send.

Noun: Domain
Mode: do
Event: Domain.authenticated

You, to your agent

Authenticate the latest domain.

curl -X POST https://api.sb/routewise.dev/domains/domain_1/authenticate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const domain = await $.Domain.authenticate({ domain: 'domain_1' })

npx startup-builder do Domain.authenticate --json '{"domain":"domain_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.authenticate({ domain: 'domain_1' })"
  }
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The sending Domain.
`dmarc`	`string`		The DMARC policy; it starts at `none` with reports and tightens to `quarantine`.

Outputs

Output	Type	Required	Description
`domain`	Domain	required	The Domain, authenticated.

Effects

Emits Domain.authenticated.
Performed by the Security Engineer.
Two-way: it runs at once, in the try, send and do modes.
Refuses every send from the Domain until all three records verify.
Cold outbound sends only from secondary Domains, never the Domain receipts use.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Domain.authenticate

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Domain

Previous Page

Domain.benchmark

Next Page