> ## 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. ## OpenAPI ````yaml /openapi.json post /v1/security/scans openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] 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 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 maximum: 9007199254740991 creditCents: type: integer minimum: 0 maximum: 9007199254740991 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 maximum: 9007199254740991 requestedRepos: type: integer minimum: 0 maximum: 9007199254740991 targets: type: array items: type: string required: - results - triggeredCount - requestedRepos - targets '400': description: '400' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: '401' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: '403' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: '404' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: '409' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: '412' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: '413' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: '429' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: '500' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: '503' 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 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-coderabbitai-api-key description: >- API key for authentication. You can create an API key from the CodeRabbit dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.