Saltar al contenido

Dominios

Dominios de envío, su verificación y sus registros DNS.

Listar dominios

GET/v1/domains

Scope necesario: read o full. Una clave full incluye send y read.

Dominios de envío de la organización (sea cual sea el entorno de la clave) con su estado de verificación, avisos y los registros DNS que deben publicarse.

Respuestas

  • 200
    CampoDescripción
    data[]object[] · obligatorio
    data[].idstring · obligatorio
    data[].objectstring · obligatoriovalores: domain
    data[].namestring · obligatorioej.: tu-dominio.com
    data[].statusstring · obligatoriovalores: draft | pending | verified | failed | paused
    data[].pausedReasonstring | null · obligatorioMotivo de la pausa (solo con status: paused).valores: user | dns_missing | platform
    data[].verifiedAtstring | null · obligatorio
    data[].lastCheckedAtstring | null · obligatorio
    data[].createdAtstring · obligatorio
    data[].dkimStatusstring · obligatoriovalores: not_started | pending | success | failed
    data[].mailFromStatusstring · obligatoriovalores: not_started | pending | success | failed
    data[].dmarcPolicystring | null · obligatorio
    data[].mailFromDomainstring | null · obligatorio
    data[].warningsstring[] · obligatorioCódigos de aviso activos (p. ej. dmarc_missing).
    data[].records[]object[] · obligatorioRegistros DNS que el dominio debe publicar.
    data[].records[].purposestring · obligatoriovalores: dkim | mail_from_mx | mail_from_spf | dmarc
    data[].records[].typestring · obligatoriovalores: CNAME | MX | TXT
    data[].records[].namestring · obligatorioej.: abc._domainkey.tu-dominio.com
    data[].records[].valuestring · obligatorio
    data[].records[].statusstring · obligatorioResultado de la última comprobación DNS.valores: pending | verified | missing | failed
    nextCursorstring | null · obligatorio

Ejemplo

bash
curl https://api.vemudo.com/v1/domains -H "Authorization: Bearer $VEMUDO_API_KEY"

Consultar un dominio

GET/v1/domains/{id}

Scope necesario: read o full. Una clave full incluye send y read.

Un dominio de la organización con sus registros DNS esperados. Id inexistente, de otra organización o mal formado: 404 not_found.

Parámetros

CampoDescripción
idstring · ruta · obligatorio

Respuestas

  • 200
    CampoDescripción
    idstring · obligatorio
    objectstring · obligatoriovalores: domain
    namestring · obligatorioej.: tu-dominio.com
    statusstring · obligatoriovalores: draft | pending | verified | failed | paused
    pausedReasonstring | null · obligatorioMotivo de la pausa (solo con status: paused).valores: user | dns_missing | platform
    verifiedAtstring | null · obligatorio
    lastCheckedAtstring | null · obligatorio
    createdAtstring · obligatorio
    dkimStatusstring · obligatoriovalores: not_started | pending | success | failed
    mailFromStatusstring · obligatoriovalores: not_started | pending | success | failed
    dmarcPolicystring | null · obligatorio
    mailFromDomainstring | null · obligatorio
    warningsstring[] · obligatorioCódigos de aviso activos (p. ej. dmarc_missing).
    records[]object[] · obligatorioRegistros DNS que el dominio debe publicar.
    records[].purposestring · obligatoriovalores: dkim | mail_from_mx | mail_from_spf | dmarc
    records[].typestring · obligatoriovalores: CNAME | MX | TXT
    records[].namestring · obligatorioej.: abc._domainkey.tu-dominio.com
    records[].valuestring · obligatorio
    records[].statusstring · obligatorioResultado de la última comprobación DNS.valores: pending | verified | missing | failed
  • 404
    Dominio no encontrado.

Ejemplo

bash
curl https://api.vemudo.com/v1/domains/$ID \
  -H "Authorization: Bearer $VEMUDO_API_KEY"