Introduction to Content Inspection Interface

Introduces the basic information of the content inspection interface.

Overview

The Content Inspection interface is used to detect whether the content of files uploaded or sent by users violates the Data Loss Prevention (DLP) policies and data masking policies of an enterprise or organization, and to execute actions such as allowing or blocking data transmission.

Third-party applications generate a queryID and pass it as a metadata parameter to Unified Content Web-Service Inspector (UCWI), which is used to query the incident details associated with this request.
Note: The value of queryID is the traffic ID in the third-party cloud service.

If the request does not trigger an incident, querying through this queryID will return a 404. The generation of incidents is asynchronous, and the time to store incidents in the database may vary slightly depending on the traffic size. Third-party applications should wait for a period of time after sending the request before querying the incident details.

Interface Introduction

This interface is used to send information to Unified Content Web-Service Inspector (UCWI) for content inspection.

Request method

POST
URL

Interface URL

/skg/<API Version>/<Function Module>/<Resource Name>/<Resource Name...>/<Request Mode>

Request Parameters

Request parameter table
Parameter Name Parameter Example Description
<API Version> NA The RESTful API version number officially released by SkyGuard™.
<Function Module>
  • dlp - Data Loss Prevention (DLP) service
  • swg - Web data security service
The name of the function module supported by the current version for invocation.
<Resource Name>
  • channel - Channel
    Note: For example, if the function module is dlp, the resource ID includes web, email, and webserviceapp.
  • protocol - Protocol
The resource name supported by the current version for invocation.
<Request Mode>
  • sync - Synchronous, UCWI returns after completing the scan
  • async - Asynchronous, returns immediately, all results are allowed
The request mode for invoking content inspection requests.

Data Loss Prevention

The content inspection interface is mainly used to detect whether the content uploaded or sent by users contains sensitive information that violates the Data Loss Prevention (DLP) policies of an enterprise or organization, and to execute actions such as allowing or blocking data transmission for this information.

For more information about data leakage prevention, please refer to the following sections: