Forcepoint DLP REST API Guide

Home
REST APIs
This chapter provides detailed information about the specific REST APIs available in Forcepoint DLP.
Deploy APIs
Deploy APIs can be used to extract data and configure it to Policy Engine and Endpoint servers.
POST Deploy API

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.
- Deploy APIs
  Deploy APIs can be used to extract data and configure it to Policy Engine and Endpoint servers.
  - GET Deploy status API
  - POST Deploy API
    - Header parameter for the POST Deploy API
    - Input parameter for the POST Deploy API
      There are no input parameters for the POST Deploy API
    - Request example for the POST Deploy API
    - Output parameter for the POST Deploy API
      There are no output parameters for the POST Deploy API
    - Success and Error codes for the POST deploy API
- Troubleshooting

POST Deploy API

POST https://<dlp host>:<dlp port>/dlp/rest/v1/deploy

The POST Deploy API triggers the DLP deployment process.

Header parameter for the POST Deploy API
Input parameter for the POST Deploy API
There are no input parameters for the POST Deploy API
Request example for the POST Deploy API
Output parameter for the POST Deploy API
There are no output parameters for the POST Deploy API
Success and Error codes for the POST deploy API

Copyright © 2024 Forcepoint LLC