> ## 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.

# Read a dependency and its advisories

> Returns one vulnerable dependency with its package, version, ecosystem, lockfile, reachability, state, fix group status and advisories.

> [tab] CLI Tool
>
> ```bash
> coderabbit api request "/security/repositories/$REPOSITORY_ID/dependencies/$DEPENDENCY_ID"
> ```
>
> 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 `get_security_dependency` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "get_security_dependency",
>     "arguments": {
>       "repository_id": "<repository_id>",
>       "dependency_id": "<dependency_id>"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json get /v1/security/repositories/{repository_id}/dependencies/{dependency_id}
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/repositories/{repository_id}/dependencies/{dependency_id}:
    get:
      tags:
        - Security
      summary: Read a dependency and its advisories
      description: >-
        Returns one vulnerable dependency with its package, version, ecosystem,
        lockfile, reachability, state, fix group status and advisories.
      operationId: get_security_dependency
      parameters:
        - name: repository_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
        - name: dependency_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 4000
        - name: org_id
          in: query
          schema:
            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.
          allowEmptyValue: true
          allowReserved: true
        - name: org_name
          in: query
          schema:
            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.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  repoId:
                    type: string
                  repoName:
                    type: string
                  packageName:
                    type: string
                  packageVersion:
                    type: string
                  ecosystem:
                    type: string
                  lockfilePath:
                    type: string
                  maxSeverity:
                    type: string
                  advisorySeverity:
                    type: string
                  reachabilityStatus:
                    enum:
                      - reachable
                      - not_reachable
                      - unknown
                    type: string
                  affected:
                    type: boolean
                  advisoryCount:
                    type: number
                  state:
                    type: string
                  detectedAt:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  fixGroupId:
                    type: string
                  fixGroupStatus:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  fixGroupTaskId:
                    type: string
                  fixGroupPrUrl:
                    anyOf:
                      - type: string
                      - type: string
                        nullable: true
                        enum:
                          - null
                  advisories:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        vulnerabilityId:
                          type: string
                        severity:
                          type: string
                        cwe:
                          anyOf:
                            - type: string
                            - type: string
                              nullable: true
                              enum:
                                - null
                        cveIds:
                          type: array
                          items:
                            type: string
                        summary:
                          type: string
                        advisoryUrl:
                          anyOf:
                            - type: string
                            - type: string
                              nullable: true
                              enum:
                                - null
                        fixedVersion:
                          anyOf:
                            - type: string
                            - type: string
                              nullable: true
                              enum:
                                - null
                        reachability:
                          type: object
                          properties:
                            version:
                              enum:
                                - 1
                            status:
                              enum:
                                - reachable
                                - not_reachable
                                - unknown
                              type: string
                            targets:
                              type: array
                              maxItems: 100
                              items:
                                type: object
                                properties:
                                  kind:
                                    enum:
                                      - callable
                                      - type
                                      - initializer
                                      - field
                                      - macro
                                      - entrypoint
                                      - build_hook
                                      - native_symbol
                                      - resource
                                      - behavior
                                    type: string
                                  name:
                                    type: string
                                    minLength: 1
                                    maxLength: 500
                                  phase:
                                    enum:
                                      - install
                                      - build
                                      - startup
                                      - runtime
                                    type: string
                                  status:
                                    enum:
                                      - reachable
                                      - not_reachable
                                      - unknown
                                    type: string
                                  source:
                                    enum:
                                      - osv
                                      - llm
                                    type: string
                                  paths:
                                    type: array
                                    maxItems: 20
                                    items:
                                      type: object
                                      properties:
                                        explanation:
                                          type: string
                                          maxLength: 500
                                        steps:
                                          type: array
                                          maxItems: 20
                                          items:
                                            type: object
                                            properties:
                                              relation:
                                                enum:
                                                  - call
                                                  - reference
                                                  - construct
                                                  - import
                                                  - load
                                                  - inherit
                                                  - register
                                                  - reflection
                                                  - execute
                                                  - link
                                                  - configuration
                                                  - data_flow
                                                type: string
                                              source:
                                                enum:
                                                  - osv
                                                  - llm
                                                type: string
                                              label:
                                                type: string
                                                maxLength: 500
                                              path:
                                                type: string
                                                maxLength: 2000
                                              line:
                                                type: integer
                                                minimum: 0
                                                exclusiveMinimum: true
                                            required:
                                              - relation
                                              - source
                                              - label
                                      required:
                                        - explanation
                                        - steps
                                required:
                                  - kind
                                  - name
                                  - phase
                                  - status
                                  - source
                                  - paths
                            limitations:
                              type: array
                              maxItems: 20
                              items:
                                type: string
                                maxLength: 500
                          required:
                            - version
                            - status
                            - targets
                            - limitations
                        state:
                          type: string
                      required:
                        - id
                        - vulnerabilityId
                        - severity
                        - cwe
                        - cveIds
                        - summary
                        - advisoryUrl
                        - fixedVersion
                        - reachability
                        - state
                required:
                  - id
                  - repoId
                  - repoName
                  - packageName
                  - packageVersion
                  - ecosystem
                  - lockfilePath
                  - maxSeverity
                  - advisorySeverity
                  - reachabilityStatus
                  - affected
                  - advisoryCount
                  - state
                  - detectedAt
                  - fixGroupId
                  - fixGroupStatus
                  - fixGroupPrUrl
                  - advisories
        '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.