# IP許可リストAPIのエンドポイント

利用対象...

* Cloud API Services Platform
* Cloud Big Data
* Cloud Big Data Platform
* Cloud Data Fabric
* Cloud Data Integration
* Cloud Data Management Platform
* Cloud Pipeline Designer Standard Edition
* Data Fabric

このAPIへのアクセスに使われるホストはhttps://api.&lt;env&gt;.cloud.talend.comです。

このAPIサービスの全容がわかるAPIドキュメンテーションは、https://api.&lt;env&gt;.cloud.talend.com/v1/management/swagger-ui/?urls.primaryName=IP%20Allowlist%20Managementをご覧ください。

&lt;env&gt;には、お使いのクラウドリージョンが入ります。リージョン名がわからない場合は、[Talend Cloudのアプリケーションにアクセス](https://help.qlik.com/talend/ja-JP/installation-guide-windows/Cloud/talend-cloud-application-url)をご覧ください。

APIの呼び出しにはアクセストークンを使用する必要があります。アクセストークンを生成する方法、およびそのトークンを使用する方法の詳細は、[パーソナルアクセストークンを生成](https://help.qlik.com/talend/r/ja-JP/Cloud/management-console-user-guide/cloud-access-token)をご覧ください。

次の表には、IP許可リストAPIエンドポイントと必要な権限が示されています

| [Operations] (操作) | メソッド | リソース | 必要な権限 |
| --- | --- | --- | --- |
| IP許可リストポリシー(リスト上のIP、このポリシーが有効になっているかどうかなど)の設定の取得 | GET | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーの設定全体を構成します。このリクエストでは、IPを追加して(または追加せずに)IP許可リストを作成し、同時にIP許可リストポリシー有効にするかどうか定義します。<br><br>IP許可リストポリシーが有効になると、Talend Cloudにアクセスできるのは許可リストに登録されているIPだけとなります。 | POST | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーの設定をアップデートします。このリクエストでは、既存のIP許可リストにIPを追加し、同時にIP許可リストポリシーを有効または無効にします。<br><br>IP許可リストポリシーが有効になると、Talend Cloudにアクセスできるのは許可リストに登録されているIPだけとなります。 | PUT | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーを削除します。 | DELETE | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストポリシーを有効または無効にします。 | PATCH | /v1/management/ip-allowlist | [Users - Management] (ユーザー - 管理) |
| IP許可リストからIPをすべて取得します。 | GET | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IIP許可リストに新しいIPを追加します。 | POST | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IP許可リストでIPセットをアップデートします。アップデートするIPのIDをリクエストに入力しておく必要があります。 | PUT | /v1/management/ip-allowlist/ips | [Users - Management] (ユーザー - 管理) |
| IP許可リストで、IDを使って特定のIPを取得します。 | GET | /v1/management/ip-allowlist/ips/&lt;ip\_entry\_id&gt; | [Users - Management] (ユーザー - 管理) |
| IP許可リストでIDを使ってIPを検索し、リクエストに入力した新しいアドレスでこのIPをアップデートします。 | PUT | /v1/management/ip-allowlist/ips/&lt;ip\_entry\_id&gt; | [Users - Management] (ユーザー - 管理) |
| IP許可リストから特定のIDを削除 | DELETE | /v1/management/ip-allowlist/ips/&lt;ip\_entry\_id&gt; | [Users - Management] (ユーザー - 管理) |