hosting
POST /v1/sites/{siteId}/edge-domains
Point a domain at this site's deploy target.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso hosting.deploy.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/edge-domains \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "hostname": <string> }'¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
Attaches the hostname at the provider and, unless `write_dns` is false, publishes its DNS records in the same call — on the customer's own connected DNS account where they have one, otherwise on ours. A DNS failure does not fail the bind: the binding at the provider has already happened, and reporting failure would leave the customer retrying into an "already bound" error. The DNS outcome is on the returned row instead. Requires `hosting.deploy.manage`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
siteId (path) | Uuid | Sí | Site ID (UUIDv7). |
Cuerpo de la solicitud
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
hostname | string | Sí | — |
write_dns | boolean | No | Publish the DNS records in the same call. Defaults to true because doing the DNS for the customer is the point of this surface; opting out is the unusual request. |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
hostname | string | Sí | — |
is_primary | boolean | Sí | — |
status | string<pending, active, failed> | Sí | The provider's verdict on the binding. |
is_apex | boolean | Sí | Whether this hostname is the zone apex. An apex cannot hold a CNAME, so its record set is provider-specific and sometimes impossible — see `refusal`. |
dns_mode | string<unknown, our_zone, byo_dns, nameservers, manual> | Sí | Which DNS tier this hostname landed on. `unknown` means nothing has been attempted yet and must not be rendered as "no action needed". |
dns_zone | string | Sí | — |
dns_vendor | string | Sí | — |
dns_written_at | string | Sí | — |
resolves | boolean | Sí | Three-valued. `true` every wanted record is live, `false` at least one answered and is wrong, `null` no check has answered. `null` is not `false`. |
last_checked_at | string | Sí | — |
last_check_detail | string | Sí | — |
records | DnsRecordPlan[] | Sí | — |
refusal | string | Sí | Non-empty when no valid record set exists for this hostname at this provider — today, a Cloudflare Pages apex on a zone that is not on Cloudflare DNS, because that provider publ… |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429