Cette API est un point de terminaison asynchrone permettant de planifier des tâches d'inspection de contenu DLP (Prévention des pertes de données). Cette API accepte le contenu à inspecter et renvoie soit un identifiant de travail pour un traitement asynchrone, soit les résultats immédiats du cache s'ils sont disponibles.
Ce point d'arrivée présente quelques limitations supplémentaires :
- Max File Size: 1 megabyte
- Max DLP Profiles: 100
- Character Length of Each Profile name: 256 caractères
Point final de la demande
POST
https://<appliance_ip>/inspections/jobs
Exemple d'appel
curl -X 'POST' \
'https://10.0.0.1/inspections/jobs' \
-H 'accept: multipart/form-data' \
-H 'x-netskope-generate-incidents: true' \
-H 'Content-Type: multipart/form-data' \
-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=@SecretFile.txt;type=text/txt'
Exemple de réponse
#A cached hit was found, therefore no job was scheduled. The results are returned in json.
#200 Response
HTTP/1.1 200 OK
Content-Type: multipart/form-data; boundary=8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92
--8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92
Content-Disposition: form-data; name="result_data"
Content-Type: application/json
{"status":"success","summary":{"profiles":["DLP-PCI","DLP-PII"],"transaction_id":"3947352303853909965","verdict":"hit","verdict_type":"full"}}
--8b9eb155309408d78d1886c2af2803fdba94a7bea3dac274b3da5fa31e92--
#No prior request is found and a new job is started.
#202 Response
{
"job_id": "8a426a5f-0d2e-0a2e-3595a-303202a7a2e"
}
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 are:
| 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. |
| 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 du contenu |
| »»» name | body | string | false | Le nom (par exemple nom de fichier) du contenu. |
| """ 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 | |
| forensics |
Responses
| Statut | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Une demande antérieure a été trouvée et il s'agit d'une réponse mise en cache. Les résultats sont renvoyés sous forme de fichier json. | Inline |
| 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 |
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 hit. One of: none low medium high 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 | false | none | Type de données générales décrivant cette entité. | |
| """"""" niveau_de_sensibilité | true | none | The severity of the rule hit. One of: none 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 | Quelle est la sensibilité de cette entité ? L'un des 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 |
Code de statut 202
Cet objet est renvoyé à l'appliance DLP (Prévention des pertes de données) à la demande pour une demande d'inspection asynchrone afin d'indiquer que la DLP (Prévention des pertes de données) a accepté la demande et 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

