Home
UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
Overview
Introduces Unified Content Web-Service Inspector (UCWI).
API List
Lists the WebService APIs provided by UCWI.

UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
- Overview
  Introduces Unified Content Web-Service Inspector (UCWI).
  - Typical Deployment - Big Data Platform
    Introduces information about the deployment of big data platforms.
  - Technical Feature List
    Lists the technical features of the product.
  - Typical Use Cases
    Introduces typical use cases for WebService API.
  - API List
    Lists the WebService APIs provided by UCWI.
  - Introduction to Content Receive Interface
    Introduce the basic information of the content receive interface.
  - Introduction to Content Inspection Interface
    Introduces the basic information of the content inspection interface.
  - Introduction to Return Values of the Content Inspection Interface
    Introduces the return values of the content inspection interface. If a policy is matched, the system will return the matched policy information.
  - Data Masking Policy
    Introduces information related to creating and managing data masking policies.
- Configure WebService API
  Introduces how to quickly configure the WebService API.
- Authentication
  Introduces the steps to obtain authentication information.
- GET-Get Channel List
  Introduces the interface call method for the Get Channel List interface.
- GET-Get Channel Details
  Introduces the interface call method for the Get Channel Details interface.
- GET-Get Incident List
  Introduces the invocation method of the Get Incident List interface.
- GET-Get Incident Details
  Introduces the interface call method for the Get Incident Details interface.
- GET-Get Policy Hit Statistics Report
  Introduces the interface call method for the Get Policy Hit Statistics Report.
- GET - Get Label
  Introduces the invocation method of the Get Label interface.
- POST -Add Label
  Introduces the invocation method of the Labeling interface.
- DELETE - Delete Label
  Introduces the interface invocation method of the Delete Label interface.
- POST-Content Review-Web Channel
  Introduces how to call the interface to perform security reviews on content in the Web channel.
- POST-Content Review-Email Channel
  Introduces how to call the interface to perform security reviews on content in the email channel.
- POST-Content Review-WebService Application Channel
  Introduces how to call the interface to perform security reviews of content in the WebService application channel.
- Data Masking Processing
  Introduces how to call the content review interface for data masking processing.
- POST-Virus Scan
  Introduces how to call the interface to perform virus scanning on text content.
- Upload Logs
  Introduction to the upload logs interface.
- Third-Party Log Management Platform Integration
  Introduces information about integrating with third-party log management platforms.
- Appendix
  This chapter introduces some relevant information that needs to be known when calling the WebService API.

API List

Lists the WebService APIs provided by UCWI.

The interfaces provided by Unified Content Web-Service Inspector (UCWI) are divided into two categories: resource acquisition interfaces and content review interfaces.

Content Receiving Interfaces

Interface Name	Description
GET-Get Channel List `/skg/v1/dlp/channel`	This interface is used to obtain all channel types. After obtaining the list of channel types, you can query the detailed information of a specific channel type through the interface for obtaining channel details.
GET-Get Channel Details `/skg/v1/dlp/channel/<Channel Type>`	This interface is used to obtain the detailed information of a specific channel type.
GET-Get Incident List `/skg/v1/dlp/incident?<Incident Attribute>`	This interface is used to obtain a list of all security violation incidents. After obtaining the incident list, you can query the detailed information of a specific incident through the interface for obtaining incident details.
GET-Get Incident Details `/skg/v1/dlp/incident/<Incident ID>`	This interface is used to obtain the detailed information of a specific incident.
GET-Get Policy Hit Statistics Report `/skg/v1/dlp/report?type=<Report Type>&top=<Top N>`	Send a request to obtain a security report.

Content Review Interfaces

Interface Name	Description
POST-Content Review-Web Channel `/skg/v1/dlp/channel/web/<Protocol Type>/<Request Mode>`	Review the content in the Web channel. This interface supports synchronous mode review of local files. This interface supports asynchronous mode review of content stored in clouds such as Amazon S3, Swift, Alibaba Cloud OSS, and Tencent Cloud COS.
POST-Content Review-Email Channel `/skg/v1/dlp/channel/email/<Protocol Type>/<Request Mode>`	Review the content in the email channel. This interface supports synchronous mode review of local files. This interface supports asynchronous mode review of content stored in clouds such as Amazon S3, Swift, Alibaba Cloud OSS, and Tencent Cloud COS.
POST-Content Review-WebService Application Channel `/skg/v1/dlp/channel/webserviceapp/<WebService App ID>/<Request Mode>`	Review the content in the WebService application channel. This interface supports synchronous mode review of local files. For text content review. Compared to local file review, this text-content mode reduces file-related request parameters, such as md5 value, whether to perform virus scanning, etc. This interface supports asynchronous mode review of content stored in clouds such as Amazon S3, Swift, Alibaba Cloud OSS, and Tencent Cloud COS. This interface supports batch review of S3, OSS, COS cloud storage content in asynchronous mode.
POST-Virus Scan `/skg/v1/swg/antivirus/<Mode>`	Perform virus scanning on text content. This interface supports virus checking of local files in synchronous mode. This interface supports virus checking of content stored in clouds such as Amazon S3, Swift, Alibaba Cloud OSS, and Tencent Cloud COS in asynchronous mode.