Forcepoint DLP REST API Guide

Home
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.
Get Incidents API
POST https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/incidents
Response output for the Get Incidents API
Endpoint confirmation 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.
  - Get Incidents API
    POST https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/incidents
    - Header parameters for the Get Incidents API
    - Input parameters for the Get Incidents API
      Input parameters for the get incidents API mentioned in the below table.
    - Request examples for the Get Incidents API
      This section shows examples of requests to the API. For more information about each parameter shown in the request, see Input parameters for the Get Incidents API.
    - Response output for the Get Incidents API
    - Response example for the Get Incidents API
    - Status and error codes for Get Incidents API
  - Update Incidents API
    POST https://<DLP Manager IP>:<DLP Manager port>/dlp/rest/v1/incidents/ update
- 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.
- Deploy APIs
  Deploy APIs can be used to extract data and configure it to Policy Engine and Endpoint servers.
- Troubleshooting

Endpoint confirmation object properties

Name	Supported	Comments
reason	INCIDENTS	Reason selected in confirmation dialog
justification	INCIDENTS	Justification entered by user in confirmation dialog

Copyright © 2024 Forcepoint LLC