APIリファレンス

ドメイン

送信者IDを作成し、DNS検証の状態を把握します。

ドメインのエンドポイントを絞り込む

POST/domains

APIキー

送信ドメインを追加する

リクエスト

curl https://sendhq.cc/api/v1/domains \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"example.com"}'

201 レスポンス

{
  "id": "dom_…",
  "name": "example.com",
  "status": "pending",
  "records": []
}

GET/domains

APIキー

ドメインとキャッシュ済みのDNS状態を一覧表示する

リクエスト

curl https://sendhq.cc/api/v1/domains \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "data": [],
  "count": 0
}

GET/domains/:id

APIキー

ドメインの設定詳細を取得する

リクエスト

curl https://sendhq.cc/api/v1/domains/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "id": "dom_…",
  "name": "example.com",
  "setup_status": "checking",
  "records": [],
  "dns_issues": []
}

POST/domains/:id/verify

APIキー

SESとDNSの検証を更新する

リクエスト

curl https://sendhq.cc/api/v1/domains/id_value/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "domain": {
    "id": "dom_…",
    "status": "verified"
  },
  "checks": {
    "ses": true
  },
  "status": "verified"
}

DELETE/domains/:id

APIキー

ドメインを削除する

リクエスト

curl https://sendhq.cc/api/v1/domains/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "ok": true
}

GET/dns/provider

APIキー

権威DNSプロバイダーとレコードの相対ホストを検出する

実際のネームサーバーからドメインの権威DNSプロバイダーを検出し、必要な各レコードに入力する相対ホスト、推奨されるDMARCレコード、受信用MXの状態、利用可能なワンクリック設定方法を返します。

クエリパラメータdomain_id

リクエスト

curl https://sendhq.cc/api/v1/dns/provider \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "detectionStatus": "confirmed",
  "detected": "cloudflare",
  "zone": "example.com",
  "nameservers": [
    "ada.ns.cloudflare.com"
  ],
  "recordHosts": {},
  "inbound": {
    "available": true,
    "domain": null,
    "status": "not_configured",
    "record": null
  },
  "recommendations": [],
  "authentication": {},
  "providers": {
    "domainConnect": {
      "available": false,
      "providerName": null
    }
  }
}

GET/dns/domain-connect/connect

APIキー

ワンクリックDNS設定用のDomain Connect同意リンクを作成する

権威DNSプロバイダーがSendHQのDomain Connectテンプレートに対応している場合、署名付きのプロバイダー同意URLを返します。ユーザー本人がURLを開き、DNSプロバイダー上で変更を承認する必要があります。SendHQが恒常的なDNS認証情報を受け取ることはありません。プロバイダーがテンプレートに対応していない場合は409を返します。

クエリパラメータdomain_idnext

リクエスト

curl https://sendhq.cc/api/v1/dns/domain-connect/connect \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 レスポンス

{
  "url": "https://dns-provider.example/v2/domainTemplates/…",
  "providerName": "Example DNS"
}