Home
UCWI WebService API
Introduces the WebService API provided by UCWI devices and related information.
Overview
Introduces Unified Content Web-Service Inspector (UCWI).
Introduction to Content Receive Interface
Introduce the basic information of the content receive interface.

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.

Introduction to Content Receive Interface

Introduce the basic information of the content receive interface.

Request method

GET

URL

Interface Address

Call using the following URL interface address.

The URL definition rule is:

/skg/<API version number>/<Function Module>/<Resource Name>/<Resource Name...>

Request Parameters

Request Parameter Table

Parameter Name

Parameter Example

Description

<API version number>

NA

SkyGuard™The version number of the officially released RESTful API.

<Function Module>

dlp - Data Loss Prevention (DLP)Service
swg - Secure Web Gateway Service

The name of the functional module supported for calling in the current version.

<Resource Name>

channel - Channel
Note: If the functional module is dlp, the resource ID includes web, email, and webserviceapp.
report - Report
incident - Incident
forensics - Forensic Files

Sub-resources: Displayed in the URL as <Resource Name>/<Sub-resource Name>. Resources are arranged in order by level. All resource names can be obtained by listing the resource names.

The name of the resource supported for calling in the current version.

Return Result

After successfully calling this interface, the system will return a string in JSON format.