Elencare i domini personalizzati

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

Elenca i domini di accesso personalizzati dell'ambiente, dal più vecchio. È supportata solo la paginazione in avanti (after); before e qualsiasi order diverso da asc restituiscono 422. I domini rimossi (released) sono esclusi salvo include_released=true; status restituisce solo i domini in quello stato (released incluso). Un ambiente ha al massimo 1 dominio personalizzato (20 su Enterprise).

Richiesta

Campo Tipo Obbligatorio Descrizione
limit integer no Dimensione della pagina, 1-100 (predefinito 20).
after string no Cursore da list_metadata.after della pagina precedente.
status string no Solo i domini in questo stato: pending_dns, issuing, active, degraded, disabled o released.
include_released boolean no Con true sono elencati anche i domini rilasciati. Ignorato quando è indicato status.

Nessun corpo della richiesta.

Risposta

200 OK con una pagina di domini (gli elementi dell'elenco non hanno il campo 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
  }
}

Errori

HTTP code Quando
422 invalid_cursor Il cursore non è valido o appartiene a un altro filtro.
422 validation_failed Un parametro di query non è valido (before, order=desc, status sconosciuto).
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha il permesso richiesto.
429 rate_limited Limite di frequenza superato; riprova dopo il periodo Retry-After.
503 service_unavailable Una dipendenza è temporaneamente non disponibile; riprova dopo il periodo Retry-After.

Esempio

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