ワークスペース（「アプリケーション」）の JSON オブジェクトは、API エンドポイントに応じて、単一のオブジェクトまたはオブジェクトの配列として返されます。オブジェクトの属性については、以下で説明します。

このエンドポイントは、ワークスペース（「アプリケーション」）の配列を返します。

GET /openapi/v1/applications

応答オブジェクト：ワークスペースオブジェクトの配列を返します。

サンプル python コード

restclient.get('/applications')

このエンドポイントは、要求されたワークスペース（「アプリケーション」）を 1 つの JSON オブジェクトとして返します。

GET /openapi/v1/applications/{application_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID のワークスペースオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  restclient.get('/applications/%s' % application_id)

このエンドポイントは、ワークスペース（「アプリケーション」）を作成します。クラスタとポリシーの定義を含む JSON 本文をポストすることによって、ポリシーを定義することができます。

（注）	同じ範囲にプライマリワークスペースが存在し、新しいポリシーが提供されている場合、ポリシーは新しいバージョンとして既存のワークスペースに追加されます。

POST /openapi/v1/applications

パラメータ：JSON クエリの本文には、次のキーが含まれています。

ワークスペース内で作成されるポリシーを記述する、追加のオプションパラメータを含めることもできます。

（注）	このスキームは、UI と詳細エンドポイントからのエクスポート時に返されるものに対応しています。

クラスタ オブジェクト属性:

ノード オブジェクトの属性:

インベントリ フィルタ オブジェクトの属性:

ポリシー オブジェクトの属性:

L4Params オブジェクト属性：

応答オブジェクト：新しく作成されたワークスペースオブジェクトを返します。

サンプル python コード

  name = 'test'
  scope_id = '5ce480cc497d4f1b4b9a9e8d'
  filter_id = '5ce480cd497d4f1b4b9a9ea4'
  application = {
      'app_scope_id': scope_id,
      'name': name,
      'absolute_policies': [
          {
	      # consumer/provider filter IDs can be ID of a cluster identified during automatic policy discovery (formerly known as ADM),
	      # user inventory filter or app scope.
              'provider_filter_id': filter_id,
              'consumer_filter_id': filter_id,
              'action': 'ALLOW',
	      # ALLOW policy for TCP on port 80.
              'l4_params': [
                  {
                      'proto': 6, # TCP
                      'port': [80, 80],  # port range
                  }
              ],
          }
      ],
      'catch_all_action': 'ALLOW'
  }
  restclient.post('/applications', json_body=json.dumps(application))

ポリシーをインポートし、ワークスペース（「アプリケーション」）の新しい v* バージョンを作成します。

POST /openapi/v1/applications/{application_id}/import

パラメータは、ワークスペース エンドポイントの作成と同じです。

応答オブジェクト：ワークスペースオブジェクトを返します。

新しいバージョンを作成せずに一連のポリシーを検証します。

POST /openapi/v1/applications/validate_policies

app_scope_id は必須です。残りのパラメータは、ワークスペース エンドポイントの作成と同じです。

応答オブジェクト：

ワークスペース（「アプリケーション」）を削除します。

DELETE /openapi/v1/applications/{application_id}

ワークスペースを削除する前に、ワークスペースで適用を無効にする必要があります。

ワークスペースまたはそのクラスタが他のアプリケーションによって（提供されるサービスの関係を介して）使用されている場合、このエンドポイントは 422 Unprocessable Entity を返します。返されるエラーオブジェクトには、details 属性が含まれ、依存オブジェクトの数とともに各タイプの最初の 10 個の ID が示されます。この情報を使用して、問題となっている依存関係を見つけて削除できます。

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  restclient.delete('/applications/%s' % application_id)

このエンドポイントにより、既存のワークスペース（「アプリケーション」）が更新されます。

PUT /openapi/v1/applications/{application_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON クエリの本文には、次のキーが含まれています。

応答オブジェクト：指定された ID の更新されたワークスペースオブジェクト。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  req_payload = {
        'name': 'Updated Name',
        'description': 'Updated Description',
        'primary': 'true'
  }
  resp = restclient.put('/applications/%s' % application_id,
                        json_body=json.dumps(req_payload))

このエンドポイントは、ワークスペースの完全なエクスポート JSON ファイルを返します。これには、ポリシーとクラスタの定義が含まれます。

GET/openapi/v1/applications/{application_id}/details

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定されたワークスペースバージョンのクラスタとポリシーを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  # For v* version v10 and for p* version p10
  version = 'v10'
  resp = restclient.get('/applications/%s/details?version=%s' % (application_id, version))

このエンドポイントは、特定のワークスペースのすべてのバージョンのリストを返します。

GET /openapi/v1/applications/{application_id}/versions

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：次の属性を持つオブジェクトの配列：

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  created_before = 1612325705
  limit = 10
  resp = restclient.get('/applications/%s/versions?created_before=%s&limit=%s' %
                        (application_id, created_before, limit))

このエンドポイントは、クラスタとポリシーを含む指定されたバージョンを削除します。適用または分析されたバージョンは削除されません。メンバーが外部ポリシーを介して別のワークスペースによって参照されている場合、応答は参照のリストと共にエラーを返します。

DELETE /openapi/v1/applications/{application_id}/versions/{version}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  version = 'v10'
  resp = restclient.delete('/applications/%s/versions/%s' %
                           (application_id, version))

このエンドポイントは、提供されたワークスペースバージョン間の相違を計算します。追加されたポリシー、削除されたポリシー、およびオプションで変更されていないポリシーを返します。両方のバージョンに、一致する consistent_uuid によって定義されたクラスタが存在し、クエリが変更された場合、クラスタの変更が含まれます。

GET /openapi/v1/applications/{application_id}/version_diff

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：次の属性を持つオブジェクトを返します。

ワークスペース内で一連の最新のポリシー分析を有効にします。

POST /openapi/v1/applications/{application_id}/enable_analysis

パラメータ：要求 URL には、次のパラメータが含まれています。

パラメータ：オプションの JSON クエリ本体には、次のキーが含まれます

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  req_payload = {
    'action_note': 'Policy analysis',
    'name': 'Test run 1',
    'description': 'New workloads added.'
  }
  resp = restclient.post('/applications/%s/enable_analysis' % application_id,
                         json_body=json.dumps(req_payload))

ワークスペースでポリシー分析を無効にします。

POST /openapi/v1/applications/{application_id}/disable_analysis

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  resp = restclient.post('/applications/%s/disable_analysis' % application_id)

ワークスペースで最新のポリシーセットの適用を有効にします。

POST /openapi/v1/applications/{application_id}/enable_enforce

警告	新しいホスト ファイアウォール ルールが挿入され、関連するホスト上で既存のルールがすべて削除されます。

パラメータ：要求 URL には、次のパラメータが含まれています。

バージョンが指定されていない場合、ワークスペースの最新のポリシーが適用されます。バージョンは「p*」の形式で指定することが推奨されます。整数のみが指定されている場合、対応する「p*」バージョンが適用されます。

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  req_payload = {
    'version': 'p10'
  }
  resp = restclient.post('/applications/%s/enable_enforce' % application_id,
                         json_body=json.dumps(req_payload))

ワークスペースへの適用を無効にします。

POST /openapi/v1/applications/{application_id}/disable_enforce

警告	新しいホスト ファイアウォール ルールが挿入され、関連するホスト上で既存のルールがすべて削除されます。

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  resp = restclient.post('/applications/%s/disable_enforce' %
                         application_id)

ワークスペースのポリシーを自動的に検出します（以前は「ADM 実行の送信」と呼ばれていました）。

POST /openapi/v1/applications/{application_id}/submit_run

パラメータ：要求 URL には、次のパラメータが含まれています。

パラメータ：JSON クエリの本文には、次のキーが含まれています。

（注）	ワークスペースで自動ポリシー検出が以前に実行された場合、指定されていないオプションパラメータのデフォルト値は、以前の自動ポリシー検出実行設定から取得されます。それ以外の場合、デフォルト値はデフォルトのポリシー検出設定から取得されます。

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  req_payload = {
        'start_time': '2020-09-17T10:00:00-0700',
        'end_time': '2020-09-17T11:00:00-0700',
        # Optional Parameters.
        'clustering_granularity': 'FINE',
        'port_generalization': 'AGGRESSIVE',
        'policy_compression': 'AGGRESSIVE',
        'auto_accept_policy_connectors': False,
        'enable_exclusion_filter': True,
        'enable_default_exclusion_filter': True,
        'enable_service_discovery': True,
        'carry_over_policies': True,
        'skip_clustering': False,
        'deep_policy_generation': True,
        'use_default_config': False
  }
  resp = restclient.post('/applications/%s/submit_run' % application_id,
                         json_body=json.dumps(req_payload))

ワークスペースで実行されている自動ポリシー検出のステータスをクエリします。

GET /openapi/v1/applications/{application_id}/adm_run_status

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：次の属性を持つオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  resp = restclient.get('/applications/%s/adm_run_status' % application_id)

ポリシーオブジェクトの属性については、以下で説明します。

L4Params オブジェクト属性：

このエンドポイントは、特定のワークスペースのポリシーのリストを返します。この API は、app_policy_management 機能を持つ API キーで使用できます。

GET /openapi/v1/applications/{application_id}/policies

パラメータ：要求 URL には、次のパラメータが含まれています。

ポリシー ID は、バージョンごとに変更できます。公開バージョンからポリシーのリストを取得するには、バージョン番号の前に「p」を付ける必要があります。たとえば、公開されたバージョン 3 のすべてのポリシーを取得するには、次のような要求を実行できます。

GET /openapi/v1/applications/{application_id}/policies?version=p3

以下に示すように、この特定のワークスペース内のすべてのポリシーのオブジェクトを返します。

    {
      absolute_policies: [ ... ],
      default_policies: [ ... ],
      catch_all_action:
    }

サンプル python コード

  application_id = '5f88c996755f023f3bafe163'
  restclient.get('/applications/%s/policies' % application_id, params={'version': '1'})

  application_id = '5f88c996755f023f3bafe163'
  restclient.get('/applications/%s/default_policies' % application_id, params={'version': '1', 'limit': 3, 'offset': 3})

    {
      "results": [
      PolicyObject4,
      PolicyObject5,
      PolicyObject6
      ],
      "offset": 6
    }

  application_id = '5f88c996755f023f3bafe163'
  restclient.get('/applications/%s/absolute_policies' % application_id, params={'version': '1', 'limit': 3})

    {
      "results": [
      PolicyObject1,
      PolicyObject2,
      PolicyObject3
      ],
      "offset": 3
    }

  application_id = '5f88c996755f023f3bafe163'
  restclient.get('/applications/%s/catch_all' % application_id, params={'version': '1'})

このエンドポイントは、ポリシーのインスタンスを返します。

GET /openapi/v1/policies/{policy_id}

指定した ID に関連付けられているポリシーオブジェクトを返します。

サンプル python コード

  policy_id = '5f88ca1e755f0222f85ce85c'
  restclient.get('/policies/%s' % policy_id)

このエンドポイントは、ポリシー識別子パラメータを複合キーとして使用して、特定のポリシーを検索します。

POST /openapi/v1/policies/search

クエリ本文は、次のスキーマを使用した JSON 本文で構成されます。

ポリシー識別子フィールドは、次のスキーマを使用して構成されています。

サンプル python コード

  application_id = '5f88ca1e755f0222f85ce85c'
  consumer_id = '5f88ca1e755f0222f85ce85d'
  provider_id = '5f88ca1e755f0222f85ce85d'
  rank = 'DEFAULT'
  action = 'ALLOW'
  priority = 100
  protocol = 6
  start_port = 80
  version = 'p3'

  req_body = f'''
  {{
      "application_id": "{application_id}",
      "policy_identifier": {{
          "consumer_consistent_uuid": "{consumer_id}",
          "provider_consistent_uuid": "{provider_id}",
          "rank": "{rank}",
          "action": "{action}",
          "priority": {priority},
          "protocol": "{protocol}",
          "start_port": "{start_port}",
          "version": "{version}"
      }}
  }}'''
  restclient.post('/policies/search', json_body=req_body)

このエンドポイントは、新しいポリシーを作成するために使用されます。

POST /openapi/v1/applications/{application_id}/policies

パラメータ：

サンプル python コード

  req_payload = {
    "version": "v1",
    "rank" : "DEFAULT",
    "policy_action" : "ALLOW",
    "priority" : 100,
    "consumer_filter_id" : "123456789",
    "provider_filter_id" : "987654321",
  }
  resp = restclient.post('/openapi/v1/applications/{application_id}/policies', json_body=json.dumps(req_payload))

このエンドポイントはポリシーを更新します。

PUT /openapi/v1/policies/{policy_id}

パラメータ：

指定された ID に関連付けられている変更されたポリシーオブジェクトを返します。

このエンドポイントは、特定のポリシーのサービスポートを作成するために使用されます。

POST /openapi/v1/policies/{policy_id}/l4_params

パラメータ：

このエンドポイントは、ポリシーの指定されたサービスポートを更新します。

PUT /openapi/v1/policies/{policy_id}/l4_params/{l4_params_id}

パラメータ：

このエンドポイントは、ポリシーの指定されたサービスポートを削除します。（オプション）詳細については、「除外フィルタ」を参照してください。

DELETE /openapi/v1/policies/{policy_id}/l4_params/{l4_params_id}

パラメータ：

このエンドポイントは、指定されたポリシーを削除します。除外フィルタは作成されません。

DELETE /openapi/v1/policies/{policy_id}

このエンドポイントは、ポリシー識別子パラメータを使用して、指定されたポリシーを削除します。除外フィルタは作成されません。

DELETE /openapi/v1/policies/destroy_with_identifier

クエリ本文は、次のスキーマを使用した JSON 本文で構成されます。

ポリシー識別子フィールドは、次のスキーマを使用して構成されています。

サンプル python コード

  application_id = '5f88ca1e755f0222f85ce85c'
  consumer_id = '5f88ca1e755f0222f85ce85d'
  provider_id = '5f88ca1e755f0222f85ce85d'
  action = 'ALLOW'
  rank = 'DEFAULT'
  protocol = 6
  start_port = 80
  priority = 100
  version = '5'

  req_body = f'''
  {{
      "application_id": "{application_id}",
      "policy_identifier": {{
          "consumer_consistent_uuid": "{consumer_id}",
          "provider_consistent_uuid": "{provider_id}",
          "rank": "{rank}",
          "priority": {priority},
          "action": "{action}",
          "protocol": "{protocol}",
          "start_port": "{start_port}",
          "version": "{version}"
      }}
  }}'''
  restclient.delete('/policies/destroy_with_identifier', json_body=req_body)

このエンドポイントを使用して、ルート範囲で分析または適用されたポリシーと一致する仮想フローの一連のポリシーを見つけることができます。詳細については、「簡易分析」を参照してください。

この API は、ルート範囲への最小限の読み取りアクセス権を持つユーザーのみが使用できます。また、API キーに関連付けられた app_policy_management 機能が必要です。

POST /openapi/v1/policies/{rootScopeID}/quick_analysis

クエリ本文は、次のスキーマを使用した JSON 本文で構成されます。

サンプル要求

要求の本文は、JSON 形式のクエリである必要があります。

分析されたすべてのポリシーに基づいてフローが決定されるクエリ本文の例は、次のようになります。

    req_payload = {
        "consumer_ip": "4.4.1.1",
        "provider_ip": "4.4.2.1",
        "provider_port": 9081,
        "protocol": "TCP",
        "analysis_type": "analyzed"
    }
    resp = restclient.post('/openapi/v1/policies/{rootScopeID}/quick_analysis', json_body=json.dumps(req_payload))

フローの決定が、ワークスペースの ‘v’ バージョンのポリシーと、ルート範囲内の他のすべてのワークスペースから分析されたポリシーに基づくクエリ本文の例は、次のようになります。

    req_payload = {
        "consumer_ip": "4.4.1.1",
        "provider_ip": "4.4.2.1",
        "provider_port": 9081,
        "protocol": "TCP",
        "analysis_type": "analyzed",
        "application_id": "5e7e5f56497d4f0bc26c7bb3",
        "version": 1
    }
    resp = restclient.post('/openapi/v1/policies/{rootScopeID}/quick_analysis', json_body=json.dumps(req_payload))

サンプル応答

この応答は、本文の JSON オブジェクトで、次のプロパティがあります。

    {
        "policy_decision": "ALLOW",
        "outbound_policy": {
            "policy_rank": "DEFAULT",
            "start_port": 9082,
            "l4_detail_id": "5e7e600f497d4f7341f4f6d0",
            "src_filter_id": "5e7e600e497d4f7341f4f459",
            "end_port": 9082,
            "cluster_edge_id": "5e7e600f497d4f7341f4f6d1",
            "dst_filter_id": "5e7d0efc497d4f44b6b09351",
            "action": "ALLOW",
            "protocol": "TCP",
            "app_scope_id": "5e7e5f3a497d4f0bc26c7bb0"
        },
        "inbound_policy": {
            "policy_rank": "DEFAULT",
            "start_port": 9082,
            "l4_detail_id": "5e7e600f497d4f7341f4f6d0",
            "src_filter_id": "5e7e600e497d4f7341f4f459",
            "end_port": 9082,
            "cluster_edge_id": "5e7e600f497d4f7341f4f6d1",
            "dst_filter_id": "5e7d0efc497d4f44b6b09351",
            "action": "ALLOW",
            "protocol": "TCP",
            "app_scope_id": "5e7e5f3a497d4f0bc26c7bb0"
        }
    }

このエンドポイントは、ある時間間隔でポリシーについて観察されたパケット、バイト、およびカンバセーションの数を返します。カンバセーションは、概して言えば 1 時間の実行間隔で集約されたポリシーに一致するフロー監視になります。1 時間以内に特定のポリシーについて測定されたカンバセーションの数は、その 1 時間にネットワークを介して通信したコンシューマとプロバイダーのインベントリ項目の個別のペアの数を表します。

このエンドポイントはポリシー識別子パラメータを入力として受け入れますが、ワークスペースの公開されたバージョンからのポリシーおよび L4 パラメータ ID を使用することをお勧めします。

（注）	アプリケーション ワークスペースの新しいバージョンが公開された後、その結果が利用可能になるまでに最大 6 時間かかることがあります。すべてのタイムスタンプの解決にも、6 時間の最小実行間隔があります。

アプリケーション ワークスペースの適用されたバージョン全体におけるポリシーの、ポリシー統計を取得する URL パスは次のとおりです。

POST /openapi/v1/policies/stats/enforced

アプリケーション ワークスペースの分析されたバージョン全体におけるポリシーの、ポリシー統計を取得する URL パスは次のとおりです。

POST /openapi/v1/policies/stats/analyzed

クエリ本文は、次のスキーマを使用した JSON 本文で構成されます。

ポリシー識別子フィールドは、次のスキーマを使用して構成されています。

サンプル python コード

  application_id = '5f88ca1e755f0222f85ce85c'
  consumer_id = '5f88ca1e755f0222f85ce85d'
  provider_id = '5f88ca1e755f0222f85ce85d'
  action = 'ALLOW'
  rank = 'DEFAULT'
  protocol = 6
  start_port = 80
  priority = 100

  req_body = f'''
  {{
      "application_id": "{application_id}",
      "t0":"2022-07-06T00:00:00Z",
      "t1":"2022-07-28T19:00:00Z",
      "policy_identifier": {{
          "consumer_consistent_uuid": "{consumer_id}",
          "provider_consistent_uuid": "{provider_id}",
          "rank": "{rank}",
          "priority": {priority},
          "action": "{action}",
          "protocol": "{protocol}",
          "start_port": "{start_port}"
      }}
  }}'''
  restclient.post('/policies/stats/analyzed', json_body=req_body)

  # For CATCH_ALL policies:
  root_app_scope_id = '6f88ca1e755f0222f85ce85e'
  rank = 'CATCH_ALL'
  action = 'DENY'
  req_body = f'''
  {{
      "application_id": "{application_id}",
      "t0":"2022-07-06T00:00:00Z",
      "t1":"2022-07-28T19:00:00Z",
      "policy_identifier": {{
          "consumer_consistent_uuid": "{root_app_scope_id}",
          "provider_consistent_uuid": "{root_app_scope_id}",
          "rank": "{rank}",
          "action": "{action}"
      }}
  }}'''

  restclient.post('/policies/stats/analyzed', json_body=req_body)

サンプル応答

この応答は、本文の JSON オブジェクトで、次のプロパティがあります。

    {
      "conversation_count": 72,
      "packet_count": 800,
      "byte_count": 1960,
      "first_seen_at": "2022-09-09T11:00:00.000Z",
      "last_seen_at": "2022-09-09T11:00:00.000Z",
      "agg_start_version": 4,
      "agg_start_time": "2022-08-10T23:00:00.000Z"
    }

このエンドポイントは、指定された時間間隔でカンバセーションが観察されなかった公開ワークスペース内のポリシー識別子を返します。

ポリシー識別子

すべてのポリシーと ADM で生成されたクラスタは、基になるフィルタクエリまたはポリシーのポートとプロトコルが変更されなくても、複数のアプリケーション ワークスペース バージョン間でその ID を変更できます。ワークスペースバージョン間で特定のポリシーのフローヒット数を追跡するため、バージョン間で変更されないフィルタには一貫した UUID を使用し、ポリシー識別子と呼ばれる複合キーを使用します。これには、プロバイダーとコンシューマの一貫した UUID に加え、ランク、アクション、優先順位、ポート、プロトコルが含まれます。

したがって、ポリシー識別子は、アプリケーション ワークスペースのバージョン間でポリシーの重要な側面を識別および説明できる複合キーとして機能しますが、ポリシー ID（通常の CRUD エンドポイントで使用されるものなど）はワークスペースのバージョン間で変更できます。

（注）	プロバイダー/コンシューマの一貫性のある UUID とポリシー識別子は、さまざまなアプリケーション ワークスペース バージョン間で共有されるため、フィルタまたはポリシーを一意に識別しません。

特定のクラスタまたはポリシーで CRUD 操作を実行するには、検索エンドポイントで識別子を特定のアプリケーション ワークスペース バージョンの具体的なポリシーに解決することを推奨します。

通常の CRUD 操作はポリシー ID を使用して実行できますが、ポリシー統計情報と識別子による破壊のみで、ポリシー識別子を入力として使用できます。これは主に、便宜上検索のための中間呼び出しを避けるためであり、代わりにワークスペース内の未使用のポリシーを直接検証して破壊します。

ポリシー ID とフィルタ ID を可能な限り使用し、ポリシー統計情報または識別子による破壊 API エンドポイント用に手動でポリシー識別子を生成しないことを強く推奨します。ただし、次の例は、ポリシーオブジェクトからポリシー識別子を生成する 1 つの方法を示しています。

    resp = restclient.get(f'/policies/631b0590497d4f09b537b973')
    policy = resp.json() # policy object
    policy_identifer = {
        'consumer_consistent_uuid': policy['consumer_filter']['consistent_uuid'],
        'provider_consistent_uuid': policy['provider_filter']['consistent_uuid'],
        'rank': policy['rank'],
        'action': policy['action'],
        'priority': policy['priority'],
        'protocol': policy['l4_params'][0]['proto'],
        'start_port': policy['l4_params'][0]['port'][0],
        'end_port': policy['l4_params'][0]['port'][1]
    }

（注）	アプリケーション ワークスペースの新しいバージョンが公開された後、その結果が利用可能になるまでに最大 6 時間かかることがあります。各タイムスタンプの解決にも、最小 6 時間を必要とします。

アプリケーション ワークスペースの適用されたバージョン間で未使用のポリシーを取得するための URL パスは次のとおりです。

POST /openapi/v1/unused_policies/{application_id}/enforced

アプリケーション ワークスペースの分析されたバージョン間で未使用のポリシーを取得するための URL パスは次のとおりです。

POST /openapi/v1/unused_policies/{application_id}/analyzed

クエリ本文は、次のスキーマを使用した JSON 本文で構成されます。

    application_id = '62e1915e755f026f2bcdd805'
    resp = restclient.post(f'/unused_policies/{application_id}/analyzed', json_body=f'''
    {{
        "t0":"2022-07-06T00:00:00Z",
        "t1":"2022-07-28T19:00:00Z"
    }}''')'

サンプル応答

この応答は、本文の JSON オブジェクトで、次のプロパティがあります。

結果の次のページを生成するには、offset の応答で受信したオブジェクトを取得し、それを次のクエリの offset の値として渡します。

    {
      "application_id": "63054a97497d4f2dc113a9c4",
      "policy_identifiers": [
        {
          "consumer_consistent_uuid": "62fff45c497d4f5064973c4d",
          "provider_consistent_uuid": "62fff45c497d4f5064973c4d",
          "version": "p1",
          "rank": "DEFAULT",
          "policy_action": "ALLOW",
          "priority": 10,
          "proto": 6,
          "start_port": 10000,
          "end_port": 10000,
          "agg_start_version": 1,
          "agg_start_time": "2022-08-10T23:00:00.000Z"
        },
        {
          "consumer_consistent_uuid": "62fff45c497d4f5064973c4d",
          "provider_consistent_uuid": "62fff45c497d4f5064973c4d",
          "version": "p1",
          "rank": "DEFAULT",
          "policy_action": "ALLOW",
          "priority": 10,
          "protocol": 6,
          "start_port": 10001,
          "end_port": 10001,
          "agg_start_version": 1,
          "agg_start_time": "2022-08-10T23:00:00.000Z"
        }
      ],
      "offset": "eyJvZmZzZXQiOjZ9"
    }

このエンドポイントは、特定のルート範囲のポリシーテンプレートのリストを返します。この API は、app_policy_management 機能を持つ API キーで使用できます。

GET /openapi/v1/application_templates?root_app_scope_id={root_app_scope_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定されたルート範囲のポリシー テンプレート オブジェクトのリストを返します。

サンプル python コード

  root_app_scope_id = '<root-app-scope-id>'
  restclient.get('/application_templates?root_app_scope_id=%s' % root_app_scope_id)

このエンドポイントは、ポリシーテンプレートのインスタンスを返します。

GET /openapi/v1/application_templates/{template_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID のポリシー テンプレート オブジェクトを返します。

サンプル python コード

  template_id = '<template-id>'
  restclient.get('/application_templates/%s' % template_id)

このエンドポイントは、新しいポリシーテンプレートを作成するために使用されます。

POST /openapi/v1/application_templates

JSON リクエストの本文には、次のキーが含まれています。

応答オブジェクト: 作成されたポリシーテンプレート オブジェクトを返します。

サンプル python コード

  root_app_scope_id = '<root-app-scope-id>'
  payload = {'root_app_scope_id': root_app_scope_id,
             'name': "policy_name",
             'default_policies': [
                {
                  'action': 'ALLOW',
                  'priority': 100,
                  'l4_params': [
                    {
                      'proto': 17,
                      'port': [80, 90]
                    }
                  ]
                }
              ]
            }
  restclient.post('/application_templates',
                  json_body=json.dumps(payload))

このエンドポイントは、ポリシーテンプレートを更新します。

PUT /openapi/v1/application_templates/{template_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON リクエストの本文には、次のキーが含まれています。

応答オブジェクト：指定された ID の変更されたポリシー テンプレート オブジェクトを返します。

サンプル python コード

  new_name = <new-name>
  payload = {'name': new_name}
  template_id = '<template-id>'
  restclient.post('/application_templates/%s' % template_id,
                  json_body=json.dumps(payload))

このエンドポイントは、指定されたポリシーテンプレートを削除します。

DELETE /openapi/v1/application_templates/{template_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  template_id = '<template-id>'
  restclient.delete('/application_templates/%s' % template_id)

このエンドポイントは、ポリシーテンプレートをダウンロードします。

GET /openapi/v1/application_templates/{template_id}/download

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID を持つ完全なポリシーテンプレート定義を返します。

サンプル python コード

  template_id = '<template-id>'
  restclient.get('/application_templates/%s/download' % template_id)

クラスタオブジェクトの属性については、以下で説明します。

このエンドポイントは、特定のワークスペース（「application」）のクラスタのリストを返します。この API は、app_policy_management 機能を持つ API キーで使用できます。

GET /openapi/v1/applications/{application_id}/clusters

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：この特定のワークスペースとバージョンの全クラスタの配列を返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  restclient.get('/applications/%s/clusters' % application_id)

このエンドポイントは、クラスタのインスタンスを返します。

PUT /openapi/v1/clusters/{cluster_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID に関連付けられたクラスタオブジェクトを返します。

サンプル python コード

  cluster_id = '5d02d021497d4f0949ba74e4'
  restclient.get('/clusters/%s' % cluster_id)

このエンドポイントは、新しいクラスタを作成するために使用されます。

POST /openapi/v1/applications/{application_id}/clusters

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON クエリの本文には、次のキーが含まれています。

ノード オブジェクトの属性：

（注）	クエリが提供済みでワークスペースが動的モードでない限り、ノードはクエリの作成に使用されます。

応答オブジェクト：新しく作成されたクラスタオブジェクトを返します。

サンプル python コード

  application_id = '5d02b493755f0237a3d6e078'
  payload = {
    'name': 'test_cluster',
    'version': 'v2',
    'description': 'basic granularity',
    'approved': False,
    'query': {
        'type': 'eq',
        'field': 'host_name',
        'value': 'centos6001'
    }
  }
  restclient.post('/applications/%s/clusters' % application_id)

このエンドポイントは、クラスタを更新します。

PUT /openapi/v1/clusters/{cluster_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON クエリの本文には、次のキーが含まれています。

応答オブジェクト：指定された ID に関連付けられている変更されたクラスタオブジェクトを返します。

サンプル python コード

  cluster_id = '5d02d2a4497d4f5194f104ef'
  payload = {
    'name': 'new_test_cluster',
  }
  restclient.put('/clusters/%s' % cluster_id, json_body=json.dumps(payload))

このエンドポイントは、指定されたクラスタを削除します。クラスタがポリシーによって使用されている場合、クラスタは削除されず、依存関係のリストが返されます。

DELETE /openapi/v1/clusters/{cluster_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  cluster_id = '5d02d2a4497d4f5194f104ef'
  restclient.delete('/clusters/%s' % cluster_id)

このエンドポイントを使用すると、特定のワークスペースに対する自動ポリシー検出の実行中の会話を検索できます。ダウンロードした会話の一部として表示させる、サポートされているディメンションとメトリックのサブセットを指定することもできます。必要に応じて、サポートされているディメンションとメトリックに関するフィルタを使用して、会話のサブセットに対するクエリを実行できます。

POST /openapi/v1/conversations/{application_id}

クエリは、次のキーを使用した JSON 本文で構成されます。

要求の本文は、JSON 形式のクエリである必要があります。次に、クエリ本文の例を示します。

    {
        "version": 1,
        "filter": {
            "type": "and",
            "filters":[
                {
                    "type": "eq",
                    "field": "excluded",
                    "value": False
                },
                {
                    "type": "eq",
                    "field": "protocol",
                    "value": "TCP"
                },
            ]
        },
        "dimensions": ["src_ip", "dst_ip", "port"],
        "metrics": ["byte_count", "packet_count"],
        "limit" : 2,
        "offset": <offset-object>
    }

   req_payload = {"version": 1,
                  "limit": 10,
                  "filter": {"type": "and",
                      "filters": [
                          {"type": "eq", "field": "excluded", "value": False},
                          {"type": "eq", "field": "protocol", "value": "TCP"}
                       ]
                  }
    }

    resp = restclient.post('/conversations/{application_id}', json_body=json.dumps(req_payload))
    print resp.status_code
    if resp.status_code == 200:
        parsed_resp = json.loads(resp.content)
        print json.dumps(parsed_resp, indent=4, sort_keys=True)

このエンドポイントを使用すると、メトリックに基づき、ディメンションでグループ化された、特定のワークスペースに対して実行された自動ポリシー検出の上位の会話を検索できます。現在サポートされているメトリックは こちら、ディメンションで現在サポートされているグループはこちらです。サポートされているディメンションとメトリックのフィルタを使用して、会話のサブセットをクエリできます。たとえば、バイトトラフィックの会話が最も多いソース IP アドレスを検索するには、src_ip ディメンションと byte_count メトリックを指定してクエリを使用します。

POST /openapi/v1/conversations/{application_id}/topn

クエリは、次のキーを使用した JSON 本文で構成されます。

要求の本文は、JSON 形式のクエリにする必要があります。次に、クエリ本文の例を示します。

    {
        "version": 1,
        "dimension": "src_ip",
        "metric": "byte_count",
        "filter": {
            "type": "and",
            "filters":[
                {
                    "type": "eq",
                    "field": "excluded",
                    "value": False
                },
                {
                    "type": "eq",
                    "field": "protocol",
                    "value": "TCP"
                },
            ]
        },
        "threshold" : 10
    }

  [ {"result": [
    {
      "byte_count": 1795195565,
      "src_ip": "192.168.1.6"
    },
    {
      "byte_count": 1781002379,
      "src_ip": "192.168.1.28"
    },
    ...
  ] } ]

    req_payload = {"version": 1, "dimension": "src_ip", "metric": "byte_count",
      "filter": {"type": "and",
        "filters": [
          {"type": "eq", "field": "excluded", "value": False},
          {"type": "eq", "field": "protocol", "value": "TCP"},
          {"type": "eq", "field": "consumer_filter_id", "value": "16b12a5614c5af5b68afa7ce"},
          {"type": "subnet", "field": "src_ip", "value": "192.168.1.0/24"}
        ]
      },
      "threshold" : 10
    }

    resp = restclient.post('/conversations/{application_id}/topn', json_body=json.dumps(req_payload))
    print resp.status_code
    if resp.status_code == 200:
        parsed_resp = json.loads(resp.content)
        print json.dumps(parsed_resp, indent=4, sort_keys=True)

除外フィルタオブジェクトの属性について、以下で説明します。

このエンドポイントは、特定のワークスペースの除外フィルタのリストを返します。この API は、app_policy_management 機能を持つ API キーで使用できます。

GET /openapi/v1/applications/{application_id}/exclusion_filters

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定されたワークスペースとバージョンの除外フィルタオブジェクトのリストを返します。

サンプル python コード

  application_id = '<application-id>'
  params = {'version': 'v10'}
  restclient.get('/applications/%s/exclusion_filters' % application_id,
                 params=params)

このエンドポイントは、除外フィルタのインスタンスを返します。

GET /openapi/v1/exclusion_filters/{exclusion_filter_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID を持つ除外フィルタオブジェクトを返します。

サンプル python コード

  exclusion_filter_id = '<exclusion-filter-id>'
  restclient.get('/exclusion_filters/%s' % exclusion_filter_id)

このエンドポイントは、除外フィルタを作成するために使用します。

POST /openapi/v1/applications/{application_id}/exclusion_filters

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON リクエストの本文には、次のキーが含まれています。

省略可能なパラメータが欠落している場合は、ワイルドカード（いずれにも一致）と見なされます。

応答オブジェクト：作成された除外フィルタオブジェクトを返します。

サンプル python コード

  provider_filter_id = '<provider-filter-id>'
  consumer_filter_id = '<consumer-filter-id>'
  payload = {'version': 'v0',
             'consumer_filter_id': consumer_filter_id,
             'provider_filter_id': provider_filter_id,
             'proto': 6,
             'start_port': 800,
             'end_port': 1000}
  application_id = '<application-id>'
  restclient.post('/applications/%s/exclusion_filters' % application_id,
                  json_body=json.dumps(payload))

このエンドポイントは除外フィルタを更新します。

PUT /openapi/v1/exclusion_filters/{exclusion_filter_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON リクエストの本文には、次のキーが含まれています。

応答オブジェクト：指定された ID を持つ変更された除外フィルタオブジェクトを返します。

サンプル python コード

  payload = {'proto': 17}
  exclusion_filter_id = '<exclusion-filter-id>'
  restclient.post('/exclusion_filters/%s' % exclusion_filter_id,
                  json_body=json.dumps(payload))

このエンドポイントは、指定された除外フィルタを削除します。

DELETE /openapi/v1/exclusion_filters/{exclusion_filter_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  exclusion_filter_id = '<exclusion-filter-id>'
  restclient.delete('/exclusion_filters/%s' % exclusion_filter_id)

除外フィルタオブジェクトの属性について、以下で説明します。

このエンドポイントは、デフォルトの除外フィルタのリストを返します。この API は、app_policy_management 機能を持つ API キーで使用できます。

GET /openapi/v1/default_exclusion_filters?root_app_scope_id={root_app_scope_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：ルート範囲の既定の除外フィルタオブジェクトのリストを返します。

サンプル python コード

 root_app_scope_id = '<root-app-scope-id>'
  restclient.get('/default_exclusion_filters?root_app_scope_id=%s' % root_app_scope_id)

このエンドポイントは、デフォルト除外フィルタのインスタンスを返します。

default_exclusion_filter_id = '<default-exclusion-filter-id>'

restclient.get('/default_exclusion_filters/%s' % default_exclusion_filter_id)

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：指定された ID を持つデフォルトの除外フィルタオブジェクトを返します。

サンプル python コード

  default_exclusion_filter_id = '<default-exclusion-filter-id>'
  restclient.get('/default_exclusion_filters/%s' % default_exclusion_filter_id)

このエンドポイントは、デフォルトの除外フィルタを作成するために使用します。

GET /openapi/v1/default_exclusion_filters?root_app_scope_id={root_app_scope_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON リクエストの本文には、次のキーが含まれています。

応答オブジェクト：作成されたデフォルトの除外フィルタオブジェクトを返します。

サンプル python コード

  provider_filter_id = '<provider-filter-id>'
  consumer_filter_id = '<consumer-filter-id>'
  payload = {'consumer_filter_id': consumer_filter_id,
             'provider_filter_id': provider_filter_id,
             'proto': 6,
             'start_port': 800,
             'end_port': 1000}
  root_app_scope_id = '<root-app-scope-id>'
  restclient.post('/default_exclusion_filters?root_app_scope_id=%s' % root_app_scope_id,
                  json_body=json.dumps(payload))

このエンドポイントは、デフォルトの除外フィルタを更新します。

PUT /openapi/v1/default_exclusion_filters/{default_exclusion_filter_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

JSON リクエストの本文には、次のキーが含まれています。

応答オブジェクト：指定された ID を持つ変更されたデフォルトの除外フィルタオブジェクトを返します。

サンプル python コード

  payload = {'proto': 17}
  default_exclusion_filter_id = '<default-exclusion-filter-id>'
  restclient.post('/default_exclusion_filters/%s' % default_exclusion_filter_id,
                  json_body=json.dumps(payload))

このエンドポイントは、指定されたデフォルトの除外フィルタを削除します。

DELETE /openapi/v1/default_exclusion_filters/{default_exclusion_filter_id}

パラメータ：要求 URL には、次のパラメータが含まれています。

応答オブジェクト：なし

サンプル python コード

  default_exclusion_filter_id = '<default-exclusion-filter-id>'
  restclient.delete('/default_exclusion_filters/%s' % default_exclusion_filter_id)

このエンドポイントは、ライブ分析を介して利用可能なフローをダウンロードするために、検索条件（またはフィルタ）を指定できる列を把握するために役立ちます。最も一般的なユースケースは、許可されたか、エスケープされたか、または拒否されたフローをダウンロードすることです。カテゴリサイズの検索条件をダウンロード API に渡すことでダウンロードが実現します。[type: eq] とともに使用する場合、フローのインバウンドカテゴリおよびアウトバウンドカテゴリが一致している必要があります。[type: contains] とともに使用する場合、フローのインバウンドカテゴリおよびアウトバウンドカテゴリが一致している必要があります。

GET /openapi/v1/live_analysis/dimensions

このエンドポイントは、ライブ分析に関連付けられたメトリック（バイト数、パケット数など）のリストを返します。このエンドポイントの 1 つの使用例は、ダウンロード API にメトリックのサブセットを含めることです。つまり、すべてのメトリックをダウンロードする代わりに、ユーザーは関心のあるメトリックの小さなサブセットを指定できます。

GET /openapi/v1/live_analysis/metrics

この API エンドポイントは、フィルタ条件に一致するフローのリストを返します。結果に含まれる各フローオブジェクトには、ライブ分析ディメンション（ライブ分析ディメンション API によって返される）とライブ分析メトリックス（ライブ分析メトリック API によって返される）の結合である属性があります。使用可能なディメンションとメトリックの完全なセットに関心がない場合ユーザーは、必要に応じて、ディメンションまたはメトリックの小さなサブセットを指定することもできます。ディメンションまたはメトリックのより小さなサブセットのこのプロジェクションは、API コールを高速化するという副作用も伴います。

POST /openapi/v1/live_analysis/{application_id}

JSON クエリの本文には、次のキーが含まれています。

要求の本文は、JSON 形式のクエリである必要があります。次に、クエリ本文の例を示します。

  
    {
        "t0": "2016-06-17T09:00:00-0700",
        "t1": "2016-06-17T17:00:00-0700",
        "filter": {
            "type": "and",
            "filters": [
                {
                    "type": "contains",
                    "field": "category",
                    "value": "escaped"
                },
                {
                    "type": "in",
                    "field": "dst_port",
                    "values": ["80", "443"]
                }
            ]
        },
        "limit": 100,
        "offset": <offset-object>
    }

   req_payload = {"t0": "2016-11-07T09:00:00-0700",
                  "t1": "2016-11-07T19:00:00-0700",
                  "limit": 10,
                  "filter": {"type": "and",
                      "filters": [
                          {"type": "contains", "field": "category", "value": "escaped"},
                          {"type": "regex", "field": "src_hostname", "value": "web*"}
                       ]
                  }
    }

    resp = restclient.post('/live_analysis/{application_id}', json_body=json.dumps(req_payload))
    print resp.status_code
    if resp.status_code == 200:
        parsed_resp = json.loads(resp.content)
        print json.dumps(parsed_resp, indent=4, sort_keys=True)

この API エンドポイントは、フィルタ条件に一致するフローのリストを返します。結果に含まれる各フローオブジェクトには、ライブ分析ディメンション（ライブ分析ディメンション API によって返される）とライブ分析メトリックス（ライブ分析メトリック API によって返される）の結合である属性があります。使用可能なディメンションとメトリックの完全なセットに関心がない場合ユーザーは、必要に応じて、ディメンションまたはメトリックの小さなサブセットを指定することもできます。ディメンションまたはメトリックのより小さなサブセットのこのプロジェクションは、API コールを高速化するという副作用も伴います。

POST /openapi/v1/live_enforcement_analysis/{application_id}

JSON クエリの本文には、次のキーが含まれています。

要求の本文は、JSON 形式のクエリである必要があります。次に、クエリ本文の例を示します。

  
    {
        "t0": "2016-06-17T09:00:00-0700",
        "t1": "2016-06-17T17:00:00-0700",
        "filter": {
            "type": "and",
            "filters": [
                {
                    "type": "contains",
                    "field": "category",
                    "value": "escaped"
                },
                {
                    "type": "in",
                    "field": "dst_port",
                    "values": ["80", "443"]
                }
            ]
        },
        "limit": 100,
        "offset": <offset-object>
    }

   req_payload = {"t0": "2016-11-07T09:00:00-0700",
                  "t1": "2016-11-07T19:00:00-0700",
                  "limit": 10,
                  "filter": {"type": "and",
                      "filters": [
                          {"type": "contains", "field": "category", "value": "escaped"},
                          {"type": "regex", "field": "src_hostname", "value": "web*"}
                       ]
                  }
    }

    resp = restclient.post('/live_enforcement_analysis/{application_id}', json_body=json.dumps(req_payload))
    print resp.status_code
    if resp.status_code == 200:
        parsed_resp = json.loads(resp.content)
        print json.dumps(parsed_resp, indent=4, sort_keys=True)

フィルタは、1 つ以上のプリミティブ フィルタで構成されるプリミティブ フィルタと論理フィルタ (「not」、「and」、「or」) をサポートします。プリミティブ フィルタの形式は次のとおりです。

    {"type" : "<OPERATOR>", "field": "<COLUMN_NAME>", "value": "<COLUMN_VALUE>"}

プリミティブフィルタの場合は、eq、ne、lt、lte、gt や gte などの比較演算子を使用できます。演算子は、in、regex、subnet、contains や range にすることもできます。

プリミティブ フィルタの一部の例としては、次のものがあります。

   {"type": "eq", "field": "src_address", "value": "7.7.7.7"}

   {"type": "regex", "field": "src_hostname", "value": "prod.*"}

   {"type": "subnet", "field": "src_addr", "value": "1.1.11.0/24"}

   # Note, 'in' clause uses 'values' key instead of 'value'
   {"type": "in", "field": "src_port", "values": [80, 443]}

not、and、or などのブール演算を使用して、複雑なフィルタを指定することもできます。以下は、これらのタイプのフィルタの一部の例です。

    # "and" and "or" operators need to specify list of "filters"
    {"type": "and",
        "filters": [
            {"type": "in", "field": "src_port", "values": [80, 443]},
            {"type": "regex", "field": "src_hostname", "value": "prod.*"}
        ]
    }

    # "not" operator needs to specify a "filter"
    {"type": "not",
        "filter": {"type": "subnet", "field": "src_addr", "value": "1.1.11.0/24"}
    }

フロー検索要求での filter のスキーマは、より正式に示すと次のようになります。