Send your first request using the API

Set up your development environment

• Network access to Server & Workload Protection.
• An SDK client library, if you choose to use one. Go to the Python SDK page to download the client library and learn how to add it to your development environment.
• The runtime environment for the programming language of your client library.

Tip To start exploring the API right away, instead of using a client library you can use an HTTP client such as Postman, Paw, or curl.

Authenticate with Server & Workload Protection

Create an API key

• For information on how to create an API key for legacy accounts, see Create and Manage API Keys.
• For information on how to create an API key for new Trend Micro Cloud One accounts, see Manage API keys.

Authenticate requests

Authenticate with a Trend Micro Cloud One API key

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

Authenticate with a legacy API key

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

Perform a GET request: list policies

Use an HTTP client

• URL: https://<Manager host name>:<port>/api/policies, for example https://localhost:4119/api/policies
• First header:
  • Key: api-secret-key (for legacy accounts) or Authorization (for new accounts)
  • Value: <your key secret> (for legacy accounts) or ApiKey <your key value> (for new accounts)
• Second header:
  • Key: api-version
  • Value: v1

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

Use a client library

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

Perform a POST request: search firewall rules

Use an HTTP client to post

• Request type: POST
• URL: https://<Server & Workload Protection hostname><port>/api/firewallrules/search, for example https://localhost:4119/api/firewallrules/search
• First header:
  • Key: api-secret-key (for legacy accounts) or Authorization (for new accounts)
  • Value: your key secret
• Second header:
  • Key: api-version
  • Value: v1
• Third header:
  • Key: Content-Type
  • Value: 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
  }]
}'

Use a client library to post

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

Get the Server & Workload Protection version

X-DSM-Version = Deep Security/12.0.81

Next Steps

• Run the code examples
• Notes about resource property values
• About the overrides parameter
• Search for resources