使用 API 發送您的第一個請求

設置您的開發環境

• 網路存取Server & Workload Security保護。
• 如果您選擇使用 SDK 客戶端庫，請前往 Python SDK 頁面 下載客戶端庫並了解如何將其添加到您的開發環境中。
• 您客戶端程式庫的程式語言執行環境。

秘訣 要立即開始探索 API，您可以使用 HTTP 客戶端，例如 Postman、Paw 或 curl，而不是使用客戶端庫。

使用 Server & Workload Security保護 驗證

建立 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 主機名稱>:<port>/api/policies，例如 https://localhost:4119/api/policies
• 第一個標題：
  • 金鑰：api-secret-key（適用於舊帳戶）或 Authorization（適用於新帳戶）
  • 值：<您的密鑰秘密>（適用於舊帳戶）或 ApiKey <您的密鑰值>（適用於新帳戶）
• 第二標題：
  • Key: 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 Security保護

    :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 Security保護 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 Security保護 hostname><port>/api/firewallrules/search，例如 https://localhost:4119/api/firewallrules/search
• 第一個標題：
  • 金鑰：api-secret-key（適用於舊帳戶）或 Authorization（適用於新帳戶）
  • 值：您的密鑰秘密
• 第二標題：
  • Key: api-version
  • 值：v1
• 第三個標題：
  • Key: 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 Security保護 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 Security保護 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 Security保護 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 Security保護版本

X-DSM-Version = Deep Security/12.0.81

後續步驟

• 執行程式碼範例
• 關於資源屬性值的注意事項
• 關於覆蓋參數
• 搜尋資源