Get Domain Health
Return customer-facing health diagnostics for a domain.
curl --request GET \
--url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.
Query Parameters
Response
Grouped domain health probe results.
Hide child attributes
Hide child attributes
DNS-related health probes.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Mail service port reachability probes.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown HTTP and HTTPS reachability probes.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown Status and details for an individual domain health probe.
Hide child attributes
Hide child attributes
healthy, warning, critical, unknown healthy, warning, critical, unknown curl --request GET \
--url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/{domain}/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}