Manage allowed ipaddress API

Overview(近日公開予定)

本APIは権限管理者アカウント(ビジネスポータルからお申込頂いたアカウント、或いは当社担当者より払い出されたそれに相当するアカウント)のソースIPアドレスの設定を管理するAPIです。

権限管理者アカウントはビジネスポータルから申し込みの際、或いは当社担当者より払い出される際に必ずそのアカウントのソースIPアドレス初期登録を行ってます。 #1

  • #1 2025/8以降新規に発行するアカウントの場合。2025/8以前に発行のアカウントは初期値として一律0.0.0.0.0/0が設定されています。
IPアドレスの制限イメージ

IPアドレスの認可制御イメージは以下の通り。

権限管理者のAPIキー利用の注意事項

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

How to use this API

本APIを使って、権限管理者アカウントのソースIPアドレスを管理するケースは以下の通りです。

1.現在の設定値を変更したい場合

(例)今まで使用していたクライアントサーバのIPアドレスが変更となるとき

2.現在の設定値を参照したい場合

(例)実際の設定値を失念しどのIPアドレスからアカウントが使用できるのか参照したいとき

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アドレス設定値の変更

権限管理者アカウントのIPアドレス設定値を変更します。

PUT /v1/manage-allowed-ipaddress

Request Parameters

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

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アドレス設定値の参照

ユーザ一覧を参照します。

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"
    }