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.
GET Deploy status 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
    - Header parameter for the GET Deploy status API
    - Input parameter for the GET Deploy status API
      There are no input parameters for the GET Deploy status API.
    - Request example for the GET Deploy status API
    - Response output for the GET Deploy status API
    - Success and error codes for the GET Deploy status API
  - POST Deploy API
- Troubleshooting

GET Deploy status API

GET https://<dlp host>:<dlp port>/dlp/rest/v1/deploy/status

The GET Deploy status API receives the current DLP deploy status.

Header parameter for the GET Deploy status API
Input parameter for the GET Deploy status API
There are no input parameters for the GET Deploy status API.
Request example for the GET Deploy status API
Response output for the GET Deploy status API
Success and error codes for the GET Deploy status API

Copyright © 2023 Forcepoint LLC