Dominios

Reserva el único subdominio de pruebas gratuito de una aplicación, agrega dominios propios y verifica su titularidad con un registro DNS TXT.

  • Disponibilidad: Planificado
  • Evidencia: Leído del código fuente
  • Referencia

Operaciones

Operación Solicitud Capacidad Reintento
domains.list GET /v1/applications/{application}/domains application.read
domains.reserve PUT /v1/applications/{application}/domains/testing domain.manage natural
domains.add POST /v1/applications/{application}/domains domain.manage key
domains.verify POST /v1/applications/{application}/domains/{domain}/verify domain.manage natural
domains.remove DELETE /v1/applications/{application}/domains/{domain} domain.manage natural

El subdominio de pruebas

Cada aplicación tiene exactamente un subdominio de pruebas gratuito, servido por HTTPS bajo la zona de clientes que configuró quien opera la plataforma.

JSON
{ "label": "shop" }

El label cumple ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$. Repetir la solicitud con la misma etiqueta responde la misma reserva; otra etiqueta la reemplaza. Una etiqueta que tiene otra aplicación es 409 DOMAIN_CONFLICT.

La zona de clientes es configuración. Se elige de modo que el contenido no confiable de los clientes quede aislado de las cookies de la plataforma y de la administración, y este sitio no la nombra.

Dominios propios

JSON
{ "hostname": "shop.example.com", "environment": "production" }

Un dominio propio comienza en pending y no sirve nada hasta que se verifica. La respuesta trae el registro que hay que publicar:

Miembro de verification Significado
method dns-txt
record El nombre completo del registro TXT
value El token de verificación. Solo demuestra la titularidad y no es una credencial.
checked, observed La hora de la última comprobación y los valores TXT que encontró

Publica el registro TXT y luego llama a domains.verify. Mientras el registro falte o sea incorrecto, la respuesta es 409 DOMAIN_UNVERIFIED, y observed muestra lo que encontró la comprobación. Verificar un dominio ya verificado lo responde sin cambios. Si no se puede consultar el DNS, la respuesta es 502 UPSTREAM_UNAVAILABLE.

Estado del dominio Significado
reserved Un subdominio de pruebas
pending Un dominio propio a la espera de verificación
verified Titularidad demostrada; el dominio sirve su entorno
failed La verificación falló

tls informa el certificado: pending, issued o failed.