Forcepoint DLP REST API Guide

Home
REST APIs
This chapter provides detailed information about the specific REST APIs available in Forcepoint DLP.
Policy Management APIs
Policy management APIs can be used to manage DLP and Discovery policies, rules and resources. These APIs support programmatic policy changes and support policy export/import use cases across the same versions of management servers.
Get Policy APIs
GET list of rule exceptions
GET /dlp/rest/v1/policy/rules/exceptions/all?type=<policy type>
Response output for GET list of rule exceptions
The following parameters are shown in the response. For examples of responses, see Response example for the GET list of rule exceptions.
Exception rule object properties

Introduction
Authentication
Before you can connect to the Forcepoint DLP REST APIs, you need to create a new Application administrator in the Forcepoint Security Manager to create the username and password for authentication to be used in order to get a JSON Web Token (JWT) that allows you to send API requests.
REST APIs
This chapter provides detailed information about the specific REST APIs available in Forcepoint DLP.
- Incident Management APIs
  Incident Management APIs can be used to get a list of DLP and Discovery incidents from Forcepoint DLP or update and remediate those incidents.
- Policy Management APIs
  Policy management APIs can be used to manage DLP and Discovery policies, rules and resources. These APIs support programmatic policy changes and support policy export/import use cases across the same versions of management servers.
  - Get Policy APIs
    - GET list of enabled policies API
      GET /dlp/rest/v1/policy/enabled-names?type=<policy type>
    - GET rules and classifiers API
      GET /dlp/rest/v1/policy/rules?policyName=<policyName>
    - GET rule severity and action API
      GET /dlp/rest/v1/policy/rules/severity-action?policyName=<policyName>
    - GET source and destination API
      GET /dlp/rest/v1/policy/rules/source-destination?policyName=<policyName>
    - GET list of rule exceptions
      GET /dlp/rest/v1/policy/rules/exceptions/all?type=<policy type>
      - Header parameter for the GET list of rule exceptions
      - Input parameter for the GET list of rule exceptions
        There are no input parameters for the GET list of rule exceptions.
      - Request example for the GET list of rule exceptions
      - Response output for GET list of rule exceptions
        The following parameters are shown in the response. For examples of responses, see Response example for the GET list of rule exceptions.
        
        Exception rule object properties
      - Response example for the GET list of rule exceptions
        This section shows an example of a response from this API. For more information about each parameter shown in the response, see Response output for the GET list of rule exceptions.
      - Status and error codes for the GET list of rule exceptions
    - GET rule exception details API
      GET /dlp/rest/v1/policy/rules/exceptions?type=<policy type>&ruleName=<rule name>&policyName=<policy name>
  - Create and Update Policy APIs
- Deploy APIs
  Deploy APIs can be used to extract data and configure it to Policy Engine and Endpoint servers.
- Troubleshooting

Exception rule object properties

Field Name	Field Type	Mandatory Y/N	Description
policy_name	String	Y	policy name
rule_name	String	Y	rule name
exception_rule_names	List of Strings	Y	List of the exception rule names

Copyright © 2023 Forcepoint LLC