自己IPアドレス確認API リファレンス

要約: リクエスト元のIPアドレスをそのまま返すシンプルなREST API。疎通確認・APIキーのIPホワイトリスト設定時の自IP特定・NAT/Proxy越しの実体IP確認などに使用。フリープランから利用可。

情報

このページは技術リファレンスです。ユースケース・料金・導入事例はこちら。

エンドポイント一覧この見出しへのリンク

メソッド	パス	用途
GET	`/v1/whoami`	アクセス元のIPアドレスを取得

共通仕様この見出しへのリンク

項目	内容
認証	`Authorization: Token YOUR_API_KEY`
Content-Type	`application/json`
プラン	本APIはフリープランでご利用いただけます (詳細は料金プラン)

GET /v1/whoamiこの見出しへのリンク

リソースURLこの見出しへのリンク

https://api.kenall.jp/v1/whoami

パラメータこの見出しへのリンク

パラメータはありません。

curl サンプルこの見出しへのリンク

curl -H "Authorization: Token YOUR_API_KEY" \
  https://api.kenall.jp/v1/whoami

レスポンス例この見出しへのリンク

{
  "remote_addr": {
    "type": "v4",
    "address": "<IPアドレス>"
  }
}

レスポンスフィールドこの見出しへのリンク

名前	型	説明	例
`remote_addr`	`object`	リモートアドレスの情報	—
`remote_addr.type`	`string`	IPアドレスのバージョン	`"v4"` `"v6"`
`remote_addr.address`	`string`	アクセス元のIPアドレス	`"0.0.0.0"`

HTTPステータス・エラーこの見出しへのリンク

HTTPステータス	意味	典型的な原因
200	OK	正常にIPアドレスを取得
401	Unauthorized	APIキー未設定／無効／Bearer スキームで送信
429	Too Many Requests	リクエスト量の制限超過
500	Server Error	サーバー側障害

SDK で呼び出すこの見出しへのリンク

JavaScript SDKこの見出しへのリンク

import { KENALL } from '@ken-all/kenall';
 
const api = new KENALL('YOUR_API_KEY');
const result = await api.whoami();
console.log(result.remote_addr.address); // => "0.0.0.0"

Pythonこの見出しへのリンク

import os, requests
res = requests.get(
    "https://api.kenall.jp/v1/whoami",
    headers={"Authorization": f"Token {os.environ['KENALL_API_KEY']}"},
    timeout=10,
)
print(res.json()["remote_addr"]["address"])

注意事項この見出しへのリンク

IPv6 対応について: 現在ケンオールは接続性の問題低減のため IPv6 接続を受け付けていません。将来対応予定。remote_addr.type は当面 "v4" のみ返ります。
NAT/Proxy 環境の挙動: remote_addr.address は、ケンオール側から実際に観測されるIPアドレスです。社内NAT・クラウドロードバランサーを経由する場合、それらのグローバルIPが返ります。
用途想定: APIキーのOrigin制限・IPホワイトリスト設定時に、サーバーのアウトバウンドIPを確認する目的で利用するのが典型。

このAPIに関する技術FAQこの見出しへのリンク

このAPIで何を確認できますか？

ケンオール側から見た、リクエスト元のグローバルIPアドレスです。サーバーや CI/CD パイプラインからのアウトバウンドIPを把握したい場面で使います。

IPv6 の address はどう返りますか？

現在 IPv6 接続は受け付けていないため、実質 IPv4 のみが返ります。IPv6 対応開始後は type: "v6" で IPv6 表記文字列が返る想定です。

APIキーがなくても叩けますか？

いいえ、Authorization: Token YOUR_API_KEY が必要です。認証なしでの公開エンドポイントとしては提供していません。

レート制限はありますか？

あります。プランごとの全API共通のレート制限が適用されます。短時間に大量に叩くと 429 が返ります。

OpenAPI スキーマこの見出しへのリンク

OpenAPI スキーマ (YAML): 2023-09-01 / 2024-01-01 / 2025-01-01