Skip to main content
POST
Request security scans for installed repositories

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Body

application/json
repository_ids
string[]
required
Required array length: 1 - 100 elements
Required string length: 1 - 255
targets
enum<string>[]
required
Required array length: 1 - 4 elements
Available options:
code,
dependencies,
sbom,
secrets
scan_mode
enum<string>
required
Available options:
map,
deep
org_id
string
Minimum string length: 1
spend_limit_cents
integer
Required range: 1000 <= x <= 100000000
allow_cap_overage
boolean
paid_usage_confirmation
object

Response

OK

results
object[]
required
triggeredCount
integer
required
Required range: 0 <= x <= 9007199254740991
requestedRepos
integer
required
Required range: 0 <= x <= 9007199254740991
targets
string[]
required