Skip to main content
GET
/
v1
/
public
/
accounts
/
{account_id}
/
domains
/
{domain}
/
health
Get 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": {}
}

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
account_id
string<uuid>
required
​
domain
string
required

Query Parameters

​
refresh
boolean
default:false

Response

​
cache_ttl_seconds
integer
required
​
cached
boolean
required
​
checked_at
string
required
​
checks
DomainHealthChecks · object
required

Grouped domain health probe results.

​
domain_id
string<uuid>
required
​
domain_name
string
required
​
summary_status
enum<string>
required
Available options:
healthy,
warning,
critical,
unknown
​
timings_ms
Timings Ms · object
required