Skip to Content
Urlizo API Docs
API ReferenceDomains

Domains

Domínios customizados com verificação DNS (CNAME token-based, worker async). Normalização: trim, lowercase, strip protocolo/porta/barra. Validação DNS por label (RFC); wildcards rejeitados. Status: PENDING_VERIFICATION|VERIFIED|FAILED|DELETED. SSL: WILDCARD|PROVISIONING|ACTIVE|FAILED.

Tag no Swagger: Domains · Auth: JWT (Dashboard) + API Key (Public) · 6 endpoints

POST/api/v1/domains

Cria domínio. Status real 201. Validação = 400 (não 422).

Auth: API Key Bearer (scope domains:manage)

Request body

CampoTipoObrigatórioRegras
domainstringsimHostname.

Response

Domain + verificationToken

Errors: 401 · 403 · 400 VALIDATION_ERROR · 409 CONFLICT

GET/api/v1/domains

Lista paginada.

Auth: API Key Bearer (scope domains:read)

Query parameters

CampoTipoObrigatórioRegras
pagenumbernãoDefault 1.
pageSizenumbernãoDefault 20, max 100.

Response

{ data: Domain[], total, page, pageSize, totalPages }

Errors: 401 · 403

GET/api/v1/domains/:id

Busca por ID.

Auth: API Key Bearer (scope domains:read)

Response

Domain

Errors: 401 · 403 · 404

PATCH/api/v1/domains/:id

Atualiza o hostname.

Auth: API Key Bearer (scope domains:manage)

Response

Domain

Errors: 401 · 403 · 404 · 400 VALIDATION_ERROR · 409 CONFLICT

DELETE/api/v1/domains/:id

Exclui. Status real 204.

Auth: API Key Bearer (scope domains:manage)

Response

204 No Content

Errors: 401 · 403 · 404

POST/api/v1/domains/:id/verify

Reinicia verificação. Status real 201 (docs antigas diziam 200).

Auth: API Key Bearer (scope domains:manage)

Response

{ success, message }

Errors: 401 · 403 · 404

Profile / MeWebhooks