DLPコンテンツ検査および結果取得(同期)- Netskope技術文書

この API エンドポイントは、DLP コンテンツ検査を同期的に実行し、結果を取得するために使用されます。コンテンツ検査が最大タイムアウトである10秒を超えた場合、ステータスフィールドに「timeout」を設定したHTTP 200が返されます。この呼び出しは、 summary とdetailsの評決タイプのみをサポートします。

このエンドポイントには、いくつかの追加の制限事項があります。

Max File Size: 1 megabyte
Timeout: 10秒
Max DLP Profiles: 100
Character Length of Each Profile name: 256文字

リクエストエンドポイント

POST

https://<appliance_ip>/inspections

呼び出し例

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'

回答例

#200 Example

Indicates a successful response, and the results are provided in multiple multipart/mixed parts.

リクエストヘッダーx-netskope-generate-incidentsが追加されるのは、ユーザーがアラートやインシデントの生成方法を指定できるようにするためです。

レスポンスヘッダーも作成されました: x-netskope-incidents-posted 。レスポンスヘッダーには、アラートとインシデントが管理プレーンに投稿されたかどうかが反映されます。

Valid Query Parameters:

パラメータ

名前	In	タイプ	Required	デスクリプション
body	body	object	true	none
" リクエスト	body	object	true	同期検査要求のプロパティを指定します。
»» プロフィール	body		true	スキャン中に使用するプロファイルのリスト。プロファイルは、一致するものを検索する際にどの DLP ルールを使用するかを決定します。一致を検索する際に。
"" コンテンツ	body		true	リクエストの一部としてDLPに送信されるコンテンツについて説明します。
»»» id	body	string	true	送信されたコンテンツのSHA256ハッシュ値。
»»» name	body	string	false	名前（例）データのファイル名)
»»» オブジェクトID	body	string	false	データのオブジェクト識別子。
»»» 真のファイルタイプ	body	integer	false	Netskopeの真のファイルタイプ（数値ID）
»» modules	body		false	検査中に実行される個々のDLPモジュールの設定を指定します。検査中。
»»» ファイルフィルター	body	object	false	ファイルフィルタモジュールの設定を指定します。
»»»» スキップ	body	boolean	false	条件が真の場合、ファイルフィルタリングはスキップされます。
»»» drm	body	object	false	DLPに明示的なDRMラベルを渡すことを可能にします。
»»»» labels	body	[物体]	true	none
»»»»» id	body	string	true	ラベルのID。
»»»»» name	body	string	false	ラベルの名前。
""""" 実例	body	string	false	ラベルのインスタンス。
»»»»» vendor	body	string	true	ラベルの販売業者。
"" 結果	body	object	false	検査から返されるDLPオンデマンド結果のプロパティを指定します。
»»» 判決	body	string	false	返される試合の詳細情報の量を指定します。次のいずれかが返されます: summary – 判決の要約が返されます。これには、結果、判決の種類、プロファイルのリスト、重大度が含まれます。 details – 試合の詳細が含まれます。判決に関する詳細は、結果の一致、プロファイル、およびファイルごとのルールを含みます。 forensics – 試合の概要、詳細、および鑑識結果が含まれます。ルール情報、一致したテキスト、抽出されたコンテンツなど、試合に関するすべての詳細情報が返されます。ご注意ください。この操作を行うと、ファイル全体のフルスキャンが実行されます。判決が指定されていない場合は、デフォルトで要約タイプとなり、判決の要約が返されます。
»» 送信者	body		false	リクエストの呼び出し元について説明します。
»»» アプリ名	body	string	true	呼び出しをトリガーしたアプリケーション
" コンテンツ	body	文字列（バイナリ）	true	none

Enumerated Values

パラメータ	Value
»»» 判決	summary
	details

Responses

状態	Meaning	デスクリプション	Schema
200	OK	応答が成功したことを示し、結果は複数の部分（複数パートまたは混合パート）に分けて提供されます。	列をなして
400	要求の形式が正しくありません	リクエストは無効でした。レスポンスには、リクエストが拒否された原因となったエラー情報が含まれています（利用可能な場合）。	string
413	ペイロードが大きすぎる	指定されたコンテンツは大きすぎるため、スキャンできません。	なし
500	内部サーバーエラー	リクエストの実行中にエラーが発生しました。レスポンスには、リクエストが拒否された原因となったエラー情報が含まれています（利用可能な場合）。	string
503	サービスは利用できません	リクエストを実行するためのリソースがありません。	なし

応答スキーマ

ステータスコード 200

名前	タイプ	Required	制限	デスクリプション
» 結果データ		false	none	検査の総合結果が記載されています。これには、検査の状況と、検査の結果として得られた一致結果が含まれます。
"" 状態		true	none	スキャン要求のステータスを指定します。 success – コンテンツの検査は正常に完了しました。 timeout – コンテンツ検査に時間がかかりすぎたため、タイムアウトしました。 error – コンテンツ検査の実行中にエラーが発生しました。
»» ステータス情報	string	false	none	状況に関する追加情報。例えば、 statusがエラーの場合、このフィールドは発生したエラーの詳細を示すために存在する可能性があります。
"" まとめ		false	none	none
»»» 判決	string	true	none	判決。以下のいずれか： hit no_hit
»»» 評決タイプ	string	true	none	判決の種類。以下のいずれか： full partial
""" 重大度	string	false	none	その規則の厳しさ。以下のいずれか： none low medium high critical
»»» プロフィール		true	none	スキャン中に使用するプロファイルのリスト。プロファイルは、一致するものを検索する際にどの DLP ルールを使用するかを決定します。一致を検索する際に。
»»» トランザクションID	string	true	none	この試合のトランザクションID。
"" 結果	[物体]	false	none	スキャンが正常に完了した場合（ステータスが成功の場合）、このフィールドが表示されることがあります。これにはエントリの配列が含まれており、スキャンされたコンテンツ内のファイル/サブファイルごとに1つずつエントリが格納されています。ルールに一致したファイル／サブファイル、または保護されているためスキャンできなかったファイル／サブファイルのみがここに表示されます。スキャンされたものの、上記2つの条件のいずれも満たさなかったファイルは、ここには表示されません。
»»» バイパスされたプロファイル	[string]	false	none	スキャン対象のファイルが何らかの方法で保護されていたため、リクエストから除外されたプロファイルの一覧を指定します。このフィールドが存在しない場合、プロファイルはスキップされませんでした。
»»» metadata	object	true	none	検査対象コンテンツに関するメタデータ。
»»»» subfile	boolean	true	none	コンテナファイルがDLPに渡された場合、その中のサブファイルもスキャンされます。このフィールドがtrueの場合、一致するのはサブファイルです。このフィールドが false の場合、DLP に渡されたコンテンツがコンテナではなかったか、一致がコンテナ自体に対して行われたかのいずれかです。
»»»» ファイルID	integer	false	none	ファイル／サブファイルの内部識別子。
»»»» name	string	false	none	名前（例）検査対象コンテンツのファイル名（存在する場合）。
"""" サイズ	integer(uint64)	false	none	ファイル／サブファイルのサイズ（バイト単位）。
»»»» sha256	string	false	none	検査対象コンテンツのSHA256ハッシュ値。
"""" 言語	string	false	none	検査対象コンテンツの検出された言語。
"""" タイプ	string	false	none	検査対象コンテンツの検出された種類。
»»»» カテゴリ	string	false	none	検査対象コンテンツの検出されたカテゴリ。
»»»» mime_type	string	false	none	検査対象コンテンツのMIMEタイプ。
»»»» 保護	object	false	none	このフィールドは、コンテンツが何らかの方法で保護されている場合に存在します。保護には、暗号化とmicrosoft_aipのいずれか、または両方が含まれる場合があります。
»»»»» 暗号化	object	false	none	内容は暗号化されています。暗号化されたコンテンツのマッチデータは作成できません。
»»»»»» ファイルタイプ	boolean	false	none	ファイルの入力で暗号化された内容が検出されます。
»»»»»» 分類	boolean	false	none	暗号化されたコンテンツは機密扱いで検出されます。
»»»»»» 分類スコア	数値（倍精度浮動小数点数）	false	none	分類で検出された暗号化コンテンツのスコア。
»»»»» microsoft_aip	object	false	none	このコンテンツはマイクロソフトのAIP（アプリケーション知的財産権）によって保護されています。コンテンツが保護されていない場合、検査が行われ、照合データが生成される可能性があります。保護されていないマッチデータを作成できない場合、データは生成されません。
"""""" 状態	string	true	none	Microsoft AIP の保護状態: protected : コンテンツの保護を解除できなかったため、検査されませんでした。 unsanctioned : コンテンツは既知のMIPインフラストラクチャ外でAIP保護されていたため、保護を解除できず、検査も行われませんでした。 sanctioned : コンテンツは既知のMIPインフラストラクチャによってAIPで保護されていました。そのようなコンテンツは保護されておらず、スキャンされる可能性があります。また、DRMラベルが抽出されている可能性もあります。
»»»» drm	object	false	none	コンテンツはDRMシステムによって保護されています。
»»»»» labels	[物体]	true	none	詳細なDRMラベル情報を含むDRMラベルオブジェクトの配列。
»»»»»» id	string	true	none	ラベルのID。
»»»»»» name	string	true	none	ラベルの名前。
"""""" 実例	string	true	none	ラベルのインスタンス。
»»»»»» vendor	string	true	none	ラベルの販売業者。
»»»»»» データ分類ラベル	string	true	none	データ分類ラベル。
»»» マッチ	[物体]	false	none	詳細なDLPマッチ情報を含むマッチエントリオブジェクトの配列。
»»»» id	string	false	none	マッチ識別子。これがキャッシュされたマッチの場合、これは前のマッチのIDに設定されます。それ以外の場合、このフィールドは、将来一致が見つかった場合に DLP が参照するために使用する新しい識別子です。さらに、キャッシュされていないレスポンスの場合、このファイルに対応するextracted_text multipart/mixedパートが返され、この値がそのパートのContent-Dispositionヘッダーのnameフィールドに設定されます。
»»»» キャッシュ済み	boolean	true	none	もしこれが真実であれば、この一致はDLPキャッシュ内で見つかったことを意味し、つまりコンテンツは既にこのプロファイルでスキャンされているため、今回のリクエストの一部としてスキャンされなかったということです。idには、コンテンツがスキャンされたときに作成されたidが設定されます。このため、DLPキャッシュにはフォレンジックデータが保存されないため、試合に関連するフォレンジック情報は提供されません。
»»»» プロフィール	any	true	none	none

allOf

名前	タイプ	Required	制限	デスクリプション
»»»»» anonymous		false	none	プロフィール名。

and

名前	タイプ	Required	制限	デスクリプション
»»»»» anonymous	any	false	none	一致するルールが関連付けられているプロファイル。

continued

名前	タイプ	Required	制限	デスクリプション
»»»» action_threshold_met	boolean	true	none	真の場合、アクションしきい値に達したことを意味し、DLPクライアントはこのプロファイルに関連付けられたアクションを実行する必要があります。このフィールドがfalseの場合、アクションのしきい値に達していないため、このプロファイルに関連付けられたアクションは実行されません。
»»»» 最大重症度	string	false	none	一致するルールの最大厳格度。
»»»» ルール	[物体]	false	none	none
»»»»» name	string	true	none	ルールの名称。
""""" 重大度	string	true	none	ルールの厳しさ： none 、 low 、 medium 、 high 、またはcritical
""""" タイプ	string	true	none	ルールの種類。次のいずれか: entity : 特定のエンティティが見つかったときに一致するルール。これらのルールに一致する場合、エンティティのサブフィールドが存在します。 not_entity : 特定のエンティティが見つからない場合に一致するルール。これらのルールに一致する場合、エンティティのサブフィールドが存在します。 file_filter : ファイルフィルタルール。分類分類規則。指紋指紋に関する規則。これらのルールに一致する場合、指紋サブフィールドが存在します。fingerprint_group : フィンガープリント 2.0 グループルール。これらのルールに一致する場合、 fingerprint_groupサブフィールドが存在します。 structured_classification ：構造化された分類ルール。これらのルールに一致する場合、 structured_classificationサブフィールドが存在します。
»»»»» entity	object	false	none	Contains details about the entity rule that matched. This field is present when type is entity or not_entity.
»»»»»» 加重平均	boolean	true	none	If true this rule is using the weighted score to determine the severity. If false, count is being used.
"""""" スコア	integer	true	none	ルールの加重スコアは一致しています。
»»»»»» 制限に達しました	boolean	true	none	もしこれが真実であれば、このルールにおける最大一致数に達したことになります。これは、特定されたデータの一部が結果から除外されたことを意味します。
»»»»»» エンティティの概要		true	none	一致したエンティティとそのエンティティに対応するカウントの配列。
»»»»»»» entity	string	true	none	一致したエンティティの名前。
»»»»»»» カウント	integer	true	none	指定されたエンティティが一致した回数。
»»»»»»» データ型	string	false	none	このエンティティを記述する一般的なデータ型。
»»»»»»» 感度レベル	string	true	none	このエンティティはどの程度感度の高い一致ですか？感度が低い、中程度、高い、クリティカルのいずれか
»»»»»» マッチ数	integer	true	none	エンティティルールが一致する件数。
»»»»»» 感度レベル		true	none	このエンティティはどの程度感度の高い一致ですか？以下のいずれか： not_sensitive low medium high critical
»»»»»» ユニークカウント	integer	false	none	ルールに一致した固有のエントリの数。このフィールドは、プロファイルでルールを一意にカウントするように指定されている場合にのみ表示されます。
»»»»» 構造化分類	object	false	none	一致する分類タイプルールの詳細
»»»»»» エンティティの概要		true	none	一致したエンティティとそのエンティティに対応するカウントの配列。
»»»»»» マッチ数	integer	true	none	エンティティルールが一致する件数。
»»»»»» 感度レベル		true	none	このエンティティはどの程度感度の高い一致ですか？感度が低い、中程度、高い、クリティカルのいずれか
»»»»»» データ型		false	none	このエンティティを記述する一般的なデータ型。
»»»»» 指紋	object	false	none	This field is present when type is fingerprint.
»»»»»» 分類	string	true	none	一致した分類。
"""""" マッチ	string	true	none	一致したファイル。
"""""" スコア	integer	true	none	一致した指紋のスコア。
»»»»» 指紋グループ	object	false	none	This field is present when type is fingerprint_group.
"""""" マッチ	string	true	none	一致した指紋ファイル。
"""""" スコア	integer	true	none	一致した指紋ファイルの類似度スコア。
»»» 鑑識	object	false	none	none
»»»» 抽出されたテキスト	string(string)	false	none	文字列識別子使うは、抽出されたテキストをマルチパート応答の対応する部分と相関させるためです
»»»» エンティティルールが一致する	string(string)	false	none	エンティティルールをマルチパート応答の対応する部分と一致させるための文字列識別子使う。
»»»» プレビュー画像	string(string)	false	none	文字列識別子使うはプレビュー画像をマルチパート応答の対応する部分と相関させます。
»»»» オリジナルサブファイル	string(string)	false	none	文字列識別子元のサブファイルをマルチパートレスポンス内の対応する部分と関連付けるために使用されます。

Enumerated Values

Property	Value
検査状況: ステータス	success
	timeout
	error
verdict	hit
	no_hit
verdict_type	full
	partial
重大度	none
	low
	medium
	high
	critical
MicrosoftAipProtectionStation: ステータス	protected
	unsanctioned
	sanctioned
重大度	none
	low
	medium
	high
	critical
タイプ	entity
	not_entity
	file_filter
	classification
	fingerprint
	fingerprint_group
	structured_classification
sensitivity_level	not_sensitive
	low
	medium
	high
	critical

この操作には認証は必要ありません