Lister les domaines personnalisés

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

Liste les domaines de connexion personnalisés de l'environnement, du plus ancien au plus récent. Seule la pagination vers l'avant (after) est prise en charge ; before et tout order autre que asc renvoient 422. Les domaines supprimés (released) sont exclus sauf avec include_released=true ; status ne renvoie que les domaines dans cet état (released compris). Un environnement a au plus 1 domaine personnalisé (20 en Enterprise).

Requête

Champ Type Obligatoire Description
limit integer non Taille de page, 1-100 (20 par défaut).
after string non Curseur list_metadata.after de la page précédente.
status string non Uniquement les domaines dans cet état : pending_dns, issuing, active, degraded, disabled ou released.
include_released boolean non Si true, les domaines libérés sont aussi listés. Ignoré lorsque status est fourni.

Pas de corps de requête.

Réponse

200 OK avec une page de domaines (les éléments de liste n'ont pas de champ caa).

{
  "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
  }
}

Erreurs

HTTP code Quand
422 invalid_cursor Le curseur est mal formé ou appartient à un autre filtre.
422 validation_failed Un paramètre de requête est invalide (before, order=desc, status inconnu).
401 unauthenticated L'identifiant est absent, invalide ou révoqué.
403 insufficient_permissions L'identifiant n'a pas la permission requise.
429 rate_limited La limite de débit a été dépassée ; réessayez après le délai Retry-After.
503 service_unavailable Une dépendance est temporairement indisponible ; réessayez après le délai Retry-After.

Exemple

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