Retrieve Threat Scan Reports by Report IDs

GET 
/v1/scan/reports

Get the Threat Scan Reports for a given list of report_ids

Request

Query Parameters

report_ids string[]required

Report Ids for Results

Header Parameters

x-pan-token stringrequired

API key token

Responses

200

Successfully returned Threat Scan Reports

application/json

Schema

Schema

• Array [
report_id string

Unique identifier for the scan report

scan_id string

Unique identifier for the scan

req_id uint32

Unique identifier of an individual element sent in the batch scan request

transaction_id string

Unique identifier for the transaction

detection_results object[]
Array [
data_type string
Content type such as "prompt" or "response"
detection_service string
Detection service name generating the results such as "urlf", "dlp", and "prompt injection"
verdict string
Detection service verdict such as "malicious" or "benign"
action string
The action is set to "block" or "allow" based on AI security profile used for scanning
result_detail object
urlf_report object[]
Array [
url string
URL in the scan request
risk_level string
Risk level associated with the URL, such as "high", "medium", or "low"
categories string[]
Categories associated with the URL
]
dlp_report object
dlp_report_id string
Unique identifier for the DLP report
dlp_profile_name string
DLP profile name used for the scan
dlp_profile_id string
Unique identifier for the DLP profile used for the scan
dlp_profile_version int32
Version of the DLP profile used for the scan
data_pattern_rule1_verdict string
Indicates whether there was a content match for this rule such as "MATCHED" or "NOT MATCHED"
data_pattern_rule2_verdict string
Indicates whether there was a content match for this rule such as "MATCHED" or "NOT MATCHED"
]
• ]

Example (from schema)

[
  {
    "report_id": "R82f1e879-0000-49af-9345-da907431c08f",
    "scan_id": "82f1e879-0000-49af-9345-da907431c08f",
    "req_id": 0,
    "transaction_id": 442116912,
    "detection_results": [
      {
        "data_type": "prompt",
        "detection_service": "pi",
        "verdict": "malicious",
        "action": "block",
        "result_detail": {
          "urlf_report": [
            {
              "url": "urlfiltering.paloaltonetworks.com/test-malware",
              "risk_level": "high",
              "categories": "malware"
            }
          ],
          "dlp_report": {
            "dlp_report_id": "0000023BD6053DF065925BDB2EB7E21C36ABD93F69AEB48DE8D6EE8E6FED3F91",
            "dlp_profile_name": "Sensitive Content",
            "dlp_profile_id": 11995043,
            "dlp_profile_version": 0,
            "data_pattern_rule1_verdict": "NOT_MATCHED",
            "data_pattern_rule2_verdict": ""
          }
        }
      }
    ]
  }
]

400

Bad Request - Request data is invalid or malformed

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Request data is invalid or malformed"
  }
}

401

Unauthenticated - Not Authenticated

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Not Authenticated"
  }
}

403

Forbidden - Invalid API Key

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Invalid API Key"
  }
}

404

Not Found - Resource is not found

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "Resource is not found"
  }
}

405

Method Not Allowed - The method is not allowed

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The method is not allowed"
  }
}

413

Request Too Large - The request body is too large

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The request body is too large"
  }
}

415

Unsupported Media Type - The media type is not supported

application/json

Schema

Schema

error object
message string

Example (from schema)

{
  "error": {
    "message": "The media type is not supported"
  }
}

429

Too Many Requests - Request exceeds limit

application/json

Schema

Schema

error object
message string
retry_after object
interval integer
unit string

Example (from schema)

{
  "error": {
    "message": "Request exceeds limit",
    "retry_after": {
      "interval": 5,
      "unit": "minute"
    }
  }
}

default

error occurred

application/json

Schema

Schema

status_code int32required

The HTTP status code for the error

message stringrequired

The error message

Example (from schema)

{
  "status_code": 0,
  "message": "string"
}

Loading...