Saltar al contenido principal

Listar dominios

GET/v1/domains

Para desarrolladores

Descripción​

Devuelve una lista paginada de dominios registrados en la instancia.

Guía relacionada​

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope domains:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Query params:

domainstring | null
Filtra por nombre de dominio, con coincidencia parcial y sin distinguir mayúsculas (ver Filtros de texto).
is_verifiedboolean | null
true retorna únicamente dominios donde las cuatro verificaciones DNS (MX, SPF, DKIM, DMARC) están aprobadas. false retorna cualquier dominio con al menos una verificación en un estado distinto de verified, lo que incluye pending, failed y también revoked. Si se omite, no se filtra.
pageinteger
Número de página; la primera es la 1. Default: 1.
page_sizeinteger
Tamaño de página, 1–100. Default: 20.

Response​

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene los campos que siguen.
idintegersiempre presente
Identificador del dominio.
domainstringsiempre presente
Nombre de dominio normalizado.
mx_statusstring, enum: `pending | verified | failed | revoked`siempre presente
Estado de verificación del registro MX.
mx_verified_atstring (date-time) | nullsiempre presente
Fecha de la última validación de este registro, exitosa o no. null solo mientras no se haya ejecutado ninguna validación; después no vuelve a null.
spf_statusstring, enum: `pending | verified | failed | revoked`siempre presente
Estado de verificación del registro SPF.
spf_verified_atstring (date-time) | nullsiempre presente
Análogo a mx_verified_at, para SPF.
dkim_statusstring, enum: `pending | verified | failed | revoked`siempre presente
Estado de verificación de los registros DKIM.
dkim_verified_atstring (date-time) | nullsiempre presente
Análogo a mx_verified_at, para DKIM.
dmarc_statusstring, enum: `pending | verified | failed | revoked`siempre presente
Estado de verificación del registro DMARC.
dmarc_verified_atstring (date-time) | nullsiempre presente
Análogo a mx_verified_at, para DMARC.
ownership_tokenstringsiempre presente
Token único usado en dns_records.ownership_cname para probar la propiedad del dominio.
ownership_verified_atstring (date-time) | nullsiempre presente
Se comporta distinto a los cuatro anteriores: se escribe una sola vez, cuando la propiedad se acredita, y permanece en null mientras no se haya acreditado.
last_verification_atstring (date-time) | nullsiempre presente
Fecha de la última vez que se ejecutó la verificación DNS (exitosa o no). null si nunca se ejecutó.
created_atstring (date-time)siempre presente
—
updated_atstring (date-time)siempre presente
—
is_verifiedbooleansiempre presente
true únicamente cuando mx_status, spf_status, dkim_status y dmarc_status son verified simultáneamente.
is_ownership_verifiedbooleansiempre presente
true cuando ownership_verified_at tiene fecha. Es informativo: no condiciona la verificación ni el envío.
is_sandboxbooleansiempre presente
true en el dominio del entorno de pruebas provisionado con la cuenta. Siempre false en los dominios que registra usted. Ver El dominio del entorno de pruebas.
dns_recordsobjectsiempre presente
Los registros exactos a publicar, cada uno un objeto {type, host, value, priority}. Vienen completos en cada respuesta; no hace falta consultarlos aparte.
ownership_cnameobject
Acredita la propiedad del dominio. Es informativo: no condiciona la verificación ni el envío, y se comprueba una sola vez. priority siempre null.
mxobject
Enruta los rebotes hacia la plataforma. La verificación exige que este sea el único MX del dominio (ver por qué el MX debe ser exclusivo). Único registro con priority no nulo (10).
spfobject
Autoriza a la plataforma a enviar en nombre de este dominio. priority siempre null.
dkimarray, exactamente 2 elementos
Los dos CNAME de firma DKIM, uno por selector: s1 y s2 (el prefijo del host, como en s1._domainkey.…). Publique los dos: uno firma y el otro queda listo para rotar la clave sin interrumpir los envíos. Publíquelos como CNAME y no copie el TXT al que apuntan: ese TXT quedaría fijo con la clave actual y la verificación fallaría en la próxima rotación. priority siempre es null.
dmarcobject
Registro de política DMARC. Mínimo recomendado: p=none con un rua válido. priority siempre null.
Notas
Request
curl -X GET "https://$API_HOST/v1/domains?is_verified=true&page=1&page_size=20" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"data": [
  {
    "id": 7,
    "domain": "correos.micomercio.cl",
    "mx_status": "verified",
    "...": "..."
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}