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.
Create and Update Policy APIs
POST rules and classifiers API
curl --insecure --location --request POST "https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/policy/rules"
Request input for the POST rules and classifiers API
The following parameters are shown in the request. For examples of requests, see Request example for the POST rules and classifiers API.
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
  - Create and Update Policy APIs
    - POST rules and classifiers API
      curl --insecure --location --request POST "https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/policy/rules"
      - Header parameter for the POST rules and classifiers API
      - Input parameter for the POST rules and classifiers API
        Input parameter for the POST rules and classifiers API is the output of the POST rules and classifiers API POST /dlp/rest/v1/policy/rules?policyName=<policyName>, see Response output for the POST rules and classifiers API.
      - Request input for the POST rules and classifiers API
        The following parameters are shown in the request. For examples of requests, see Request example for the POST rules and classifiers API.
        
        Object properties
        
        Rules object properties
        
        Classifier object properties
      - Request example for the POST rules and classifiers API
        This section shows an example of a request from this API. For more information about each parameter shown in the request, see Request input for the POST rules and classifiers API
      - Status and error codes for the POST rules and classifiers API
    - POST rule severity and action API
      curl --insecure --location --request POST "https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/policy/rules/severity-action"
    - POST rule source and destination API
      curl --insecure --location --request POST "https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/policy/rules/source-destination"
    - POST rule exceptions API
      curl --insecure --location --request POST "https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/policy/rules/exceptions"
- Deploy APIs
  Deploy APIs can be used to extract data and configure it to Policy Engine and Endpoint servers.
- Troubleshooting

Object properties

Field Name	Field Type	Mandatory Y/N	Description
level	Number	Y	policy level
data_type	String	Y	policy level data type

Copyright © 2023 Forcepoint LLC