このトピックではPrivate Access Publishers および Private Apps 用にNetskope UI の新しい REST API v2 ページを使用する方法について説明します。
Netskope REST API 使う APIに対して認可された呼び出しを行うための認証トークン。 Netskope REST APIはURIパスを通じてリソースへのアクセスを提供します。テナントのREST APIコールごとにトークンは使うでなければなりません。 使う用のトークンは、 Netskope UIで指定されたAPIで Settings > Administration > Administrators & Roles > Administrators Service Account
トークンを作成するためのワークフローが変更されました。新しいトークンを作成する手順については、こちらを ご覧ください。
API パラメータ情報を確認するには、REST API v2 ページまたは REST API トークンの作成ダイアログボックスにあるAPI Documentation リンクをクリックしてください。これにより、Swagger UI が開きます。利用可能なエンドポイント、メソッド、およびパラメータが表示されます。
Swaggerでエンドポイントのペイロード情報を表示するには：
利用可能なパラメータを確認するには、 infrastructureなどのエンドポイントのいずれかをクリックしてください。infrastructureエンドポイントはパブリッシャー API のために使用されます。 steeringエンドポイントはプライベート アプリ API に使用されます。
パラメータデスクリプションは、使用可能な値、形式要件、および他のパラメータの使用に関連する要素に関する情報を提供します。 一部のパラメータでは、サポートされているオプションのドロップダウンリストが提供されますが、その他のパラメータは テキストフィールド入力です。
API 呼び出しで使用するエンドポイント リクエスト URL とパラメータをコピーします。 リクエストを送信する前に、トークンがNetskope-Api-Tokenヘッダーに追加されていることを確認してください。そうしないと、エラーが発生します。
API一覧
パブリッシャーを作成する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/createNPAPublishers
出版社を見つける： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherById
出版社一覧を入手する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublishers
発行者情報を更新する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/replaceNPAPublisherByID
パブリッシャーにパッチを適用する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/updateNPAPublisherById
パブリッシャーを削除する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/deleteNPAPublishers
パブリッシャーアラートの設定を取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherAlerts
パブリッシャーアラートの設定を更新してください。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/createNPAPublisherAlerts
一括更新パブリッシャーアクションをトリガーします。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/triggerNPAPublisherUpdates
パブリッシャーのリリース一覧を入手する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherObjects
パブリッシャーに関連付けられているすべてのプライベートアプリを取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherApps
パブリッシャー登録トークンを生成および取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/generateNPAPublisherToken
API Parameters
鍵 タイプ 例 デスクリプション apps_countinteger 3パブリッシャーに関連付けられているプライベートアプリの総数。 common_namestring e2eabac9e9f715ffパブリッシャーには固有の名前が生成されます。 connected_appsList List [ "[Cloud Exchange]", "[WebServer]" ]パブリッシャーに接続されているプライベートアプリの一覧。 idinteger 6発行者ID。 lbrokerconnectboolean falseパブリッシャーのローカルブローカー接続ステータス。 namestring pub1.local出版社名。 publisher_upgrade_profiles_idinteger 1パブリッシャーのアップグレードプロファイルのID。 adminUsersList [string] List [ "admin1@abc.com ", "admin2@abc.com " ]管理者セクションに登録されているユーザーの一覧。 eventTypesstring (Enum) List [ "CONNECTION_FAILED", "UPGRADE_STARTED" ]パブリッシャーによって生成されたイベントタイプの一覧。 selectedUsersstring abc@xyz.com,def@xyz.comパブリッシャーのイベントを必要とする追加ユーザー。
API一覧
パブリッシャーアップグレードプロファイルを作成する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/createNPAPublisherUpgradeProfile
パブリッシャーアップグレードプロファイルを取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/getNPAPublisherUpgradeProfile
パブリッシャーのアップグレードプロファイル一覧を取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/listNPAPublisherUpgradeProfiles
パブリッシャーアップグレードプロファイルを配置する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/updateNPAPublisherUpgradeProfile
パブリッシャーアップグレードプロファイルを削除する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/deleteNPAPublisherUpgradeProfile
発行者アップグレードプロファイルを複数の発行者セットに更新する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/BulkupdateNPAPublishers
API Parameters
鍵 タイプ 例 デスクリプション docker_tagstring 8690Dockerに存在する各リリースには、固有のタグが付けられています。 enabledboolean trueパブリッシャーのアップグレードプロファイルのステータス。 frequencystring 0 0 1 * TUE日付、時刻、月を指定します。 idinteger 10固有のパブリッシャープロファイルID。 publisher_upgrade_profiles_idinteger 1パブリッシャープロファイルの外部ID。 namestring My Upgrade profile発行者プロフィール名。 release_typestring Latest異なるパブリッシャーのビルドが利用可能かどうかについて言及しています。 timezonestring US/Easternタイムゾーンの選択。
API一覧
プライベートアプリを作成する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private
プライベートアプリを入手する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_private_app_id_
非公開アプリの一覧を取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private
プライベートアプリを更新する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_private_app_id_
プライベートアプリにパッチを適用する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_private_app_id_
プライベートアプリを削除する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_private_app_id_
プライベート アプリの使用に関するポリシーを取得します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_getpolicyinuse
API Parameters
鍵 タイプ 例 デスクリプション tokenstring "token":"<your_token>> "必須。NetskopeテナントからREST APIトークンを取得してください。トークンの生成方法については、 「新しい トークン の作成」をご覧ください。 app_namestring "app_name": "<application_name> "必須。プライベートアプリの名前。 hoststring "host":"host.com"必須。FQDN、ワイルドカードドメイン、IPサブネット、またはIPアドレスを入力してください。 publishersarray "publisher_id":"office-hq""publisher_name":"of ice-private-apps"必須。このアプリケーションへのアクセスを提供する発行者の名前および/またはID。 private_app_idstring "private_app_id":"office-365"必須。アクセスしているプライベートアプリのID。 protocolsarray"type":"tcp""port":"80""ports":"80,8010-8050"必須。プロトコルタイプとポートを定義します。タイプ値はTCPまたはUDPです。 private_app_protocolboolean "private_app_protocol":"https"任意。プライベートアプリで使用するプロトコル。 値はHTTPまたはHTTPSです。 clientless_accessboolean "clientless_access": true任意。プライベートアプリへのブラウザアクセスを有効にします。値は真か偽かのいずれかです。デフォルトはfalseです。 use_publisher_dnsboolean "use_publisher_dns": true任意。パブリッシャーDNSオプションを有効にします。値は真または偽です。 trust_self_signed_certsboolean "trust_self_signed_certs": true任意。信頼できる自己署名証明書を有効にする場合 ブラウザアクセス用。 値は真か偽かのいずれかです。デフォルトはfalseです。 fieldsstring “fields: id, name, host}任意。GETメソッドで指定されたJSONオブジェクト内のフィールドを返します。 silentboolean "silent": 1任意。ステータスコードは表示するが、データコードはスキップする。値は1（真）または0（偽）です。 is_user_portal_appboolean trueユーザーポータルアプリのステータス。 allow_unauthenticated_corsboolean falseCORSのステータス。 uri_bypass_header-valuestring X-NSKP-URIBYPASSURIバイパスヘッダー。 bypass_uris[string] ["/1/", "/2/",... "/20/"]バイパスするURIのリスト。 app_option{} 現在は使っていません。 無視する。 (オプション) RDP/SSH で使用するオプション。 tagsString [{tag_id, tag_name}] [{tag_id, tag_name}]プライベートアプリのタグ一覧 real_hoststring www.use-fqdn.comホストは主にブラウザ アクセス ベースで使用されます。
API一覧
NPAリアルタイムポリシーを作成する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/post_api_v2_policy_npa_rules
NPAリアルタイムポリシーを入手しましょう： https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_rules_id_
NPAのリアルタイムポリシーを入手する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_rules
NPAリアルタイムポリシーにパッチを適用する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/patch_api_v2_policy_npa_rules_id_
NPAリアルタイムポリシーを削除する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/delete_api_v2_policy_npa_rules_id_
API Parameters
鍵 タイプ 例 デスクリプション descriptionstring This is a NPA real time policy.ポリシーデスクリプション。 この値は現在、Netskopeテナントには表示されません。 enabledstring policy_nameリアルタイムポリシーのステータス。 group_idstring 1ポリシーグループID。 group_namestring policy_groupポリシーグループ名。 rule_datanpa_policy_rule_data 例が大きすぎて表示できません。 リアルタイムポリシーの構造。 access_method[文字列] 列挙型 [クライアント、クライアントレス] [Client]クライアントベースでもクライアントレスでも構いません。 dlp_actions{actions, dlp_profile} {“Allow”, “Payment Card”}DLP機能のアクション actions文字列列挙型: allow、block、alert、quarantine、bypass [“allow”]選択される列挙型の一つ。 dlp_profilestring “Payment Card”これらは事前に定義されたプロファイルです。 tss_actions{アクション名、修復プロファイル、重要度、テンプレート} {TSS機能に関するアクション。 action_name文字列列挙型: [block、alert、allow] [“alert”]選択される列挙型の一つ。 remediation_profilestring “profile_remedy”NPAには適用されません。 severity文字列列挙型: [low, medium, high] [medium]選択される列挙型の一つ。 templatestring Default template or Custom template ユーザー通知用に作成されたブロックテンプレートの名前。 tss_profile[string] デフォルトプロファイルまたはカスタムプロファイル 脅威防御プロファイルのスキャンを実行しています。 json_versioninteger 3（オプション）これは固定値であり、変更されません。 device_classification_id[integer] [45]デバイス分類IDの一覧。 match_criteria_actionstring action_name Enum [allow, block] [“allow”]RT ポリシーのアクション名。 policy_type文字列「プライベートアプリ」 “private-app”これは修正済みであり、変更されることはありません。 privateAppTagIdsList [string] List [“1”,“2”]タグIDのリスト。 privateAppTagsList [string] List [“tag1”,“tag2”]プライベートアプリのタグ一覧。 privateAppsList [string] List [“app1”,“app2”]非公開アプリ名のリスト。 privateAppsWithActivitiesファイルアクティビティのサイズと種類。 [TSSおよびDLPに適用されます。 userGroupsList [string] [“user/group1/group2”]グループユーザーの一覧。 userType文字列列挙型: [user] [“user”]これは修正済みであり、変更されることはありません。 users[ユーザー] [“user@netskope.com”]利用可能なユーザーのリストを追加できます。 organization_unitsList[string] List [“engineering/qa”]組織単位（OU）のリストを追加できます。 rule_namestring npa-policy-nameリアルタイムのポリシー名。 rule_ordernpa_rule_order {order,position, rule_id,rule_name}新しいポリシーを配置する場所のrule_order構造。 order文字列列挙型: [top, bottom, before, after] “top”リアルタイムポリシーを配置する必要があるポジション。 positioninteger 5（オプション）既存のルール順序値。 rule_idinteger 1ポリシーのルールIDが存在しました。 rule_namestring policy-nameルール順序における既存のポリシー名。
API一覧
NPAポリシー グループを作成します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/post_api_v2_policy_npa_policygroups
NPAポリシー グループを取得します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_policygroups_id_
NPAポリシー グループを取得します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/get_api_v2_policy_npa_policygroups
NPAポリシーグループにパッチを適用します: https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/patch_api_v2_policy_npa_policygroups_id_
NPAポリシー グループを削除します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/policy/delete_api_v2_policy_npa_policygroups_id_
API Parameters
鍵 タイプ 例 デスクリプション group_idinteger 4ポリシーグループID。 group_namestring npa-policy-groupポリシーグループの名前。 group_orderそれは構造物です。 {group_id: 1, "Order": before|after} グループ順序構造。 group_idstring "1"既存グループのグループID参照。 orderstring "before|after"新しいグループを配置する場所。
API一覧
NPA検出設定を作成する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_discoverysettings
NPA検出設定を取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_discoverysettings
API Parameters
鍵 タイプ 例 デスクリプション hostList [string] [“www.netskope.com”, “10.31.13.12”]FQDNとIPアドレスのリストを提供できます。 organization_unitsList [string] [“org/qa”]組織単位の一覧。 publishers{publisher_id, publisher_name, publisher_cn} {“132”,“netskope_publisher”, “d48fb11de337a0 f”}出版社一覧 publisher_idstring “132”発行者の固有ID。 publisher_namestring netskope_publisher出版社名。 publisher_cnstring d48fb11de337a0fパブリッシャーによくある一意の識別子。 statusstring Enum: [“ENABLED”, “DISABLED”] ENABLEDアプリの検出状況。 usersList [string] [“abc@netskope.com”]ユーザー一覧 userGroupsList [string] [“users/group1”]ユーザーグループの一覧。
API一覧
発行者情報を更新する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_publishers
パブリッシャーにパッチを適用する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_publishers
パブリッシャーを削除する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_publishers
API Parameters
鍵 タイプ 例 デスクリプション private_app_idsList [string] [“1”, “48”]提供すべきプライベートアプリIDのリスト。 publisher_idsList [string] [“56”, “69”]提供すべき発行者IDのリスト。
API一覧
プライベートアプリタグを作成する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_tags
プライベートアプリタグを取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_tags_tag_id_
プライベートアプリタグのリストを取得する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/get_api_v2_steering_apps_private_tags
Update a Private App Tags: https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_private_app_id_
プライベートアプリタグのパッチ適用（プライベートアプリの一括アップデート）： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/patch_api_v2_steering_apps_private_tags
プライベートアプリタグを削除する: https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_tags_tag_id_
タグ関連付けのあるプライベートアプリを削除する： https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/delete_api_v2_steering_apps_private_tags
プライベートアプリタグの使用におけるポリシーの数を取得します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/post_api_v2_steering_apps_private_tags_getpolicyinuse
タグIDに基づいてプライベートアプリのタグを更新します。 https://<tenant-URL> /apidocs/?include_beta_routes=1#/steering/put_api_v2_steering_apps_private_tags_tag_id_
API Parameters
鍵 タイプ 例 デスクリプション idstring “23”, “13”これはプライベートアプリIDです。 tags{[tag_name]} [{“tag1”},{“tag2”}]指定された形式です。 tag_namestring “tag1”タグの名前。 ids[string] [“2”, “5”]プライベートアプリIDのリスト。
API一覧
ローカルブローカーを作成する：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers
地元のブローカーを探しましょう：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers id_
地元のブローカー一覧を入手する：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers
現地ブローカーの情報を更新する：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/put_api_v2_infrastructure_lbrokers_id_
ローカルブローカーを削除する:
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/delete_api_v2_infrastructure_lbrokers_id_
Create a Local Broker Hostname Config:
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers_brokerconfig
Update a Local Broker Hostname Config:
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/put_api_v2_infrastructure_lbrokers_brokerconfig
Get a Local Broker Hostname Config:
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_lbrokers_brokerconfig
ローカルブローカー登録トークンの生成と取得：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_lbrokers_id_registrationtoken
入力された名前が有効な重複名かどうかを確認してください。
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/get_api_v2_infrastructure_npa_namevalidation
リソースタイプに基づいてリソースを検証する：
https://<tenant-URL> /apidocs/?include_beta_routes=1#/infrastructure/post_api_v2_infrastructure_npa_resource_validation_resourcetype_
API Parameters
鍵 タイプ 例 デスクリプション namestring localbroker1現地ブローカーの名前。 common_namestring d48fb11de337a0f ご当地ブローカよくある名前 idinteger 45現地ブローカーの固有ID。 registeredboolean true現地ブローカー登録状況。 hostnamestring www.localconnect.comローカルブローカーDNSのFQDN。
