microCMS

APIのIP制限

最終更新日:2024年04月22日

APIのIP制限は、コンテンツAPIやマネジメントAPIへのアクセスに対して、IP制限をかけることができる機能です。セキュリティ対策の強化のために、ご活用いただけます。

informationInformation

APIのIP制限はBusinessプラン、Advancedプラン、Enterpriseプランでご利用いただける機能です。
プランごとに利用できる機能については、料金プランページをご覧ください。

制限対象

  • コンテンツAPI(すべてのエンドポイント)
  • マネジメントAPI(すべてのエンドポイント)

設定方法

制限は以下の単位で設定することが可能です。

  • 環境(同じ環境内に所属するすべてのAPI)
  • API
tipsTips
  • すべてのAPIにほぼ同一の制限をかける場合は、環境単位でIPアドレスを設定した上で、必要なAPIのみ上書きしてください。
  • 特定のAPIのみ制限をかける場合は、環境単位では設定を行わず、必要なAPIにIPアドレスを設定してください。

環境単位での設定

環境単位でのIP制限は、「サービス設定」→「APIのIP制限」より設定が可能です。



アクセスを許可するIPアドレスを入力し、「変更する」ボタンを押下してください。


API単位での設定

API単位でのIP制限は、対象のAPIの「API設定」→「APIのIP制限」より設定が可能です。



「個別に設定する」をオンにした後、アクセスを許可するIPアドレスを入力し、「変更する」ボタンを押下してください。


informationInformation
  • IPv4 / IPv6のCIDR記法に対応しています。
  • 一つのAPIに設定できる許可IPアドレスの上限数は、Businessプランでは30個、Advancedプランでは100個までです。

補足事項

指定されたIPアドレス以外からリクエストがあった場合

HTTPのステータスとして 400 Bad Request のレスポンスが返却されます。メッセージは以下の通りです。

{
    "message": "IP address rejected"
}