Pular para o conteúdo principal
GET
curl
O status vai de pending (verificando) a active quando a Cube acha o TXT que prova a posse e o CNAME chegando a domains.cubehost.dev (na raiz com ALIAS ou CNAME achatado, o certificado não sai: error.code: "root_alias_unsupported"). A Cube confere sozinha a cada minuto: releia esta rota ou chame Verificar domínio agora. used, limit e suggestedPlanId são os da conta, como em Listar domínios da conta (limit é 0 num bot ou no Free).

Erros comuns

Todos os códigos, com o formato do erro, em Códigos de erro.

Autorizações

Authorization
string
header
obrigatório

Chave de API da Cube (cube_…), criada no painel em Chaves de API. Mande como Authorization: Bearer cube_…. Cada rota pede uma permissão da chave (o escopo no security da rota, como files:write); sem ela, 403 insufficient_scope com o requiredScope. Veja Chaves de API.

Scopes

domains:read

Parâmetros de caminho

id
string
obrigatório

O ID do projeto (26 caracteres). Aparece no painel, no topo do projeto, e em GET /projects.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
Exemplo:

"01J8Z3W6N0Q4Y7V2K5T9D1H3XA"

Resposta

Os domínios do site.

domains
object[]
obrigatório
used
integer
obrigatório

Quantos domínios da conta contam no pacote (o www do mesmo nome no mesmo site vai junto e não conta). Pode passar do limit depois de mudar para um plano menor: os domínios continuam no ar. Até 28/10/2026: os sites com domínio (no site, 0 ou 1).

limit
integer
obrigatório

O pacote de domínios da conta (0 no Free, que não tem site, e num bot). Até 28/10/2026: 1 por site.

suggestedPlanId
string | null
obrigatório

O plano mais barato com mais domínios que o pacote e que o used; null no maior.

target
string
obrigatório

O alvo do CNAME (domains.cubehost.dev).

isAvailable
boolean
obrigatório

false quando o domínio próprio está fora do ar.