Skip to main content
POST
Run a scanner job
Start a Trustabl scan on a scanner connector. Missing body fields use the connector defaults. The response includes the finished job and its findings. Do not send a GitHub token in the body — the token stays on the connector. The request can take several minutes (up to 300 seconds). See Scanner connectors for setup.

Headers

x-openlit-organisation-id
string
x-openlit-project-id
string
required
x-openlit-environment
string
required
Example:

"production"

Path Parameters

id
string
required

Scanner connector ID (scanner:<uuid>).

Body

application/json
target
string
Example:

"https://github.com/acme/checkout-agent"

ref
string
Example:

"main"

detectors
string
Example:

"claude_sdk,mcp"

strict
boolean
secretScan
boolean
vulnScan
boolean
licenseScan
boolean
requireSigned
boolean
rulesRepo
string
rulesRef
string
rulesSource
enum<string>
Available options:
environment,
production,
staging,
git
noRulesUpdate
boolean
verbose
boolean

Response

Scan job result.

connector
object
job
object