Retrieve Scan Results by ScanIDs

GET 
/v1/scan/results

Get the Scan results for upto a maximum of 5 Scan IDs

Request

Query Parameters

scan_ids string[]required

Scan Ids for Results

Header Parameters

x-pan-token stringrequired

API key token

Responses

200

Successfully returned records for Scan Results

application/json

Schema

Schema

• Array [
req_id integer

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

status string

Scan request processing state such as "complete" or "pending"

scan_id string

Unique identifier for the scan

result object

report_id stringrequired

Unique identifier for the scan report

scan_id uuidrequired

Unique identifier for the scan

tr_id string

Unique identifier for the transaction

profile_id uuid

Unique identifier of the AI security profile used for scanning

profile_name string

AI security profile name used for scanning

category stringrequired

Category of the scanned content verdicts such as "malicious" or "benign"

action stringrequired

The action is set to "block" or "allow" based on AI security profile used for scanning

prompt_detected object

url_cats boolean

Indicates whether prompt contains any malicious URLs

dlp boolean

Indicates whether prompt contains any sensitive information

injection boolean

Indicates whether prompt contains any injection threats

response_detected object

url_cats boolean

Indicates whether response contains any malicious URLs

dlp boolean

Indicates whether response contains any sensitive information

created_at date-time

Scan request timestamp

completed_at date-time

Scan completion timestamp

• ]

Example (from schema)

[
  {
    "req_id": 0,
    "status": "complete",
    "scan_id": "020e7c31-0000-4e0d-a2a6-215a0d5c56d9",
    "result": {
      "report_id": "R82f1e879-0000-49af-9345-da907431c08f",
      "scan_id": "82f1e879-0000-49af-9345-da907431c08f",
      "tr_id": 1234,
      "profile_id": "12345678-0000-1234-1234-123456789012",
      "profile_name": "ai-dummy-profile",
      "category": "malicious",
      "action": "block",
      "prompt_detected": {
        "url_cats": true,
        "dlp": true,
        "injection": true
      },
      "response_detected": {
        "url_cats": true,
        "dlp": true
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "completed_at": "2024-07-29T15:51:28.071Z"
    }
  }
]

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...