获取域名健康状态

GET

public

accounts

{account_id}

domains

{domain}

health

获取域名健康状态

curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health \
  --header 'Authorization: Bearer <token>'

{
  "cache_ttl_seconds": 123,
  "cached": true,
  "checked_at": "<string>",
  "checks": {
    "dns": {
      "a": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "dkim": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "dmarc": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "error": "<string>",
      "mx": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "ns": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "spf": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    },
    "ports": {
      "error": "<string>",
      "imap_143": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "imaps_993": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "smtp_25": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "submission_587": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    },
    "ssl": {
      "actual": [
        "<string>"
      ],
      "code": "<string>",
      "days_remaining": 123,
      "error": "<string>",
      "expected": [
        "<string>"
      ],
      "expires_at": "<string>",
      "issuer": "<string>",
      "record": "<string>",
      "records": [
        "<string>"
      ],
      "status_code": 123
    },
    "web": {
      "error": "<string>",
      "http_root": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "http_www": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "https_root": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "https_www": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    }
  },
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_name": "<string>",
  "timings_ms": {}
}

授权

Authorization

string

header

必填

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

路径参数

account_id

string<uuid>

必填

domain

string

必填

查询参数

refresh

boolean

默认值:false

响应

cache_ttl_seconds

integer

必填

cached

boolean

必填

checked_at

string

必填

checks

DomainHealthChecks · object

必填

分组域运行状况探测结果。

Hide child attributes

checks.dns

DomainHealthDnsChecks · object

必填

DNS 相关的运行状况探针。

Hide child attributes

checks.dns.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.a

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.a.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.a.actual

string[] | null

checks.dns.a.code

string | null

checks.dns.a.days_remaining

integer | null

checks.dns.a.error

string | null

checks.dns.a.expected

string[] | null

checks.dns.a.expires_at

string | null

checks.dns.a.issuer

string | null

checks.dns.a.record

string | null

checks.dns.a.records

string[] | null

checks.dns.a.status_code

integer | null

checks.dns.dkim

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.dkim.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.dkim.actual

string[] | null

checks.dns.dkim.code

string | null

checks.dns.dkim.days_remaining

integer | null

checks.dns.dkim.error

string | null

checks.dns.dkim.expected

string[] | null

checks.dns.dkim.expires_at

string | null

checks.dns.dkim.issuer

string | null

checks.dns.dkim.record

string | null

checks.dns.dkim.records

string[] | null

checks.dns.dkim.status_code

integer | null

checks.dns.dmarc

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.dmarc.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.dmarc.actual

string[] | null

checks.dns.dmarc.code

string | null

checks.dns.dmarc.days_remaining

integer | null

checks.dns.dmarc.error

string | null

checks.dns.dmarc.expected

string[] | null

checks.dns.dmarc.expires_at

string | null

checks.dns.dmarc.issuer

string | null

checks.dns.dmarc.record

string | null

checks.dns.dmarc.records

string[] | null

checks.dns.dmarc.status_code

integer | null

checks.dns.error

string | null

checks.dns.mx

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.mx.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.mx.actual

string[] | null

checks.dns.mx.code

string | null

checks.dns.mx.days_remaining

integer | null

checks.dns.mx.error

string | null

checks.dns.mx.expected

string[] | null

checks.dns.mx.expires_at

string | null

checks.dns.mx.issuer

string | null

checks.dns.mx.record

string | null

checks.dns.mx.records

string[] | null

checks.dns.mx.status_code

integer | null

checks.dns.ns

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.ns.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.ns.actual

string[] | null

checks.dns.ns.code

string | null

checks.dns.ns.days_remaining

integer | null

checks.dns.ns.error

string | null

checks.dns.ns.expected

string[] | null

checks.dns.ns.expires_at

string | null

checks.dns.ns.issuer

string | null

checks.dns.ns.record

string | null

checks.dns.ns.records

string[] | null

checks.dns.ns.status_code

integer | null

checks.dns.spf

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.dns.spf.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.dns.spf.actual

string[] | null

checks.dns.spf.code

string | null

checks.dns.spf.days_remaining

integer | null

checks.dns.spf.error

string | null

checks.dns.spf.expected

string[] | null

checks.dns.spf.expires_at

string | null

checks.dns.spf.issuer

string | null

checks.dns.spf.record

string | null

checks.dns.spf.records

string[] | null

checks.dns.spf.status_code

integer | null

checks.ports

DomainHealthPortChecks · object

必填

邮件服务端口可达性探测。

Hide child attributes

checks.ports.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ports.error

string | null

checks.ports.imap_143

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.ports.imap_143.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ports.imap_143.actual

string[] | null

checks.ports.imap_143.code

string | null

checks.ports.imap_143.days_remaining

integer | null

checks.ports.imap_143.error

string | null

checks.ports.imap_143.expected

string[] | null

checks.ports.imap_143.expires_at

string | null

checks.ports.imap_143.issuer

string | null

checks.ports.imap_143.record

string | null

checks.ports.imap_143.records

string[] | null

checks.ports.imap_143.status_code

integer | null

checks.ports.imaps_993

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.ports.imaps_993.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ports.imaps_993.actual

string[] | null

checks.ports.imaps_993.code

string | null

checks.ports.imaps_993.days_remaining

integer | null

checks.ports.imaps_993.error

string | null

checks.ports.imaps_993.expected

string[] | null

checks.ports.imaps_993.expires_at

string | null

checks.ports.imaps_993.issuer

string | null

