This API is used to start a DLP structured data classification job. This refers to columnar data (such as data that may be exported from a SQL database) which is submitted in a specified format for classification purposes. The request returns a job_id that is used to get the results of the request. This is generally for internal usage, but documented here for reference purposes.
This endpoint has some additional limitations:
- Character Length of Each Profile name: 256 characters
- Max File Size: 1 megabyte
- Max DLP Profiles: 100
Request Endpoint
POST
https://<appliance_ip>/inspections/structured-classification
Call Example
curl -X 'POST' \
'http://localhost/inspections/structured-classification' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'request={"content":{"id":"b1f793e4d4a26ac7b695bb1fd1fb0ce3cb5d729c401d8528f8bb92598006cf85"},"profiles":["DLP-PCI","DLP-PII"],"results":{"verdict":"details"},"sender":{"app_name":"AWS_RDS"}}' \
-F 'content=@notes.txt;type=text/plain'
Response Example
#202 Response
{
"job_id": "7e548ccf-c96e-4f5f-9f9e-4a468776972e"
}
Valid Query Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| » request | body | object | true | Specifies the properties of a structured data inspection request. |
| »» content | body | object | true | Describes the content that is being sent as part of the request. |
| »»» id | body | string | true | SHA256 hash of the content that has been sent. |
| »» profiles | body | true | A list of profiles to use during the scan. Profiles determine which DLP rules are used when searching for matches. | |
| »» results | body | object | false | Specifies properties for the DLP on Demand structured classification results returned from the inspection. |
| »»» verdict | body | string | false | Specifies how much match detail should be returned. One of: details – Includes match details. Details about verdict has result matches, profile and rules per file. If no verdict is specified, details will be returned. |
| »» sender | body | false | Describes the request caller. | |
| »»» app_name | body | string | true | Application that triggered the call |
| » content | body | string(binary) | true | none |
Enumerated Values
| Parameter | Value |
|---|---|
| »»» verdict | details |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Indicates that the request has been accepted. This is the normal, expected result. | Inline |
| 400 | Bad Request | The request was invalid. The response contains the error that caused the request to be rejected, if available. | string |
| 413 | Payload Too Large | The specified content is too large to be scanned. | None |
| 500 | Internal Server Error | An error occurred while performing the request. The response contains the error that caused the request to be rejected, if available. | string |
| 503 | Service Unavailable | No resources are available to perform the request. | None |
Response Schema
Status Code 202
This object is returned to the DLP On Demand appliance for an asynchronous inspection request to indicate that appliance has accepted the request and will process it asynchronously.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » job_id | true | none | A request-specific token. |
This operation does not require authentication