Exporting logs using Export API
The Export API allows tenants to export logs for the supported products: SSE and Cloud DLP. This section explains how tenants can utilize the Insights API to export data.
Supported products
The Export API is available only for the following products:
- SSE - collections
Admin,DLP,CASBInline,CASBAPI,SWG,Health, andZTNA. - Cloud DLP - collections
DLPIncidentsandDLPIncidentsAll.
Logs for other products cannot be exported using the Export API.
Prerequisites
- Tenant must be registered on the platform and have access to the tenant portal.
- Tenant must have an API Key generated on the Platform UI.
Integrations
Steps to utilize the Export API in a custom Export Script:
- Generate an access token.
- Export data.
Generating an access token
To call the export API, generate an access token by sending a POST request to the platform API at /api/apikeys/token with the API key in the X-API-KEY
header.
curl --location --request POST 'https://portal.forcepointone.com/api/apikeys/token' \
--header 'X-API-KEY: ****API_KEY****'Export Data
api/export/{{PPCODE}}/{{COLLECTION}}.- PPCODE options:
SSEfor SSEDSfor Cloud DLP
- Collection options:
Admin,DLP,CASBInline,CASBAPI,SWG,Health,and ZTNAfor SSEDLPIncidents,DLPIncidentsAllfor Cloud DLP
DLPIncidentsAll - Contains a record for each Incident and each subsequent update to that Incident. For example, if a DLP Incident status is changed (a single status change),
DLPIncidentsAll will contain two records - one for the initial record and a second for the status change.
DLPIncidents - Contains a single consolidated record for each Incident. In this case, the record is updated with any subsequent update. Using the example above, querying the
record before the status change is made will show the initial status; querying again after the status change has been made will again show only one record, but the status value will now reflect
the latest.
DLPIncidentsAllis recommended for SIEM export use cases.DLPIncidentsis recommended for reporting purposes.
If updates are not being applied to Incidents, both collections will appear to behave the same.
For a description of each field, see DLP collection fields.
curl --location 'https://tenant-test.insights.forcepointone.com/api/export/SSE/Admin' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ****access_token****' \
--data '{
"fields": [],
"starttime": "2025-08-26 07:09:02",
"offset": 1,
"limit": 2000,
"filters": {
}
}'
fields - Specify the dimensions and measures you want to export. If left empty, all fields will be exported. For example: [{“name”:”eventTime”}].
starttime - A mandatory datetime indicating the start time for data export in UTC.
offset - offset for 24-hour window*.
limit - The total number of records to export, with a maximum of 2000 records per API request.
{“nxd”:{“eq”:[“ID-1”]}}, which returns all records where the nxd ID matches
ID-1.- Exported fields would contain property as sanitized “display name”, eg.
nxdwould be exported asrequestid. - Filters are supported on dimension and measure for string, numbers, enums, date, datetime, datatype. Filters do not support Array.
- Data is exported in 24 hours window (calculated based on starttime provided), and offset is valid only for this window. Pagination needs to build around this.
- Exported data are in ascending order i.e. oldest data first based on
eventinsertedtime. - Mapping sheet is available here.
- API documentation is available here.