Cette API sert à lancer une tâche de classification structurée des données dans le cadre de la DLP (Prévention des pertes de données). Ce terme désigne des données sous forme de colonnes (telles que celles pouvant être exportées depuis une base de données SQL) qui sont transmises dans un format défini à des fins de classification. La requête renvoie un « job_id » qui sert à récupérer les résultats de la requête. Ces informations sont généralement destinées à un usage interne, mais elles sont consignées ici à titre de référence.
Ce point d'arrivée présente quelques limitations supplémentaires :
- Character Length of Each Profile name: 256 caractères
- Max File Size: 1 megabyte
- Max DLP Profiles: 100
Point final de la demande
POST
https://<appliance_ip>/inspections/structured-classification
Exemple d'appel
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'
Exemple de réponse
#202 Response
{
"job_id": "7e548ccf-c96e-4f5f-9f9e-4a468776972e"
}
Valid Query Parameters:
| Nom | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| "demande | body | object | true | Définit les propriétés d'une demande d'inspection de données structurées. |
| "" contenu | body | object | true | Décrit le contenu qui est envoyé dans le cadre de la demande. |
| »»» id | body | string | true | SHA256 hash of the content that has been sent. |
| Profils "" | body | true | Liste des profils à utiliser pendant l'analyse. Les profils déterminent les règles DLP (Prévention des pertes de données) utilisées lors de la recherche de correspondances. | |
| "Résultats | body | object | false | Définit les propriétés des résultats de classification structurée DLP (Prévention des pertes de données) à la demande fournis par l'inspection. |
| """ verdict | body | string | false | Précise le niveau de détail des correspondances à renvoyer. Un de : details - Inclut les détails du match. Détails sur les résultats du verdict, le profil et les règles par fichier. Si aucun verdict n'est spécifié, les détails seront renvoyés. |
| "" expéditeur | body | false | Décrit l'appelant de la demande. | |
| """ app_name | body | string | true | Application qui a déclenché l'appel |
| " contenu | body | chaîne de caractères (binaire) | true | none |
Enumerated Values
| Paramètres | Value |
|---|---|
| """ verdict | details |
Responses
| Statut | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Indique que la demande a été acceptée. C'est le résultat normal et attendu. | Inline |
| 400 | Requête incorrecte | La demande n'est pas valide. La réponse contient l'erreur qui a entraîné le rejet de la demande, si elle est disponible. | string |
| 413 | Charge utile trop importante | Le contenu spécifié est trop volumineux pour être numérisé. | Aucun |
| 500 | Erreur de serveur interne | Une erreur s'est produite lors de l'exécution de la demande. La réponse contient l'erreur qui a entraîné le rejet de la demande, si elle est disponible. | string |
| 503 | Service indisponible | Aucune ressource n'est disponible pour exécuter la demande. | Aucun |
Schéma de réponse
Code de statut 202
Cet objet est renvoyé à l'appareil DLP (Prévention des pertes de données) On Demand dans le cadre d'une demande d'inspection asynchrone, afin d'indiquer que l'appareil a accepté la demande et qu'il la traitera de manière asynchrone.
| Nom | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| "job_id | true | none | Un jeton spécifique à la demande. |
Cette opération ne nécessite pas d'authentification