カスタムドメインを一覧表示

GET /v1/custom-domains · 権限 custom-domains:read

環境のカスタムログインドメインを古い順に一覧表示します。前方ページング (after) のみ対応し、before と asc 以外の order は 422 を返します。削除済み (released) のドメインは include_released=true を指定しない限り含まれません。status を指定するとその状態のドメインのみを返します (released を含む)。1 つの環境のカスタムドメインは最大 1 つです (Enterprise は 20)。

リクエスト

フィールド タイプ 必須 説明
limit integer いいえ ページサイズ、1-100 (既定 20)。
after string いいえ 前のページの list_metadata.after カーソル。
status string いいえ この状態のドメインのみ: pending_dns、issuing、active、degraded、disabled、released。
include_released boolean いいえ true の場合、解放済みのドメインも一覧表示します。status を指定した場合は無視されます。

リクエストボディはありません。

レスポンス

200 OK とドメインのページ (一覧の項目には 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
  }
}

エラー

HTTP コード 概要
422 invalid_cursor カーソルの形式が不正か、別のフィルターのものです。
422 validation_failed クエリパラメーターが無効です (before、order=desc、不明な status)。
401 unauthenticated 認証情報がない、無効、または失効しています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の時間が経過してから再試行してください。
503 service_unavailable 依存サービスが一時的に利用できません。Retry-After の時間が経過してから再試行してください。

例

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