Conectar un dominio
Apunta por DNS uno de los dominios propios de la cuenta al proyecto de esta clave, con una clave de ámbito App.
agent_domain_connect es una llamada limitada a un proyecto: a diferencia de cualquier otra escritura de esta sección, no recibe app_id. El proyecto al que apunta un dominio es aquel con el que se creó la propia clave de API, así que esta receta necesita una clave App (creada desde la pestaña API del propio proyecto), no una clave de Cuenta. agent_domain_list es la lectura complementaria, los dominios propios de la cuenta, para que siempre envíes un nombre que la cuenta realmente posee.
Métodos
Domains: list
List the account's registered domains (name, status, which app each is attached to). Use this BEFORE asking the user to type a domain: if they say 'connect one of my domains', call this and present the options.
Domains: connect to this VPS
Point one of the account's own domains (from agent_domain_list) at THIS project's VPS via DNS. Optional subdomain (e.g. 'app' -> app.example.com); omit to use the apex. Prefer a subdomain unless the user explicitly wants the apex. Attaching replaces any existing record on that exact hostname.
Ambos métodos resuelven uid a partir de la clave que envías, igual que en el resto, pero agent_domain_connect también resuelve app_id a partir de ella, y solo una clave creada desde la pestaña API de un proyecto lo lleva. Si la llamas con una clave de Cuenta, responde -1, 'no app is bound to this action', antes de mirar siquiera el dominio. Consulta Autenticación para ver los tres ámbitos de clave.
Paso a paso
Lista los dominios de la cuenta
Sin más campos que tu clave. Cada fila es un dominio que la cuenta registró a través de Xuda o conectó delegando sus servidores de nombres, el proyecto al que apunta en ese momento (si lo hay) y su propio status.
2. Apunta uno al proyecto de esta clave
domain tiene que ser uno de los nombres que devolvió la llamada anterior. subdomain es opcional y no tiene relación con el nombre del proyecto de la clave App, es una etiqueta del dominio ("app" para app.example.com); omítelo para apuntar el apex del dominio. Volver a ejecutar esto con otro subdomain no altera un nombre de host que ya hayas enlazado, solo se sustituye el registro de ese nombre de host exacto.
La respuesta
agent_domain_list recorta cada documento de dominio guardado a cuatro campos:
connection_type es registered para un dominio comprado a través de Xuda (Xuda es el registrador y el DNS) o connected para uno registrado en otro sitio con sus servidores de nombres delegados en Xuda (solo DNS, el registro se queda donde estaba). Ambos funcionan igual con agent_domain_connect.
agent_domain_connect responde con el registro DNS que realmente escribió:
type depende del tipo de proyecto al que está limitada la clave, no de nada que envíes: un proyecto VPS recibe un registro A hacia su IP (o AAAA en una VM de farm sin IPv4 pública), todo lo demás recibe un CNAME hacia la URL de acceso del propio proyecto. Todos los registros pasan por el proxy de Cloudflare (proxied: true), así que el visitante obtiene HTTPS en el borde en cualquier caso. ssl_mode solo se establece en la vía VPS, donde Xuda además sondea y fija el modo SSL de origen de la zona (full, strict o flexible); vuelve null para un destino CNAME, el SSL Universal propio de Cloudflare cubre ese caso sin un ajuste de zona que informar.