Get scan results | HiddenLayer Documentation

{
  "version": "string",
  "scan_id": "string",
  "start_time": "2024-01-15T09:30:00Z",
  "status": "pending",
  "inventory": {
    "model_name": "keras-tf-2025-05-27",
    "requested_scan_location": "/files-to-scan",
    "model_id": "00000000-0000-0000-0000-000000000000",
    "model_version_id": "00000000-0000-0000-0000-000000000000",
    "model_version": "1.0.0",
    "model_source": "adhoc",
    "file_location": "https://huggingface.co/meta-llama/Llama-3.1-8B",
    "provider_details": {
      "provider": "AWS_BEDROCK",
      "provider_model_id": "anthropic.claude-3-5-sonnet-20241022-v2:0"
    },
    "asset_region": "string",
    "requesting_entity": "string",
    "request_source": "Hybrid Upload",
    "origin": "Hugging Face"
  },
  "summary": {
    "file_count": 1,
    "files_with_detections_count": 1,
    "detection_count": 1,
    "severity": "critical",
    "detection_categories": [
      "string"
    ],
    "highest_severity": "critical",
    "advisory_count": 1,
    "advisory_categories": [
      "string"
    ],
    "files_failed_to_scan": 1,
    "unknown_files": 1
  },
  "file_count": 1,
  "files_with_detections_count": 1,
  "detection_count": 1,
  "has_genealogy": true,
  "$schema_version": "string",
  "end_time": "2024-01-15T09:30:00Z",
  "intelligence": {
    "geographic_footprint": [
      "US",
      "GB"
    ],
    "country_of_origin": "US",
    "contributor_trust_level": "high",
    "licenses": [
      {
        "name": "Apache-2.0",
        "sha256": "abc123..."
      }
    ],
    "usage_policies": [
      {
        "name": "Commercial Use Allowed",
        "sha256": "def456..."
      }
    ]
  },
  "compliance": {
    "status": "COMPLIANT",
    "evaluated_at": "2024-01-15T09:30:00Z",
    "rule_set_ids": [
      "string"
    ]
  },
  "file_results": [
    {
      "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"
      ]
    }
  ],
  "severity": "critical",
  "detection_categories": [
    "string"
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

scan_idstringRequired

Response

Successful response

versionstring

scanner version

scan_idstring

unique identifier for the scan

start_timedatetime

time the scan started

statusenum

status of the scan

Allowed values:

inventoryobject

summaryobject

A scan report without any file results.

file_countintegerDeprecated

number of files scanned; use .summary.file_count instead

files_with_detections_countintegerDeprecated

number of files with detections found; use .summary.files_with_detections_count instead

detection_countintegerDeprecated

number of detections found; use .summary.detection_count instead

has_genealogybooleanOptional

if there is model geneaology info available

$schema_versionstringOptional

version of the scan report schema format

end_timedatetimeOptional

time the scan ended

intelligenceobjectOptional

Intelligence metadata about a model including origin, licensing, and usage policies

complianceobjectOptionalRead-only

file_resultslist of objectsOptional

severityenumOptional

The highest severity of any detections on the scan, including “safe”. Use .summary.highest_severity instead.

detection_categorieslist of stringsOptionalDeprecated

list of detection categories found; use .summary.detection_categories instead

Errors

400

Bad Request Error

404

Not Found Error