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

# List Orca alert groups

> Retrieve a list of grouped Orca Security alerts sorted by relevance score (severity weight × alert count)



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/orca/alert-groups
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    # Cotool API Documentation


    The Cotool API allows you to interact with the Cotool platform
    programmatically, enabling you to build powerful integrations and automate
    your workflows.


    ## Getting an API Key


    Follow these steps to generate your API key:


    1. **Log in** to the Cotool web interface

    2. **Navigate** to `/settings/api-keys`

    3. **Click** "Generate Key"

    4. **Copy and store** your API key securely ⚠️ *It won't be shown again*


    ## API Key Authentication


    For programmatic access and integrations, use your API key with the
    Authorization header:


    ```http

    Authorization: Bearer your_api_key_here

    ```


    ```bash

    curl -X GET "https://app.cotool.ai/api/endpoint" \
      -H "Authorization: Bearer your_api_key_here" \
      -H "Content-Type: application/json"
    ```
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/orca/alert-groups:
    get:
      tags:
        - Orca Alerts
      summary: List Orca alert groups
      description: >-
        Retrieve a list of grouped Orca Security alerts sorted by relevance
        score (severity weight × alert count)
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        groupId:
                          type: string
                          description: Unique identifier for the alert group
                        title:
                          type: string
                          description: Title of the alert group
                        description:
                          type: string
                          description: Description of the alert group
                        executionPlan:
                          type: array
                          items:
                            type: string
                          description: >-
                            Array of specific steps for how to fix the issue.
                            Each item should be a complete sentence describing a
                            concrete action.
                        severity:
                          type: string
                          enum:
                            - low
                            - medium
                            - high
                            - critical
                          description: Severity level of the alert
                        easeOfFix:
                          type: string
                          enum:
                            - s
                            - m
                            - l
                            - xl
                          description: >-
                            Ease of fixing the issue (s=small, m=medium,
                            l=large, xl=extra large)
                        alertIds:
                          type: array
                          items:
                            type: string
                          description: Array of alert IDs in this group
                        alertCount:
                          type: number
                          description: Number of alerts in this group
                        codeRepoUrl:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Code repository url that contains the vulnerable
                            code
                        serviceRequiringFix:
                          type:
                            - string
                            - 'null'
                          description: Service that requires a fix
                        inventoryTypes:
                          type: array
                          items:
                            type: string
                          description: >-
                            Array of inventory types associated with this alert
                            group
                        relevanceScore:
                          type: number
                          description: >-
                            Calculated relevance score (severity weight × alert
                            count)
                      required:
                        - groupId
                        - title
                        - description
                        - executionPlan
                        - severity
                        - easeOfFix
                        - alertIds
                        - alertCount
                        - codeRepoUrl
                        - serviceRequiringFix
                        - inventoryTypes
                        - relevanceScore
                    description: Array of alert groups sorted by relevance score
                required:
                  - groups
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: |-
            curl -X GET "https://app.cotool.ai/api/orca/alert-groups" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````