List scan result files

GET

/scan/v3/results/:scan_id/files

GET

/scan/v3/results/:scan_id/files

curl https://api.hiddenlayer.ai/scan/v3/results/scan_id/files \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "file_instance_id": "string",
      "file_location": "string",
      "start_time": "2024-10-16T23:38:32.278Z",
      "end_time": "2024-10-16T23:38:32.354Z",
      "details": {
        "estimated_time": "string",
        "sha256": "a54d88e06612d820bc3be72877c74f257b561b19",
        "file_type": "safetensors",
        "md5": "ce114e4501d2f4e2dcea3e17b546f339",
        "tlsh": "T1C50757F93C74D00C05B70C0793A1D5A9DF3F6D3A2F7AD940F3BFBF07B3BDF5A1D293",
        "file_size": "9 GB",
        "file_size_bytes": 9663676416,
        "file_type_details": {
          "subtype": [
            "string"
          ]
        }
      },
      "status": "skipped",
      "seen": "2024-10-22T17:59:12.431Z",
      "detections": [
        {
          "detection_id": "00000000-0000-0000-0000-000000000000",
          "rule_id": "PICKLE_0055_202408",
          "risk": "MALICIOUS",
          "category": "Arbitrary Code Execution",
          "description": "Found lambda embedded in keras model allowing custom layers that support  arbitrary expression execution",
          "likelihood": "medium",
          "impact": "critical",
          "severity": "critical",
          "mitre_atlas": [
            {
              "technique": "string",
              "tactic": "string"
            }
          ],
          "owasp": [
            "string"
          ],
          "cve": [
            "string"
          ],
          "cwe": "string",
          "cwe_href": "string",
          "rule_details": [
            {
              "status": "created",
              "status_at": "2024-01-15T09:30:00Z",
              "description": "string"
            }
          ],
          "technical_blog_hrefs": [
            "string"
          ],
          "technical_blog_href": "string"
        }
      ],
      "advisories": [
        {
          "advisory_id": "00000000-0000-0000-0000-000000000000",
          "rule_id": "SAFETENSORS_0001_202512",
          "category": "TokenBreak",
          "description": "Models using the BPE and WordPiece tokenization strategies are vulnerable to TokenBreak"
        }
      ],
      "file_error": [
        "File not found"
      ],
      "compliance": {
        "status": "COMPLIANT",
        "rationale": [
          "string"
        ]
      }
    }
  ],
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Returns a cursor-paginated list of file results for a given scan. Results are sorted by compliance status, then highest detection severity, then file path.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

scan_idstringRequired

Response

Paginated file results

itemslist of objects

Array of items for this page

Errors

400

Bad Request Error

404

Not Found Error