Skip to main content
GET
/
api
/
orca
/
alert-groups
/
{groupId}
cURL
curl -X GET "https://app.cotool.ai/api/orca/alert-groups/:groupId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
{
  "groupId": "<string>",
  "title": "<string>",
  "description": "<string>",
  "executionPlan": [
    "<string>"
  ],
  "alertIds": [
    "<string>"
  ],
  "alertCount": 123,
  "codeRepoUrl": "<string>",
  "serviceRequiringFix": "<string>",
  "inventoryTypes": [
    "<string>"
  ],
  "relevanceScore": 123
}

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.

Authorizations

​
Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

​
groupId
string
required

The ID of the alert group to retrieve

Response

200 - application/json

Successful response

​
groupId
string
required

Unique identifier for the alert group

​
title
string
required

Title of the alert group

​
description
string
required

Description of the alert group

​
executionPlan
string[]
required

Array of specific steps for how to fix the issue. Each item should be a complete sentence describing a concrete action.

​
severity
enum<string>
required

Severity level of the alert

Available options:
low,
medium,
high,
critical
​
easeOfFix
enum<string>
required

Ease of fixing the issue (s=small, m=medium, l=large, xl=extra large)

Available options:
s,
m,
l,
xl
​
alertIds
string[]
required

Array of alert IDs in this group

​
alertCount
number
required

Number of alerts in this group

​
codeRepoUrl
string | null
required

Code repository url that contains the vulnerable code

​
serviceRequiringFix
string | null
required

Service that requires a fix

​
inventoryTypes
string[]
required

Array of inventory types associated with this alert group

​
relevanceScore
number
required

Calculated relevance score (severity weight × alert count)