Manage allowed ipaddress API | NTT Communications DeveloperPortal

本ドキュメントでは権限管理者を親IDと表記します。

親IDはビジネスポータルからお申込頂いたID、或いは当社担当者より払い出されたそれに相当するIDを指します。

Overview（近日公開予定）

本APIは親IDのアクセス可能なソースIPアドレスの設定を管理するAPIです。親IDはビジネスポータルから申し込みの際、或いは当社担当者より払い出される際に必ずそのIDのソースIPアドレス初期登録を行ってます。 #1

#1 2025年8月以降新規に発行するIDの場合。2025年8月以前に発行のIDは初期値として一律0.0.0.0/0が設定されています。

IPアドレスの制限イメージ

下記のように登録のないIPアドレスからの親IDのアクセスはエラーとなります。

親IDのAPIキー利用の注意事項

セキュリティの観点から、全てのAPIが操作できる親IDによるAPIの操作は、IAM APIおよび本APIでのみご利用ください。親ID向け以外のAPIの操作は適切な権限を紐付けたユーザを作成し、実施してください。

How to use this API

本APIを使って、親IDのソースIPアドレスを管理するケースは以下の通りです。

1.現在の設定値を変更したい場合（例）今まで使用していたクライアントサーバのIPアドレスが変更となるとき

2.現在の設定値を参照したい場合（例）実際の設定値を失念しどのIPアドレスから親IDが使用できるのか参照したいとき

実際の使用例

例えば現在12.23.56.78/32 が登録されている状態で34.56.78.9/32を追加する変更をする場合にご利用いただけます。

<変更前/変更時>

12.23.56.78/32が登録されている状態から12.23.56.78/32 と34.56.78.9/32が登録された状態に変更

<変更後>

12.23.56.78/32 と34.56.78.9/32から親IDが使用できます

Resource URL

グローバル共通ドメインをご利用ください。お客様のご利用箇所の状況に応じて、最も応答の早いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/manage-allowed-ipaddress

Resource Information

Key	Value
レスポンスフォーマット	JSON
認証(OAuth)	Yes
帯域制御#2	Yes

#2 お客さま接続単位で適切な流量制限を実施

IPアドレス設定値の変更

親IDのIPアドレス設定値を変更します。

PUT /v1/manage-allowed-ipaddress

Request Parameters

Name	Description	Type	Mandatory	Notes
allowedIpAddresses	このIDで使用するソースIPアドレス	JSON	Yes	Ipv4のみ対応 CIDR表記必須#3 ,(半角カンマ)区切りで複数設定可能(100まで)

#3 CIDR表記例：192.168.1.0~192.168.1.255の範囲の場合は192.168.1.0/24と表記します。

Example Request

Content-Type: application/json; charset=utf-8

PUT /v1/manage-allowed-ipaddress
    {
      "allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
    }

Response Parameters

Name	Description	type	mandatory
allowedIpAddresses	変更後のIPアドレス	String	YES

Example Result

    {
      "allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
    }

IPアドレス設定値の参照

現在のIPアドレス設定値を参照します。

GET /v1/manage-allowed-ipaddress

Request Parameters

なし

Example Request

 GET /v1/manage-allowed-ipaddress

Response Parameters

Name	Description	type	mandatory
allowedIpAddresses	現在設定されているIPアドレス	String	YES

Example Result

    {
      "allowedIpAddresses":"10.10.10.10/32,172.168.10.0/24"
    }