Registros DNS do domínio
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": [
{
"type": "CNAME",
"name": "example.com",
"value": "cname.vertraweb.app",
"status": "pending"
},
{
"type": "TXT",
"name": "_acme-challenge.example.com",
"value": "v111d4af8cd74272a284831fbae14a8v",
"status": "pending"
}
]
}
Domínios
Registros DNS do domínio
Retorna os registros DNS a criar no seu provedor de DNS para que um domínio personalizado seja validado e receba o certificado HTTPS.
GET
/
v1
/
apps
/
{id}
/
domains
/
{domain_id}
/
dns
Registros DNS do domínio
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}/domains/{domain_id}/dns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": [
{
"type": "CNAME",
"name": "example.com",
"value": "cname.vertraweb.app",
"status": "pending"
},
{
"type": "TXT",
"name": "_acme-challenge.example.com",
"value": "v111d4af8cd74272a284831fbae14a8v",
"status": "pending"
}
]
}
Retorna os registros que você cria no provedor de DNS do domínio: um
CNAME que aponta o hostname para a Vertra Cloud,
além dos registros que validam a propriedade e emitem o certificado HTTPS. Cada registro tem o seu próprio status,
assim você vê quais já estão resolvendo. Chamar esta rota também atualiza o status e o ssl_status do domínio.
Exige o escopo apps:read quando chamada com uma chave de API.
string
obrigatório
O ID da aplicação.
string
obrigatório
O ID do domínio, obtido em Listar domínios da aplicação.
string
Se a aplicação pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam em uma aplicação que não é deles.
Resposta
APIApplicationDomainDnsRecord[]
{
"response": [
{
"type": "CNAME",
"name": "example.com",
"value": "cname.vertraweb.app",
"status": "pending"
},
{
"type": "TXT",
"name": "_acme-challenge.example.com",
"value": "v111d4af8cd74272a284831fbae14a8v",
"status": "pending"
}
]
}
Crie cada registro exatamente como retornado, e antes remova qualquer outro registro
A, AAAA ou CNAME com o mesmo
nome. Um domínio raiz (apex: true) precisa de um provedor de DNS que suporte CNAME na raiz. Veja o
guia de domínios personalizados. Quando o domínio for removido, apague também esses
registros no seu provedor de DNS, como explicado em Remover domínio da aplicação.Respostas de erro
string
O código de erro que indica o motivo da falha. Valores possíveis:
VALIDATION_ERROR: os parâmetros de caminho falharam na validação (400). A resposta também trazmessageepath.AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: o cabeçalhoAuthorizationestá ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).API_KEY_IP_DENIED: a chave de API está sendo usada a partir de um IP fora da sua lista de permissões (403).USER_NOT_FOUND: não foi possível identificar o usuário autenticado (401).ACCESS_DENIED: o usuário não tem permissão para ler a aplicação (403).API_KEY_SCOPE_DENIED: a chave de API não tem o escopoapps:read(403).APP_NOT_FOUND: a aplicação especificada não existe (404).DOMAIN_NOT_FOUND: a aplicação não tem nenhum domínio com esse ID (404).CUSTOM_DOMAIN_RECORD_NOT_FOUND: os registros DNS do domínio não estão disponíveis (404). Tente novamente em alguns minutos; se persistir, remova o domínio e adicione-o de novo.RATE_LIMIT_EXCEEDED: foi atingido o orçamento de requisições da rota (429).INTERNAL_SERVER_ERROR: falha inesperada (500).
{
"code": "DOMAIN_NOT_FOUND"
}
{
"code": "CUSTOM_DOMAIN_RECORD_NOT_FOUND"
}
Esta rota tem um orçamento próprio de 10 requisições por minuto. Veja Limite de requisições.
Última modificação em 28 de outubro de 2026