API-Referenz

Domains

Absenderidentitäten anlegen und den Status der DNS-Verifizierung verstehen.

Domains filtern

POST/domains

API-Schlüssel

Absenderdomain hinzufügen

Anfrage

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

Antwort 201

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

GET/domains

API-Schlüssel

Domains und zwischengespeicherten DNS-Status auflisten

Anfrage

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

Antwort 200

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

GET/domains/:id

API-Schlüssel

Einrichtungsdetails einer Domain abrufen

Anfrage

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

Antwort 200

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

POST/domains/:id/verify

API-Schlüssel

SES- und DNS-Verifizierung aktualisieren

Anfrage

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

Antwort 200

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

DELETE/domains/:id

API-Schlüssel

Domain löschen

Anfrage

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

Antwort 200

{
  "ok": true
}

GET/dns/provider

API-Schlüssel

Autoritativen DNS-Provider und relative Hosts der Einträge ermitteln

Ermittelt anhand der aktiven Nameserver den autoritativen DNS-Provider der Domain und gibt für jeden erforderlichen Eintrag den einzutragenden relativen Host, den empfohlenen DMARC-Eintrag, den Status des Inbound-MX sowie die verfügbaren Methoden zur Einrichtung per Klick zurück.

Query-Parameterdomain_id

Anfrage

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

Antwort 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-Schlüssel

Domain-Connect-Zustimmungslink für die DNS-Einrichtung per Klick erstellen

Unterstützt der autoritative DNS-Provider das Domain-Connect-Template von SendHQ, wird eine signierte Zustimmungs-URL des Providers zurückgegeben. Eine Person muss die URL öffnen und die Änderung beim DNS-Provider freigeben; SendHQ erhält nie dauerhafte DNS-Zugangsdaten. Gibt 409 zurück, wenn der Provider das Template nicht unterstützt.

Query-Parameterdomain_idnext

Anfrage

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

Antwort 200

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