Skip to Content
Urlizo API Docs
API ReferenceSubdomains

Subdomains

Subdomínio único por workspace ({sub}.base). Fluxo REQUESTED → ACTIVE → DELETED (+VERIFYING/FAILED previstos). Claim com replace idempotente; nomes trim+lowercase, regex de label único (sem pontos/underscores, max 63), reservados e unicidade global validados no service (409). Lease de 48h para REQUESTED.

Tag no Swagger: Subdomains · Auth: JWT (Dashboard, + rate limit 60/60) + API Key (Public) · 4 endpoints

GET/api/v1/subdomain

Subdomínio atual (ou null).

Auth: API Key Bearer (scope subdomain:read)

Response

Subdomain | null

Errors: 401 · 403

POST/api/v1/subdomain

Reivindica/substitui. Status real 201 (explícito).

Auth: API Key Bearer (scope subdomain:manage)

Request body

CampoTipoObrigatórioRegras
subdomainstringsimMesmas regras do Dashboard.

Response

Subdomain

Errors: 401 · 403 · 400 VALIDATION_ERROR · 409 CONFLICT

POST/api/v1/subdomain/activate

Ativa. Status real 201 (docs antigas diziam 200).

Auth: API Key Bearer (scope subdomain:manage)

Response

Subdomain

Errors: 401 · 403 · 404

DELETE/api/v1/subdomain

Desativa. Status real 204.

Auth: API Key Bearer (scope subdomain:manage)

Response

204 No Content

Errors: 401 · 403 · 404

BillingErrors