A resposta curta: a API lê e altera a zona DNS dos domínios activos da sua conta que tenham o DNS ligado (liga-se no Meu Interweb). Com dns:read lê; com dns:write cria, altera e apaga registos. Antes de cada alteração fica uma cópia da zona, e ficam as últimas 20 de cada domínio.
As operações
| Operação |
O que faz |
| GET /v1/domains/{domain}/dns |
Lista os registos. Os que têm read_only a true, como os NS da raiz, não se alteram por aqui. |
| POST /v1/domains/{domain}/dns |
Cria um registo: name, type, value e, se quiser, ttl e priority. |
| POST /v1/domains/{domain}/dns/validate |
Confere um registo sem o gravar. Basta dns:read. |
| PUT /v1/domains/{domain}/dns/{record_id} |
Altera um registo. |
| DELETE /v1/domains/{domain}/dns/{record_id} |
Apaga um registo. |
| GET /v1/domains/{domain}/dns/backups |
Lista as cópias da zona. |
| POST /v1/domains/{domain}/dns/backups/{id}/restore |
Restaura uma cópia. |
| POST /v1/domains/{domain}/dns/reset |
Deixa a zona sem os seus registos. Precisa do nome do domínio em confirm. |
Os tipos aceites são A, AAAA, CNAME, MX, TXT, NS, SRV e CAA. Os nameservers mudam-se na parte de domínios: veja domínios pela API.
Exemplo: um registo TXT de verificação
| 1 |
Confira primeiro com POST /v1/domains/{domain}/dns/validate, com o mesmo corpo que vai gravar.
|
|
| 2 |
Grave com POST /v1/domains/{domain}/dns. Use @ no nome para o próprio domínio.
|
|
| 3 |
Leia a resposta: traz o que ficou na zona, que é o que conta.
|
|
curl https://api.interweb.co.mz/v1/domains/asuaempresa.co.mz/dns -X POST \
-H "Authorization: Bearer $RLX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "@", "type": "TXT", "value": "verificacao=abc123", "ttl": 14400}'
|
Aspas num TXT: as aspas à volta de todo o valor saem; aspas ou barras invertidas no meio do texto respondem 422, porque o servidor de DNS gravaria outro valor. E um CNAME não pode ficar com outros registos no mesmo nome: responde 409 com cname_conflict.
|
O id de um registo muda
O id de um registo muda quando muda o nome, o tipo, o valor ou a prioridade; mudar só o ttl deixa o mesmo id. Use sempre o id da lista mais recente, senão a alteração seguinte responde 404. Um endereço AAAA vem na forma curta.
O domínio do e-mail da conta
Se o e-mail com que entra na conta, ou o de um utilizador dela, for deste domínio (ou de um subdomínio dele), a API recusa, com 409 account_email_domain e também em Sandbox, o que decide para onde vai o correio: os MX desse nome; os A, AAAA, CNAME e NS do nome para onde os MX apontam (ou, sem MX, do próprio nome); repor a zona e restaurar uma cópia que mexa nestes registos. Faça estas alterações no Meu Interweb. Os outros registos continuam a poder ser alterados pela API.
Cópias e limites
| O quê |
Como é |
| Cópias da zona |
Uma antes de cada alteração; ficam as últimas 20 de cada domínio. |
| Restauro incompleto |
Se complete vier a false, um registo da cópia não pôde ficar exactamente como estava: confira a lista. |
| Alterações |
20 por minuto, por conta, além do limite geral. |
| Leituras da zona |
30 por minuto, por conta. A lista pode vir de uma cópia com até 60 segundos, que não conta para esse limite. |
|
O que altera pela API aparece logo; o que altera no Meu Interweb pode demorar até 60 segundos a aparecer na API. Antes de uma alteração grande, liste as cópias: se algo correr mal, restaurar é um pedido só.
|
|
Quer automatizar o DNS dos seus domínios? Veja a página da API e teste com uma chave Sandbox, que simula as alterações.
Ver a página da API
|
Português
English
