API
/
File Scan Request
API
/
File Scan Request
API
/
File Scan Request

API

File Scan

Written by

Toni Barthel

Published

Oct 13, 2024

API

File Scan

Written by

Toni Barthel

Published

Oct 13, 2024

API

File Scan

Written by

Toni Barthel

Published

Oct 13, 2024

Request

Provide string data and scan it using the specified policy UUID to uncover sensitive information. If a violation is detected, it will return a list of findings. If no findings are detected, it will return "message": "no violation found".

Required attributes

  • policy.uuid The policy UUID you want to use for the scan. Currently, only one policy is allowed.

  • file.uuid The uuid from the file you want to scan.


POST /api/v1/upload/{uuid}/scan HTTP/1.1
Host: api.1protection.ai
Content-Type: application/json
Authorization


BODY

{
  "policy": {
    "uuid": "6909d02e-7cd0-4ddf-a1c3-cf5aa535a3f1"
  }
}


Response


RESPONSE WITHOUT VIOLATION

{
    "message": "no violation found"
}


RESPONSE WITH VIOLATION

{
  "uuid": "...",
  "findings": [
    {
      "id": "...",
      "beforeContext": "...",
      "finding": "...",
      "afterContext": "...",
      "redactedFinding": "...",
      "detectorId": "...",
      "detectorName": "...",
      "confidence": ..,
    },
  // ...
}