Ce point d’accès API est utilisé pour effectuer de manière synchrone une Prévention des pertes de données (Inspection du contenu DLP (Prévention des pertes de données) et récupérer les résultats. Si l’inspection de contenu dépasse le délai maximal de 10 secondes, un HTTP 200 est retourné avec le champ d’état défini sur « timeout ». Cet appel ne prend en charge que les types de verdicts suivants : summary et details.
Ce point d'arrivée présente quelques limitations supplémentaires :
- Max File Size: 1 megabyte
- Timeout: 10 seconds
- Max DLP Profiles: 100
- Character Length of Each Profile name: 256 caractères
Point final de la demande
POST
https://<appliance_ip>/inspections
Exemple d'appel
curl -X 'POST' \
'https://10.0.0.1/inspections' \
-H 'accept: multipart/mixed' \
-H 'Content-Type: multipart/form-data' \
-H 'x-netskope-generate-incidents: true' \
-F 'request={"profiles":["DLP-PCI","DLP-PII"],"content":{"id":"b1f793e4d4a26ac7b695bb1fd1fb0ce3cb5d729c401d8528f8bb92598006cf85","name":"SecretFile.txt","object_id":"AA-74GXZ","true_file_type":230},"modules":{"file_filter":{"skip":true},"drm":{"labels":[{"id":"c7d03ebd-804d-489c-94c6-8167224c3c1b","name":"chris_encryption_all_enabled","instance":"epdlpsjc1","vendor":"mip"}]}},"results":{"verdict":"summary"},"sender":{"app_name":"AWS_RDS"}}' \
-F 'content=@dlp.txt;type=text/plain'
Exemple de réponse
#200 Example Indicates a successful response, and the results are provided in multiple multipart/mixed parts.
L'en-tête de demande x-netskope-generate-incidents est ajouté afin que les utilisateurs puissent spécifier leur choix pour la génération d'alertes & incidents.
Les en-têtes de réponse ont également été créés : x-netskope-incidents-posted. L'en-tête de réponse indique si les alertes et les incidents ont été enregistrés dans le plan de gestion.
Valid Query Parameters:
Paramètres
| Nom | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | none |
| "demande | body | object | true | Spécifie les propriétés d'une demande d'inspection synchrone. |
| 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. | |
| "" contenu | body | true | Décrit le contenu qui est envoyé à DLP (Prévention des pertes de données) dans le cadre de la demande. | |
| »»» id | body | string | true | SHA256 hash of the content that has been sent. |
| »»» name | body | string | false | The name (e.g. filename) of the data. |
| """ object_id | body | string | false | Un identifiant d'objet pour les données. |
| """ true_file_type | body | integer | false | Type de fichier réel de Netskope (identifiant numérique) |
| »» modules | body | false | Spécifie les paramètres des modules DLP (Prévention des pertes de données) individuels qui seront utilisés pendant l'inspection. | |
| """ file_filter | body | object | false | Spécifie les paramètres du module Filtre de fichiers. |
| """" sauter | body | boolean | false | Si vrai, le filtrage des fichiers sera ignoré. |
| »»» drm | body | object | false | Permet aux étiquettes DRM explicites d'être transmises au DLP (Prévention des pertes de données). |
| »»»» labels | body | [objet] | true | none |
| »»»»» id | body | string | true | L'identifiant de l'étiquette. |
| »»»»» name | body | string | false | Le nom de l'étiquette. |
| """"" instance | body | string | false | L'instance de l'étiquette. |
| »»»»» vendor | body | string | true | Le vendeur de l'étiquette. |
| "Résultats | body | object | false | Spécifie les propriétés des résultats DLP (Prévention des pertes de données) On Demand renvoyés par l'inspection. |
| """ verdict | body | string | false | Specifies how much match detail should be returned. One of the following will be returned: summary – Summary of the verdict is returned. This will include the outcome, verdict type, list of the profiles, severity. details – Includes match details. Details about verdict has result matches, profile and rules per file. forensics – Includes summary, details and forensics of the matches. All match details including rule information, matched text and extracted content will be returned. Please note that this will cause a full scan of the file. If no verdict is specified, it would default to summary type and the summary of the verdict will be returned. |
| "" 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 | summary |
| details |
Responses
| Statut | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Indique une réponse réussie ; les résultats sont fournis dans plusieurs parties de type « multipart/mixed ». | 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 200
| Nom | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| "result_data | false | none | Contient le résultat global de l'inspection. Il s'agit notamment de l'état d'avancement de l'inspection et des correspondances produites à la suite de l'inspection. | |
| "Statut | true | none | Indique l'état d'une demande de balayage. success - Le contenu a été inspecté avec succès. timeout - L'inspection du contenu a pris trop de temps et a été interrompue. error - Une erreur s'est produite lors de l'inspection du contenu. | |
| "" status_info | string | false | none | Additional information about the status. For example, if status is error, this field may be present to provide details about the error that occurred. |
| "" résumé | false | none | none | |
| """ verdict | string | true | none | Le verdict. L'un d'entre eux : hit no_hit |
| """ verdict_type | string | true | none | The verdict type. One of: full partial |
| """ sévérité | string | false | none | La sévérité de la règle. L'un d'entre eux : none low medium high critical |
| "Profils | true | none | 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. | |
| »»» transaction_id | string | true | none | L'identifiant de la transaction pour cette correspondance. |
| "Résultats | [objet] | false | none | Lorsqu'un balayage se termine avec succès(le statut est " success"), ce champ peut être présent. Il contient un tableau d'entrées - une pour chaque fichier/sous-fichier du contenu qui a été analysé. Seuls les fichiers/sous-fichiers pour lesquels des règles ont été définies ou qui n'ont pas pu être analysés parce qu'ils étaient protégés s'affichent ici. Les fichiers qui ont été numérisés mais qui ne remplissent pas l'une de ces deux conditions n'apparaissent pas ici. |
| """ bypassed_profiles | [string] | false | none | Spécifie la liste des profils de la requête qui ont été ignorés parce que le fichier analysé était protégé d'une manière ou d'une autre. Si ce champ n'est pas présent, aucun profil n'a été contourné. |
| »»» metadata | object | true | none | Métadonnées sur le contenu inspecté. |
| »»»» subfile | boolean | true | none | Si un fichier conteneur est transmis à DLP (Prévention des pertes de données), les sous-fichiers qu'il contient sont également analysés. Si ce champ est vrai, la correspondance concerne un sous-fichier. Si ce champ est faux, soit le contenu transmis à DLP (Prévention des pertes de données) n'était pas un conteneur, soit la correspondance s'est faite sur le conteneur lui-même. |
| """" file_id | integer | false | none | L'identifiant interne du fichier/sous-fichier. |
| »»»» name | string | false | none | Le nom (par exemple nom du fichier), le cas échéant, du contenu inspecté. |
| """" taille | integer(uint64) | false | none | Taille en octets du fichier/sous-fichier. |
| """" sha256 | string | false | none | Le hachage SHA256 du contenu inspecté. |
| """" langue | string | false | none | La langue détectée du contenu inspecté. |
| """" type | string | false | none | Le type détecté du contenu inspecté. |
| Catégorie """" | string | false | none | La catégorie détectée du contenu inspecté. |
| »» » mime_type | string | false | none | Le type MIME du contenu inspecté. |
| »»»» protection | object | false | none | Ce champ est présent lorsque le contenu est protégé d'une manière ou d'une autre. La protection peut inclure le chiffrement et/ou microsoft_aip. |
| »»»»» chiffrement | object | false | none | Le contenu est chiffré. Aucune date de correspondance ne peut être produite pour le contenu chiffré. |
| »»»»»» file_typing | boolean | false | none | Contenu chiffré détecté lors de la saisie du type de fichier. |
| »»»»»» Classification | boolean | false | none | Contenu chiffré détecté avec classification. |
| »»»»»» classification_score | nombre(double) | false | none | Le score de contenu chiffré détecté par classification. |
| »»»»» microsoft_aip | object | false | none | Le contenu est protégé par Microsoft AIP. Si le contenu peut être déprotégé, il sera inspecté et des données de correspondance pourront être produites. Si les données de correspondance ne peuvent pas être déprotégées, elles ne peuvent pas être produites. |
| »»»»»» statut | string | true | none | État de la protection Microsoft AIP : protected: Le contenu n’a pas pu être déprotégé et n’a pas été inspecté. unsanctioned: Le contenu était protégé par AIP en dehors d'une infrastructure MIP connue et n'a donc pas pu être déprotégé ni inspecté. sanctioned: Le contenu était protégé par AIP via une infrastructure MIP connue. Ce contenu peut être non protégé et analysé. Il est également possible que des étiquettes DRM aient été extraites. |
| »»»» drm | object | false | none | Le contenu est protégé par un système de gestion des droits numériques (DRM). |
| »»»»» labels | [objet] | true | none | Un tableau d'objets d'étiquettes DRM contenant des informations détaillées sur les étiquettes DRM. |
| »»»»»» id | string | true | none | L'identifiant de l'étiquette. |
| »»»»»» name | string | true | none | Le nom de l'étiquette. |
| »»»»»» exemple | string | true | none | L'instance de l'étiquette. |
| »»»»»» vendor | string | true | none | Le vendeur de l'étiquette. |
| »»»»»» étiquette_classification_données | string | true | none | L’étiquette de classification des données. |
| « » » correspondances | [objet] | false | none | Tableau d'objets d'entrée de correspondance contenant des informations détaillées sur la correspondance DLP (Prévention des pertes de données). |
| »»»» id | string | false | none | L'identifiant de la correspondance. S'il s'agit d'une correspondance mise en cache , cette valeur sera définie sur l' identifiant de la correspondance précédente. Sinon, ce champ est un New identifiant que DLP (Prévention des pertes de données) utilisera pour faire référence à la correspondance si elle est vue à l'avenir. De plus, pour une réponse non mise en cache, une partie multipart/mixed extracted_text correspondante sera renvoyée pour ce fichier et cette valeur sera définie dans le champ name de l'en-tête Content-Disposition pour cette partie. |
| »»»» en cache | boolean | true | none | Si cela est vrai, cette correspondance a été trouvée dans le cache DLP (Prévention des pertes de données), ce qui signifie que le contenu a déjà été analysé pour ce profil et n'a donc pas été analysé dans le cadre de cette requête. L'identifiant est défini sur l' identifiant créé lors de l'analyse du contenu. De ce fait, aucune analyse forensique ne sera associée à la rencontre, car les données forensiques ne sont pas stockées dans le cache DLP (Prévention des pertes de données). |
| Profil de »»» » | any | true | none | none |
allOf
| Nom | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | false | none | Le nom du profil. |
and
| Nom | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»»» anonymous | any | false | none | Le profil auquel les règles correspondantes sont rattachées. |
continued
| Nom | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »»»» action_threshold_met | boolean | true | none | Si vrai, le seuil d'action a été atteint, ce qui indique que le client DLP (Prévention des pertes de données) doit effectuer l'action associée à ce profil. Si ce champ est faux, le seuil d'action n'a pas été atteint et l'action associée à ce profil ne doit pas être exécutée. |
| """" maximum_severity | string | false | none | La gravité maximale des règles correspondantes. |
| """" règles | [objet] | false | none | none |
| »»»»» name | string | true | none | Le nom de la règle. |
| """"" sévérité | string | true | none | The severity of the rule: none, low, medium, high, or critical |
| """"" type | string | true | none | The type of the rule. One of: entity: A rule that matches when a specific entity is found. For these rule matches the entity subfields will be present. not_entity: A rule that matches when a specific entity is not found. For these rule matches the entity subfields will be present. file_filter: A file filter rule. classification A classification rule. fingerprint A fingerprint rule. For these rule matches the fingerprint subfields will be present. fingerprint_group: A fingerprint 2.0 group rule. For these rule matches the fingerprint_group subfields will be present. structured_classification: A structured classification rule. For these rule matches the structured_classification subfields will be present. |
| »»»»» entity | object | false | none | Contains details about the entity rule that matched. This field is present when type is entity or not_entity. |
| """""" pondéré | boolean | true | none | If true this rule is using the weighted score to determine the severity. If false, count is being used. |
| """""" score | integer | true | none | Le score pondéré des correspondances de règles. |
| """""" limit_reached | boolean | true | none | Si vrai, le nombre maximum de correspondances pour cette règle a été atteint. Cela signifie que certaines données identifiées ont été omises des résultats. |
| """""" entities_summary | true | none | Un tableau des entités correspondantes et des décomptes correspondants pour ces entités. | |
| »»»»»»» entity | string | true | none | Le nom de l'entité qui a donné lieu à une correspondance. |
| """"""" compte | integer | true | none | Le nombre de fois que l'entité donnée a fait l'objet d'une correspondance. |
| """"""" data_type | string | false | none | Type de données générales décrivant cette entité. |
| """"""" niveau_de_sensibilité | string | true | none | How sensitive of a match is this entity. One of not_sensitive low medium high critical |
| """""" matches_count | integer | true | none | Le nombre de correspondances entre les règles d'entités. |
| """""" niveau_de_sensibilité | true | none | How sensitive of a match is this entity. One of: not_sensitive low medium high critical | |
| """""" unique_count | integer | false | none | Nombre d'entrées uniques correspondant à la règle. Ce champ n'est présent que lorsque le profil spécifie que les règles doivent être comptées de manière unique. |
| """"" classification_structurée | object | false | none | Détails d'une règle de type de classification correspondante |
| """""" entities_summary | true | none | Un tableau des entités correspondantes et des décomptes correspondants pour ces entités. | |
| """""" matches_count | integer | true | none | Le nombre de correspondances entre les règles d'entités. |
| """""" niveau_de_sensibilité | true | none | How sensitive of a match is this entity. One of not_sensitive low medium high critical | |
| »»»»»» type_de_données | false | none | Type de données générales décrivant cette entité. | |
| »»»»» empreinte digitale | object | false | none | This field is present when type is fingerprint. |
| »»»»»» Classification | string | true | none | La classification qui correspondait. |
| »»»»»» match | string | true | none | Le fichier correspondant. |
| """""" score | integer | true | none | Le score de l'empreinte digitale correspondante. |
| »»»»» groupe_empreintes_de_souvenirs | object | false | none | This field is present when type is fingerprint_group. |
| »»»»»» match | string | true | none | Le fichier avec empreinte digitale correspondant. |
| """""" score | integer | true | none | Le score de similarité du fichier d’empreintes digitales correspondant. |
| »» » Criminalistique | object | false | none | none |
| »»» » extracted_text | string(string) | false | none | Identifiant de chaîne utilisé pour corréler le texte extrait avec sa partie correspondante dans la réponse multipart |
| »»» » entity_rule_matches | string(string) | false | none | L’identifiant de chaîne utilisé pour corréler la règle d’entité correspond à sa partie correspondante dans la réponse multipartite. |
| »»» » preview_image | string(string) | false | none | Identifiant de chaîne utilisé pour corréler l’image d’aperçu avec sa partie correspondante dans la réponse multipartite. |
| »»»» sous-fichier_original | string(string) | false | none | Identifiant de chaîne utilisé pour faire correspondre le sous-fichier d'origine avec sa partie correspondante dans la réponse multipart. |
Enumerated Values
| Property | Value |
|---|---|
| InspectionStatus : statut | success |
| timeout | |
| error | |
| verdict | hit |
| no_hit | |
| verdict_type | full |
| partial | |
| sévérité | none |
| low | |
| medium | |
| high | |
| critical | |
| MicrosoftAipProtectionStatus : status | protected |
| unsanctioned | |
| sanctioned | |
| sévérité | none |
| low | |
| medium | |
| high | |
| critical | |
| type | entity |
| not_entity | |
| file_filter | |
| classification | |
| fingerprint | |
| fingerprint_group | |
| structured_classification | |
| sensitivity_level | not_sensitive |
| low | |
| medium | |
| high | |
| critical |
Cette opération ne nécessite pas d'authentification

