developer
PTEN

Settings API

Domains

The company’s domains: asked for, shown to be its own by a TXT record, then with mail here or not.

URL base https://acme.yet.com.br/api/settings

Settings respondem no endereço da sua empresa — acme aqui — e aceitam a key de quem administra o Settings.

As descrições dos endpoints estão em inglês.

List domains

GET/api/settings/domains

Its domains, with whether each has mail here, and the ones still asked for (claims).

Quem: Runs the company’s Settings

Requisição
curl https://acme.yet.com.br/api/settings/domains \
  -H "Authorization: Bearer $YET_API_KEY"
Resposta · 200
{
  "domains": [
    {
      "name": "acme.dev",
      "mail": true
    }
  ],
  "claims": [
    {
      "domain": "acme.com.br",
      "txt": "yet-verify=4f2a…",
      "created_at": "2026-10-23T12:00:00Z"
    }
  ]
}

Ask for a domain

POST/api/settings/domains

Answers with the TXT record to publish: once its DNS shows it, the domain is the company’s.

Quem: Runs the company’s Settings

Corpo

namestringobrigatório
The domain.
Requisição
curl -X POST https://acme.yet.com.br/api/settings/domains \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "acme.com.br"
  }'

Verify a domain

POST/api/settings/domains/claims/{domain}

Checks its DNS now and, when it shows the record, makes it the company’s.

Quem: Runs the company’s Settings

Requisição
curl -X POST https://acme.yet.com.br/api/settings/domains/claims/{domain} \
  -H "Authorization: Bearer $YET_API_KEY"

Stop asking for a domain

DELETE/api/settings/domains/claims/{domain}

Gives up a claim not verified yet.

Quem: Runs the company’s Settings

Requisição
curl -X DELETE https://acme.yet.com.br/api/settings/domains/claims/{domain} \
  -H "Authorization: Bearer $YET_API_KEY"

Publish the claim in Cloud

POST/api/settings/domains/claims/{domain}/cloud

Puts the TXT record in the domain’s zone in Cloud, making the zone first if need be.

Quem: Runs the company’s Settings

Requisição
curl -X POST https://acme.yet.com.br/api/settings/domains/claims/{domain}/cloud \
  -H "Authorization: Bearer $YET_API_KEY"

A domain’s health

GET/api/settings/domains/{domain}

Its DNS as the internet sees it, its standing in SES and the week’s numbers.

Quem: Runs the company’s Settings

Requisição
curl https://acme.yet.com.br/api/settings/domains/{domain} \
  -H "Authorization: Bearer $YET_API_KEY"

Turn its mail on

POST/api/settings/domains/{domain}/mail

The mail server, SES, and a mailbox for each of its people.

Quem: Runs the company’s Settings

Requisição
curl -X POST https://acme.yet.com.br/api/settings/domains/{domain}/mail \
  -H "Authorization: Bearer $YET_API_KEY"

Publish its mail records in Cloud

POST/api/settings/domains/{domain}/dns

Puts the records its mail needs in the domain’s zone in Cloud.

Quem: Runs the company’s Settings

Requisição
curl -X POST https://acme.yet.com.br/api/settings/domains/{domain}/dns \
  -H "Authorization: Bearer $YET_API_KEY"

Pause or resume its mail

PUT/api/settings/domains/{domain}

Paused, the domain sends nothing.

Quem: Runs the company’s Settings

Corpo

pausedbooleanobrigatório
Whether it is paused.
Requisição
curl -X PUT https://acme.yet.com.br/api/settings/domains/{domain} \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "paused": true
  }'

Remove a domain

DELETE/api/settings/domains/{domain}

Only one with nobody on it.

Quem: Runs the company’s Settings

Requisição
curl -X DELETE https://acme.yet.com.br/api/settings/domains/{domain} \
  -H "Authorization: Bearer $YET_API_KEY"