Symantec™ Data Loss Prevention Detection REST API 2.0 Reference Guide 15.8 Last updated: April 13, 2021 Table of Contents Introducing the Symantec Data Loss Prevention Detection REST API 2.0....................................4 About the Symantec Data Loss Prevention Detection REST API...............................................................................4 About the Detection REST API 2.0 Guide..................................................................................................................... 4 Overview of the Symantec Data Loss Prevention Detection REST API 2.0...............................................................4 Symantec DLP Detection REST API 2.0 Reference..........................................................................6 Detection requests........................................................................................................................................................... 6 URL..............................................................................................................................................................................6 HTTP method.............................................................................................................................................................. 6 HTTP request headers................................................................................................................................................6 HTTP body.................................................................................................................................................................. 6 Detection request format and definitions....................................................................................................................6 Context entries..................................................................................................................................................... 7 Content blocks................................................................................................................................................... 12 Sample request......................................................................................................................................................... 13 Input validation............................................................................................................................................................... 14 Detection results............................................................................................................................................................ 15 HTTP response headers...........................................................................................................................................15 HTTP response codes.............................................................................................................................................. 15 Detection result format and definitions..................................................................................................................... 16 Policy.................................................................................................................................................................. 16 Response action................................................................................................................................................ 16 Response action parameters.............................................................................................................................18 Warning......................................................................................................................................................................18 Error messages......................................................................................................................................................... 19 Sample response...................................................................................................................................................... 19 Action acknowledgement requests..............................................................................................................................20 URL............................................................................................................................................................................20 HTTP Method............................................................................................................................................................ 20 HTTP body................................................................................................................................................................ 20 Action acknowledgement request format and descriptions...................................................................................... 20 Actions taken......................................................................................................................................................21 Sample action acknowledgment request.................................................................................................................. 21 Supported File Types.........................................................................................................................23 Word processing file types supported for REST API 2.0 detection......................................................................... 24 Multimedia file types supported for REST API 2.0 detection....................................................................................25 Spreadsheet file types supported for REST API 2.0 detection................................................................................. 25 2 Presentation file types supported for REST API 2.0 detection.................................................................................25 Image file types supported for REST API 2.0 detection............................................................................................ 26 Encapsulation file types supported for REST API 2.0 detection.............................................................................. 27 Encryption file types supported for REST API 2.0 detection....................................................................................27 Other file types supported for REST API 2.0 detection.............................................................................................28 Copyright statement.......................................................................................................................... 29 3 Introducing the Symantec Data Loss Prevention Detection REST API 2.0 About the Symantec Data Loss Prevention Detection REST API The Symantec Data Loss Prevention Detection REST API enables you to develop REST clients that can connect to, and inspect the content of, specific applications that you identify for security monitoring through the Symantec Data Loss Prevention Cloud Detection Service or Symantec Data Loss Prevention API Detection for Developer Apps virtual appliance. Your REST API client sends sensitive data to Symantec Data Loss Prevention for inspection by way of the Cloud Detection Service or the API Detection for Developer Apps virtual appliance. Symantec Data Loss Prevention inspects the data and creates incidents where applicable. Symantec Data Loss Prevention also returns response action recommendations in the REST detection request response. The Symantec Data Loss Prevention API Detection for Developer Apps virtual appliance provides detection capabilities deployed on-premises that enables you to monitor content and identify information policy violations in applications using a custom REST client. NOTE Hereafter in this guide, the "API Detection for Developer Apps virtual appliance" will be referred to as the "REST API Appliance." The Symantec Data Loss Prevention Cloud Detection Service is a Symantec Data Loss Prevention detection service deployed in the cloud that enables you to monitor content and identify information policy violations in cloud applications. The Cloud Detection Service can inspect both network traffic ("data in motion," or DIM) and data stored in a repository ("data at rest," or DAR). You can specify which type of data you are posting for inspection using the common.dataType context entry in your detection request. About the Detection REST API 2.0 Guide This guide is a reference document intended for software developers creating REST clients for in-house or third-party cloud applications for use with Symantec Data Loss Prevention. It does not assume deep knowledge of Symantec Data Loss Prevention, though familiarity with the concepts of Symantec Data Loss Prevention may be helpful. Consult with your Symantec Data Loss Prevention administrator to learn more about Symantec Data Loss Prevention and how it processes the data you post. The latest version of this guide is available at the Related Documents section of 15.8 Help. Overview of the Symantec Data Loss Prevention Detection REST API 2.0 The following table describes some general features of the REST API 2.0. Table 1: General features of the Symantec Data Loss Prevention Detection REST API 2.0 Feature Description Version You specify the API version using the path prefix in the base URL. The base URL path for this version is /v2.0/. HTTP methods Version 2.0 supports the POST method only. 4 Feature Description