checks.ports.imaps_993.record

string | null

checks.ports.imaps_993.records

string[] | null

checks.ports.imaps_993.status_code

integer | null

checks.ports.smtp_25

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.ports.smtp_25.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ports.smtp_25.actual

string[] | null

checks.ports.smtp_25.code

string | null

checks.ports.smtp_25.days_remaining

integer | null

checks.ports.smtp_25.error

string | null

checks.ports.smtp_25.expected

string[] | null

checks.ports.smtp_25.expires_at

string | null

checks.ports.smtp_25.issuer

string | null

checks.ports.smtp_25.record

string | null

checks.ports.smtp_25.records

string[] | null

checks.ports.smtp_25.status_code

integer | null

checks.ports.submission_587

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.ports.submission_587.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ports.submission_587.actual

string[] | null

checks.ports.submission_587.code

string | null

checks.ports.submission_587.days_remaining

integer | null

checks.ports.submission_587.error

string | null

checks.ports.submission_587.expected

string[] | null

checks.ports.submission_587.expires_at

string | null

checks.ports.submission_587.issuer

string | null

checks.ports.submission_587.record

string | null

checks.ports.submission_587.records

string[] | null

checks.ports.submission_587.status_code

integer | null

checks.ssl

DomainHealthProbeDetail · object

必填

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.ssl.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.ssl.actual

string[] | null

checks.ssl.code

string | null

checks.ssl.days_remaining

integer | null

checks.ssl.error

string | null

checks.ssl.expected

string[] | null

checks.ssl.expires_at

string | null

checks.ssl.issuer

string | null

checks.ssl.record

string | null

checks.ssl.records

string[] | null

checks.ssl.status_code

integer | null

checks.web

DomainHealthHttpChecks · object

必填

HTTP 和 HTTPS 可达性探头。

Hide child attributes

checks.web.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.web.error

string | null

checks.web.http_root

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.web.http_root.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.web.http_root.actual

string[] | null

checks.web.http_root.code

string | null

checks.web.http_root.days_remaining

integer | null

checks.web.http_root.error

string | null

checks.web.http_root.expected

string[] | null

checks.web.http_root.expires_at

string | null

checks.web.http_root.issuer

string | null

checks.web.http_root.record

string | null

checks.web.http_root.records

string[] | null

checks.web.http_root.status_code

integer | null

checks.web.http_www

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.web.http_www.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.web.http_www.actual

string[] | null

checks.web.http_www.code

string | null

checks.web.http_www.days_remaining

integer | null

checks.web.http_www.error

string | null

checks.web.http_www.expected

string[] | null

checks.web.http_www.expires_at

string | null

checks.web.http_www.issuer

string | null

checks.web.http_www.record

string | null

checks.web.http_www.records

string[] | null

checks.web.http_www.status_code

integer | null

checks.web.https_root

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.web.https_root.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.web.https_root.actual

string[] | null

checks.web.https_root.code

string | null

checks.web.https_root.days_remaining

integer | null

checks.web.https_root.error

string | null

checks.web.https_root.expected

string[] | null

checks.web.https_root.expires_at

string | null

checks.web.https_root.issuer

string | null

checks.web.https_root.record

string | null

checks.web.https_root.records

string[] | null

checks.web.https_root.status_code

integer | null

checks.web.https_www

DomainHealthProbeDetail · object | null

单个域运行状况探测的状态和详细信息。

Hide child attributes

checks.web.https_www.status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

checks.web.https_www.actual

string[] | null

checks.web.https_www.code

string | null

checks.web.https_www.days_remaining

integer | null

checks.web.https_www.error

string | null

checks.web.https_www.expected

string[] | null

checks.web.https_www.expires_at

string | null

checks.web.https_www.issuer

string | null

checks.web.https_www.record

string | null

checks.web.https_www.records

string[] | null

checks.web.https_www.status_code

integer | null

domain_id

string<uuid>

必填

domain_name

string

必填

summary_status

enum<string>

必填

可用选项:

healthy,

warning,

critical,

unknown

timings_ms

时间女士 · object

必填

Hide child attributes

timings_ms.{key}

integer

获取域名

更新域名

获取域名健康状态

curl --request GET \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health \
  --header 'Authorization: Bearer <token>'

{
  "cache_ttl_seconds": 123,
  "cached": true,
  "checked_at": "<string>",
  "checks": {
    "dns": {
      "a": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "dkim": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "dmarc": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "error": "<string>",
      "mx": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "ns": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "spf": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    },
    "ports": {
      "error": "<string>",
      "imap_143": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "imaps_993": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "smtp_25": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "submission_587": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    },
    "ssl": {
      "actual": [
        "<string>"
      ],
      "code": "<string>",
      "days_remaining": 123,
      "error": "<string>",
      "expected": [
        "<string>"
      ],
      "expires_at": "<string>",
      "issuer": "<string>",
      "record": "<string>",
      "records": [
        "<string>"
      ],
      "status_code": 123
    },
    "web": {
      "error": "<string>",
      "http_root": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "http_www": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "https_root": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      },
      "https_www": {
        "actual": [
          "<string>"
        ],
        "code": "<string>",
        "days_remaining": 123,
        "error": "<string>",
        "expected": [
          "<string>"
        ],
        "expires_at": "<string>",
        "issuer": "<string>",
        "record": "<string>",
        "records": [
          "<string>"
        ],
        "status_code": 123
      }
    }
  },
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_name": "<string>",
  "timings_ms": {}
}