Skip to main content
POST
Request security scans for installed repositories
To install and sign in to the CLI, see Call from the CLI.
CodeRabbit accepts the work and finishes it later: read the result with List security scans.

Authorizations

x-coderabbitai-api-key
string
header
required

See Authentication for the key types and where to create a key.

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

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1
org_name
string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
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: x >= 0
requestedRepos
integer
required
Required range: x >= 0
targets
string[]
required