Skip to main content
DELETE
Remove um domínio personalizado

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

id
string
required

Identificador do domínio (prefixo cdom_).

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

"cdom_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

Response

200 - application/json

Default Response

id
string
required

Identificador único do domínio (prefixo cdom_).

Example:

"cdom_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

organizationId
string
required

Identificador da organização dona do domínio.

Example:

"org_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

hostname
string
required

Domínio próprio (ex.: go.cliente.com).

Example:

"go.cliente.com"

kind
enum<string>
required

O que o domínio serve: link (links /t/{token}) ou portal (portal whitelabel no domínio do cliente).

Available options:
link,
portal
Example:

"link"

status
enum<string>
required

Verificação de posse via DNS. verified é pré-requisito para servir tráfego e para virar primário.

Available options:
pending,
verifying,
verified,
failed
Example:

"pending"

tlsStatus
enum<string>
required

Estado do certificado TLS (Caddy on-demand provisiona sob demanda).

Available options:
pending,
issued,
failed
Example:

"pending"

isPrimary
boolean
required

Indica se é o domínio padrão da org para novos links (no máx. 1).

verificationToken
string
required

Valor a publicar no registro TXT _repass.<hostname> para provar a posse do domínio. Não é segredo.

Example:

"cdom_verify_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

verifiedAt
string<date-time> | null
required

Data/hora (ISO-8601) da verificação de DNS, ou null.

tlsIssuedAt
string<date-time> | null
required

Data/hora (ISO-8601) da emissão do certificado, ou null.

createdAt
string<date-time>
required

Data/hora (ISO-8601) de criação.

updatedAt
string<date-time>
required

Data/hora (ISO-8601) da última atualização.