Benutzerdefinierte Domänen auflisten

GET /v1/custom-domains · Berechtigung custom-domains:read

Listet die benutzerdefinierten Anmeldedomänen der Umgebung, älteste zuerst. Nur Vorwärtspaginierung (after) wird unterstützt; before und jedes order außer asc liefern 422. Entfernte (released) Domänen werden nur mit include_released=true aufgeführt; status liefert nur Domänen in diesem Status (einschließlich released). Eine Umgebung hat höchstens 1 benutzerdefinierte Domäne (20 bei Enterprise).

Anfrage

Feld Typ Erforderlich Beschreibung
limit integer nein Seitengröße, 1-100 (Standard 20).
after string nein Cursor aus list_metadata.after der vorherigen Seite.
status string nein Nur Domänen in diesem Status: pending_dns, issuing, active, degraded, disabled oder released.
include_released boolean nein Bei true werden auch freigegebene Domänen aufgeführt. Wird ignoriert, wenn status angegeben ist.

Kein Request-Body.

Antwort

200 OK mit einer Seite von Domänen (Listeneinträge haben kein caa-Feld).

{
  "data": [
    {
      "id": "cdom_01j9xk3m7q8r2s4t6v8w0y2z4a",
      "hostname": "login.example.com",
      "is_primary": true,
      "status": "active",
      "failure_reason": null,
      "dns_records": [
        {
          "type": "TXT",
          "name": "_akp-verify.login.example.com",
          "value": "idp-verify=3q2-7wEXAMPLEtokenQ9"
        },
        {
          "type": "CNAME",
          "name": "login.example.com",
          "value": "acme.eu.edge.keenauth.app"
        }
      ],
      "certificate_expires_at": "2027-01-04T09:31:12Z",
      "last_checked_at": "2026-10-05T09:31:00Z",
      "next_check_at": null,
      "activated_at": "2026-10-05T09:31:12Z",
      "degraded_since": null,
      "status_changed_at": "2026-10-05T09:31:12Z",
      "created_at": "2026-10-05T09:30:00.123456Z",
      "updated_at": "2026-10-05T09:31:12Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

Fehler

HTTP Code Wann
422 invalid_cursor Der Cursor ist fehlerhaft oder gehört zu einem anderen Filter.
422 validation_failed Ein Query-Parameter ist ungültig (before, order=desc, unbekannter status).
401 unauthenticated Die Anmeldeinformation fehlt, ist ungültig oder widerrufen.
403 insufficient_permissions Der Anmeldeinformation fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; nach der Retry-After-Zeit erneut versuchen.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; nach der Retry-After-Zeit erneut versuchen.

Beispiel

curl "https://api.eu.keenauth.com/v1/custom-domains?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"