APIを使用して最初のリクエストを送信する

開発環境の設定

• Server & Workload Protectionへのネットワークアクセス。
• SDKクライアントライブラリ (使用する場合)。に移動します。 Python SDKページクライアントライブラリをダウンロードし、開発環境に追加する方法について説明します。
• クライアントライブラリのプログラミング言語のランタイム環境。

ヒント すぐにAPIの探索を開始するには、クライアントライブラリを使用する代わりに、次のようなHTTPクライアントを使用します。郵便配達員,足、またはカール。

Server & Workload Protectionによる認証

APIキーの作成

• 従来のアカウントのAPIキーを作成する方法については、次を参照してください。 APIキーの作成と管理。
• 新しいTrend Micro Cloud OneアカウントのAPIキーを作成する方法については、次を参照してください。 APIキーの管理。

要求の認証

Trend Micro Cloud One APIキーを使用した認証

GET /api/policies HTTP/1.1
Host: localhost:4119
Authorization: ApiKey 1tBOlis4aGpMyygC26YKZMgU2fW:7864DcPqkWFHNngXHnn9VgWSuGtUoj52n3tTZSqkvucLDJ9jJJvbrBZMBJBigsS5wT
api-version: v1

従来のAPIキーを使用した認証

GET /api/policies HTTP/1.1
Host: localhost:4119
api-secret-key: 2:vJC6lckDygB6FYURIvR0WK2ZTAhIY8rb0Amy9UMn4mo=
api-version: v1

GETリクエストの実行: ポリシーの一覧表示

HTTPクライアントを使用する

• URL:https://<Manager host name>:<port>/api/policies 、 例えばhttps://localhost:4119/api/policies
• 最初のヘッダ:
  • キー:api-secret-key (従来のアカウントの場合) またはAuthorization(新規アカウントの場合)
  • 価値：<your key secret> (従来のアカウントの場合) またはApiKey <your key value> (新規アカウントの場合)
• 2番目のヘッダ:
  • キー: api-version
  • 値: v1

curl -X GET https:// localhost:4119/api/policies -H 'api-secret-key: 5:W+lC8YHIaYHeQuDbJZLkqwM5b8xjxla2pHtBNoiifF8=' -H 'api-version: v1'

クライアントライブラリを使用する

import deepsecurity as api
from deepsecurity.rest import ApiException as api_exception

def get_policies_list(api, configuration, api_version, api_exception):
    """ Gets a list of policies on Server & Workload Protection

    :return: A PoliciesApi object that contains a list of policies.
    """
    # Create a PoliciesApi object
    policies_api = api.PoliciesApi(api.ApiClient(configuration))

    # List policies using version v1 of the API
    policies_list = policies_api.list_policies(api_version)
    # View the list of policies
    return policies_list

if __name__ == '__main__':
    # Add Server & Workload Protection host information to the api client configuration
    configuration = api.Configuration()
    configuration.host = 'https:// 192.168.17.149:4119/api'

    # Authentication
    configuration.api_key['api-secret-key'] = '2:l069trAePqPRxZUfBqyw442z1DWm9s4u0F/g9bewnFE='

    # Version
    api_version = 'v1'

    print(get_policies_list(api, configuration, api_version, api_exception))

configuration.host = 'https://192.168.17.149:4119/api'
configuration.api_key['api-secret-key'] = '2:l069trAePqPRxZUfBqyw442z1DWm9s4u0F/g9bewnFE='

python first_steps_get_example.py

POST要求の実行: ファイアウォールルールの検索

HTTPクライアントを使用して送信する

• 要求の種類: POST
• URL: https://<Server & Workload Protection hostname><port>/api/firewallrules/search、 例えばhttps://localhost:4119/api/firewallrules/search
• 最初のヘッダ:
  • キー:api-secret-key (従来のアカウントの場合) またはAuthorization(新規アカウントの場合)
  • 値: キーの秘密
• 2番目のヘッダ:
  • キー: api-version
  • 値: v1
• 3番目のヘッダ:
  • キー: Content-Type
  • 値: application/json

{
  "searchCriteria": [{
    "idTest":"equal",
    "idValue":3
  }]
}

curl -X POST https:// localhost:4119/api/firewallrules/search \
-H 'Cache-Control: no-cache' \
-H 'api-secret-key: 3:zNi5ag8xPGpfEMElV0GxAIpTs5Ji8BQoCtXaTAgKkVM=' \
-H 'api-version: v1' \
-H 'content-type: application/json' \
-d '{
  "searchCriteria": [{
    "idTest":"equal",
    "idValue":3
  }]
}'

クライアントライブラリを使用して送信する

import deepsecurity as api
from deepsecurity.rest import ApiException as api_exception

def search_firewall_rules(api, configuration, api_version, api_exception):
    """ Searches the firewall rules for any rule that contains DHCP in the rule name.

    :param api: The Server & Workload Protection API modules.
    :param configuration: Configuration object to pass to the api client.
    :param api_version: The version of the API to use.
    :param api_exception: The Server & Workload Protection API exception module.
    :return: A list containing all firewall rules that match the search criteria.

    """

    # Define the search criteria
    search_criteria = api.SearchCriteria()
    search_criteria.field_name = "name"
    search_criteria.string_value = "%DHCP%"
    search_criteria.string_test = "equal"
    search_criteria.string_wildcards = True

    # Create search filter to find the rule
    search_filter = api.SearchFilter(None,[search_criteria])

    # Create a FirewallRulesApi object
    firewall_rules_api = api.FirewallRulesApi(api.ApiClient(configuration))

    # Perform the search
    firewall_rules = firewall_rules_api.search_firewall_rules(api_version, search_filter=search_filter)
    firewall_rules_list = []
    for rule in firewall_rules.firewall_rules:
        firewall_rules_list.append(rule)

    return firewall_rules

if __name__ == '__main__':
    # Add Server & Workload Protection host information to the api client configuration
    configuration = api.Configuration()
    configuration.host = 'https://192.168.17.149:4119/api'

    # Authentication
    configuration.api_key['api-secret-key'] = '2:l069trAePqPRxZUfBqyw442z1DWm9s4u0F/g9bewnFE='

    # Version
    api_version = 'v1'
    print(search_firewall_rules(api, configuration, api_version, api_exception))

configuration.host = 'https://192.168.17.149:4119/api'</code></li>
configuration.api_key['api-secret-key'] = '2:l069trAePqPRxZUfBqyw442z1DWm9s4u0F/g9bewnFE='

python first_steps_post_example.py

Server & Workload Protection バージョンの取得

X-DSM-Version = Deep Security/12.0.81

次のステップ

• コード例を実行する
• リソースのプロパティ値に関する注意事項
• overridesパラメータについて
• リソースの検索