Model Scanner SaaS
Model Scanner Self-Hosted (Deprecated)

Scan a remote model

post/scan/v3/jobs

Response

Scan job request was accepted

scan_idstring uuid

unique identifier for the scan

status'pending' | 'running' | 'done' | 'failed' | 'canceled'

Status of the scan

Example response

{
  "inventory": {
    "model_name": "keras-tf-2025-05-27",
    "model_version": "1.0.0",
    "requested_scan_location": "/files-to-scan",
    "scan_target": {
      "deep_scan": {
        "file_location": "https://huggingface.co/meta-llama/Llama-3.1-8B",
        "files": [
          {
            "file_location": "https://huggingface.co/meta-llama/Llama-3.1-8B/resolve/main/config.json",
            "file_name_alias": "model-config.json"
          }
        ]
      },
      "provider_details": {
        "provider": "AWS_BEDROCK",
        "provider_model_id": "anthropic.claude-3-5-sonnet-20241022-v2:0"
      },
      "asset_region": "us-east-1",
      "asset_id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
    },
    "origin": "Hugging Face"
  },
  "scan_id": "00000000-0000-0000-0000-000000000000",
  "status": "pending"
}

Changes

Changed in 4 of the 44 revisions of this API.26

    • added the new optional request property inventory/scan_target/asset_id

      new-optional-request-property

    • added the optional property inventory/scan_target/asset_id to the response with the 201 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new AZURE_ML enum value to the inventory/scan_target/provider_details/provider response property for the response status 201

      response-property-enum-value-added

    • added the new AZURE_ML enum value to the request property inventory/scan_target/provider_details/provider

      request-property-enum-value-added

    • added the new DATABRICKS enum value to the inventory/scan_target/provider_details/provider response property for the response status 201

      response-property-enum-value-added

    • added the new DATABRICKS enum value to the request property inventory/scan_target/provider_details/provider

      request-property-enum-value-added

    • added the new optional request property inventory/scan_target/provider_details/country

      new-optional-request-property

    • added the optional property inventory/scan_target/provider_details/country to the response with the 201 status

      response-optional-property-added