Senden Sie Ihre erste Anfrage über die API

Richten Sie Ihre Entwicklungsumgebung ein

• Netzwerkzugriff auf Server- und Workload Protection.
• Eine SDK-Clientbibliothek, falls Sie sich entscheiden, eine zu verwenden. Gehen Sie zur Python SDK-Seite, um die Clientbibliothek herunterzuladen und zu erfahren, wie Sie sie in Ihre Entwicklungsumgebung integrieren können.
• Die Laufzeitumgebung für die Programmiersprache Ihrer Client-Bibliothek.

Tipp Um sofort mit der Erkundung der API zu beginnen, können Sie anstelle einer Client-Bibliothek einen HTTP-Client wie Postman, Paw oder curl verwenden.

Authentifizieren mit Server- und Workload Protection

Erstellen eines API-Schlüssels

• Weitere Informationen zum Erstellen eines API-Schlüssels für Altkonten finden Sie unter API-Schlüssel erstellen und verwalten.
• Weitere Informationen zum Erstellen eines API-Schlüssels für neue Trend Micro Cloud One-Konten finden Sie unter API-Schlüssel verwalten.

Authentifizierungsanfragen

Authentifizieren Sie sich mit einem Trend Micro Cloud One API-Schlüssel

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

Mit einem veralteten API-Schlüssel authentifizieren

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

Führen Sie eine GET-Anfrage aus: Richtlinien auflisten

Verwenden Sie einen HTTP-Client

• URL: https://<Manager host name>:<port>/api/policies, zum Beispiel https://localhost:4119/api/policies
• Erste Überschrift:
  • Schlüssel: api-secret-key (für Altkonten) oder Authorization (für neue Konten)
  • Wert: <your key secret> (für Altkonten) oder ApiKey <your key value> (für neue Konten)
• Zweite Überschrift:
  • Schlüssel: api-version
  • Wert: v1

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

Verwenden Sie eine Clientbibliothek

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- und 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- und 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

Führen Sie eine POST-Anfrage aus: Firewall-Regeln suchen

Verwenden Sie einen HTTP-Client zum Posten

• Request type: POST
• URL: https://<Server- und Workload Protection hostname><port>/api/firewallrules/search, zum Beispiel https://localhost:4119/api/firewallrules/search
• Erste Überschrift:
  • Schlüssel: api-secret-key (für Altkonten) oder Authorization (für neue Konten)
  • Wert: Ihr geheimer Schlüssel
• Zweite Überschrift:
  • Schlüssel: api-version
  • Wert: v1
• Dritter Header:
  • Schlüssel: Content-Type
  • Wert: 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
  }]
}'

Verwenden Sie eine Client-Bibliothek zum Posten

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- und 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- und 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- und 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

Holen Sie sich die Server- und Workload Protection-Version

X-DSM-Version = Deep Security/12.0.81

Nächste Schritte

• Führen Sie die Codebeispiele aus
• Hinweise zu Ressourcen-Eigenschaftswerten
• Über den Parameter "Overrides"
• Nach Ressourcen suchen