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

# Get alert routing overview

> Return detection alert routing defaults, per-detection effective routing, alert producers, and response-agent handling summary.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/alert-routing
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/alert-routing:
    get:
      tags:
        - Alerts
      summary: Get alert routing overview
      description: >-
        Return detection alert routing defaults, per-detection effective
        routing, alert producers, and response-agent handling summary.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  defaultSettings:
                    type: object
                    properties:
                      organizationId:
                        type: string
                        format: uuid
                        description: Organization that owns these alert routing defaults
                      defaultResponseAgentId:
                        type:
                          - string
                          - 'null'
                        format: uuid
                        description: Default response agent for detection-created alerts
                      defaultResponseAgentName:
                        type:
                          - string
                          - 'null'
                        description: Display name for the configured default response agent
                      createdAt:
                        type: string
                        description: ISO timestamp when the organization row was created
                      updatedAt:
                        type: string
                        description: >-
                          ISO timestamp when the routing default was last
                          updated
                    required:
                      - organizationId
                      - defaultResponseAgentId
                      - defaultResponseAgentName
                      - createdAt
                      - updatedAt
                  responseAgents:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Response agent identifier
                        name:
                          type: string
                          minLength: 1
                          description: Response agent display name
                      required:
                        - id
                        - name
                  detections:
                    type: array
                    items:
                      type: object
                      properties:
                        detectionAgentId:
                          type: string
                          format: uuid
                          description: Detection agent identifier
                        detectionAgentName:
                          type: string
                          minLength: 1
                          description: Detection agent name
                        override:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: string
                              format: uuid
                              description: Detection alert routing override id
                            organizationId:
                              type: string
                              format: uuid
                              description: Organization that owns this override
                            detectionAgentId:
                              type: string
                              format: uuid
                              description: Detection agent this override applies to
                            responseAgentId:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              description: >-
                                Response agent override, or null to leave alerts
                                unassigned
                            responseAgentName:
                              type:
                                - string
                                - 'null'
                              description: Display name for the override response agent
                            createdAt:
                              type: string
                              description: ISO timestamp when the override was created
                            updatedAt:
                              type: string
                              description: ISO timestamp when the override was last updated
                          required:
                            - id
                            - organizationId
                            - detectionAgentId
                            - responseAgentId
                            - responseAgentName
                            - createdAt
                            - updatedAt
                          description: Per-detection override, if configured
                        effective:
                          type: object
                          properties:
                            detectionAgentId:
                              type: string
                              format: uuid
                              description: >-
                                Detection agent this effective routing applies
                                to
                            responseAgentId:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              description: >-
                                Response agent that will handle new alerts, if
                                configured
                            responseAgentName:
                              type:
                                - string
                                - 'null'
                              description: Display name for the effective response agent
                            source:
                              type: string
                              enum:
                                - detection_override
                                - organization_default
                              description: >-
                                Whether the effective setting comes from an
                                override or organization default
                            inheritedDefaultResponseAgentId:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              description: >-
                                Organization default response agent id used for
                                inheritance
                            inheritedDefaultResponseAgentName:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Organization default response agent name used
                                for inheritance
                          required:
                            - detectionAgentId
                            - responseAgentId
                            - responseAgentName
                            - source
                            - inheritedDefaultResponseAgentId
                            - inheritedDefaultResponseAgentName
                          description: Effective alert routing for this detection
                        alertCount30d:
                          type: integer
                          minimum: 0
                          description: Detection-created alert count over the last 30 days
                        openUnassignedCount:
                          type: integer
                          minimum: 0
                          description: Open unassigned alerts for this detection
                      required:
                        - detectionAgentId
                        - detectionAgentName
                        - override
                        - effective
                        - alertCount30d
                        - openUnassignedCount
                  triggers:
                    type: array
                    items:
                      type: object
                      properties:
                        triggerId:
                          type: string
                          format: uuid
                          description: Trigger identifier
                        triggerName:
                          type: string
                          minLength: 1
                          description: Trigger name
                        triggerSource:
                          type: string
                          enum:
                            - jira
                            - jira-automation
                            - slack
                            - linear
                            - cron
                            - webhook
                            - email
                            - bugcrowd
                            - hackerone
                          description: Trigger source
                        responseAgentId:
                          type: string
                          format: uuid
                          description: Owning response agent id
                        responseAgentName:
                          type: string
                          minLength: 1
                          description: Owning response agent name
                        createAlert:
                          type: boolean
                          description: Whether this trigger currently creates alerts
                        alertCount30d:
                          type: integer
                          minimum: 0
                          description: Trigger-created alert count over the last 30 days
                      required:
                        - triggerId
                        - triggerName
                        - triggerSource
                        - responseAgentId
                        - responseAgentName
                        - createAlert
                        - alertCount30d
                  responseAgentSummaries:
                    type: array
                    items:
                      type: object
                      properties:
                        responseAgentId:
                          type: string
                          format: uuid
                          description: Response agent identifier
                        responseAgentName:
                          type: string
                          minLength: 1
                          description: Response agent name
                        activeAssignedAlertCount:
                          type: integer
                          minimum: 0
                          description: >-
                            Active alerts currently assigned to this response
                            agent
                        alertCount30d:
                          type: integer
                          minimum: 0
                          description: >-
                            Alerts assigned to this response agent over the last
                            30 days
                        lastTriageRunAt:
                          type:
                            - string
                            - 'null'
                          description: >-
                            ISO timestamp of the most recent triage run for this
                            agent
                        sourceNames:
                          type: array
                          items:
                            type: string
                            enum:
                              - cotool_detection
                              - hunting
                              - jira
                              - jira-automation
                              - slack
                              - linear
                              - cron
                              - webhook
                              - email
                              - bugcrowd
                              - hackerone
                            description: >-
                              Filter-oriented alert source name. Trigger-created
                              alerts use the trigger type.
                          description: >-
                            Alert source names recently handled by this response
                            agent
                      required:
                        - responseAgentId
                        - responseAgentName
                        - activeAssignedAlertCount
                        - alertCount30d
                        - lastTriageRunAt
                        - sourceNames
                required:
                  - defaultSettings
                  - responseAgents
                  - detections
                  - triggers
                  - responseAgentSummaries
        '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/alert-routing" \
              -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`

````