Retrieve Reports
Table of Contents
Expand all | Collapse all
Retrieve Reports
Get reports from Cortex Data Lake with DLP APIs
Synopsis
URI | /v1/public/report/{reportId} |
HTTP Method | GET |
Description
A GET request to this endpoint
retrieves the DLP report stored in Cortex Data Lake.Set Up Enterprise Data Loss Prevention provides
more information.
Header Parameters
The parameters you can
include in the headers.
Field | Description |
|---|---|
Authorization | ( Required ) Access token from the DLP
app. |
Query Parameters
The parameters you can
include in the endpoint query.
Field | Description |
|---|---|
fetchSnippets | ( Optional ) Boolean field when set to
true, retrieves snippets from the DLP report. |
Request Example
Request report given report
ID:
curl -L -X GET 'https://api.dlp.paloaltonetworks.com/v1/public/report/48333252?fetchSnippets=true ^ -H 'Authorization: Bearer {TOKEN}' ^ -H 'Content-Type: application/json' ^ -d '{ }'
Success Response
Upon success,
the HTTP response code is 200. In addition, this API returns a JSON
object containing the query status, as well as an array of JSON
objects, each of which represents a single incident.
Field | Description |
|---|---|
txn_id, report_id | ID of the retrieved report. |
file_name | Name of the scanned file. |
data_profile_name | Profile of the detection rules. |
data_pattern_rule | Matched pattern rules that the compiled report
contains. |
scanContentRawReport | List of report data. |
tenant_id | DLP tenant ID. |
Success Response Example
{ "txn_id": "483332512", "report_id": "483332512", "data_profile_id": "11995014", "data_profile_name": "Sensitive Content", "type": "basic", "tenant_id": "7830962012064884736", "fileSha": "90d068df2381ebd8342c99cf59907e7c9fc7ab3d7c4c6fdc2a3d814eb7ed374f", "file_name": "google_finance_template_1mb.txt", "file_type": "txt", "file_size_in_bytes": 1005626, "extracted_file_size_in_bytes": 1005635, "detection_time": "10/15/2020 21:16:24 UTC", "data_pattern_rule_1_verdict": "MATCHED", "data_pattern_rule_2_verdict": null, "scanContentRawReport": { "data_pattern_rule_1_results": [ { "data_pattern_id": "5ee3c51c99025d000161ab9a", "version": 1, "name": "Bank - American Bankers Association Routing Number - ABA", "technique": "regex", "type": "predefined", "strict_detection_frequency": 0, "proximity_detection_frequency": 0, "detection_frequency": 0, "unique_strict_detection_frequency": 0, "unique_checksum_detection_frequency": 0, "unique_proximity_detection_frequency": 0, "unique_detection_frequency": 0, "weighted_frequency": 0, "score": 0.0, "high_confidence_frequency": 0, "medium_confidence_frequency": 0, "low_confidence_frequency": 0, "unique_high_confidence_frequency": 0, "unique_medium_confidence_frequency": 0, "unique_low_confidence_frequency": 0, "state": "EVALUATED" }, { "data_pattern_id": "5ee3c51c99025d000161aba6", "version": 1, "name": "Voyager Credit Card", "technique": "regex", "type": "predefined", "strict_detection_frequency": 0, "proximity_detection_frequency": 0, "detection_frequency": 0, "unique_strict_detection_frequency": 0, "unique_checksum_detection_frequency": 0, "unique_proximity_detection_frequency": 0, "unique_detection_frequency": 0, "weighted_frequency": 0, "score": 0.0, "high_confidence_frequency": 0, "medium_confidence_frequency": 0, "low_confidence_frequency": 0, "unique_high_confidence_frequency": 0, "unique_medium_confidence_frequency": 0, "unique_low_confidence_frequency": 0, "state": "EVALUATED" }, { "data_pattern_id": "5ee3c51d99025d000161ac52", "version": 1, "name": "NationalId - US Social Security Number - SSN", "technique": "regex", "type": "predefined", "strict_detection_frequency": 0, "proximity_detection_frequency": 3, "detection_frequency": 3, "unique_strict_detection_frequency": 0, "unique_checksum_detection_frequency": 0, "unique_proximity_detection_frequency": 3, "unique_detection_frequency": 3, "weighted_frequency": 0, "score": 0.0, "high_confidence_frequency": 3, "medium_confidence_frequency": 0, "low_confidence_frequency": 3, "unique_high_confidence_frequency": 3, "unique_medium_confidence_frequency": 0, "unique_low_confidence_frequency": 3, "matched_confidence_level": "high", "state": "EVALUATED" } ], "data_pattern_rule_2_results": null }, "message": null, "time": null, "scan_request_received_time": null, "file_download_start_time": null, "file_download_finish_time": null, "extraction_start_time": null, "extraction_finish_time": null, "get_profile_patterns_start_time": null, "get_profile_patterns_finish_time": null, "scanning_start_time": null, "scanning_finish_time": null, "generate_verdict_start_time": null, "generate_verdict_finish_time": null, "scan_request_finished_time": null }
Error Response
Upon error,
the reply includes an HTTP response code, an error message, and
additional information describing the error. The HTTP response code
is one of the following:
Field | Description |
|---|---|
400 | Bad Request. Got an invalid JSON. |
401 | Unauthorized access. An issue occurred during authentication.
This can indicate an incorrect key, ID, or other invalid authentication
parameters. |
402 | Unauthorized access. You do not have the required license
type to run this API. |
403 | Forbidden access. The provided API Key does
not have the required permissions to run this API. |
500 | Internal server error. A unified status for
API communication type errors. |
Error Response Format
{"timestamp":"2020-11-02T19:49:24.475+0000","status":403,"error":"Forbidden","message":"Access Denied","path":"/v1/public/report/48333252"}