> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Request security scans for installed repositories

> Uses existing scan admission, product flags, permission checks and billing. Explicit paid usage confirmation still requires subscription management permission. A triggered result means dispatch was accepted, not that the scan completed.

> [tab] CLI Tool
>
> ```bash
> coderabbit api request /security/scans --input request.json
> ```
>
> To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md).

> [tab] MCP Server
>
> An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `start_security_scans` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "start_security_scans",
>     "arguments": {
>       "repository_ids": [],
>       "targets": [],
>       "scan_mode": "map"
>     }
>   }
> }
> ```

CodeRabbit accepts the work and finishes it later: read the result with [List security scans](https://docs.coderabbit.ai/api/reference/list-security-scans.md).


## OpenAPI

````yaml /openapi.json post /v1/security/scans
openapi: 3.0.0
info:
  title: CodeRabbit API
  version: 1.0.0
  description: >-
    Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security
    findings, Knowledge Base, configuration, and users for your organization.
servers:
  - url: https://api.coderabbit.ai
    description: US region
  - url: https://api.eu.coderabbit.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations and repositories
  - name: Pull requests and reviews
  - name: Coding Agent
  - name: Coding environments
  - name: Verify
  - name: Triage
  - name: Security
  - name: Knowledge Base
  - name: Automations
  - name: Reports
  - name: Configuration
  - name: Connections
  - name: Users and roles
  - name: Usage and metrics
paths:
  /v1/security/scans:
    post:
      tags:
        - Security
      summary: Request security scans for installed repositories
      description: >-
        Uses existing scan admission, product flags, permission checks and
        billing. Explicit paid usage confirmation still requires subscription
        management permission. A triggered result means dispatch was accepted,
        not that the scan completed.
      operationId: start_security_scans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                org_id:
                  type: string
                  minLength: 1
                  description: >-
                    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.
                org_name:
                  type: string
                  pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
                  description: >-
                    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.
                repository_ids:
                  type: array
                  minItems: 1
                  maxItems: 100
                  items:
                    type: string
                    minLength: 1
                    maxLength: 255
                targets:
                  type: array
                  minItems: 1
                  maxItems: 4
                  items:
                    enum:
                      - code
                      - dependencies
                      - sbom
                      - secrets
                    type: string
                scan_mode:
                  enum:
                    - map
                    - deep
                  type: string
                spend_limit_cents:
                  type: integer
                  minimum: 1000
                  maximum: 100000000
                allow_cap_overage:
                  type: boolean
                paid_usage_confirmation:
                  type: object
                  properties:
                    estimateCents:
                      type: integer
                      minimum: 0
                    creditCents:
                      type: integer
                      minimum: 0
                  required:
                    - estimateCents
                    - creditCents
                  additionalProperties: false
              required:
                - repository_ids
                - targets
                - scan_mode
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        repo:
                          type: string
                        status:
                          enum:
                            - triggered
                            - skipped
                            - blocked
                            - not_found
                            - failed
                          type: string
                        triggered:
                          type: array
                          items:
                            type: string
                        skipped:
                          type: array
                          items:
                            type: string
                        blocked:
                          type: array
                          items:
                            type: string
                        failed:
                          type: array
                          items:
                            type: string
                        blockedReason:
                          type: string
                        blockedRetryAfterSeconds:
                          type: number
                        message:
                          type: string
                      required:
                        - repo
                        - status
                        - triggered
                        - skipped
                        - blocked
                        - failed
                  triggeredCount:
                    type: integer
                    minimum: 0
                  requestedRepos:
                    type: integer
                    minimum: 0
                  targets:
                    type: array
                    items:
                      type: string
                required:
                  - results
                  - triggeredCount
                  - requestedRepos
                  - targets
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Content too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        See [Authentication](/api/authentication) for the key types and where to
        create a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.