COcotool
Alerts

List alerts

Retrieve first-class alert work items for the current organization. Archived dismissed, duplicate, and expired alerts are excluded unless a status filter is provided.

get/api/alerts

Request

  • Base URL
    https://app.cotool.ai
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of alerts to return per page

offsetinteger

Number of alerts to skip for pagination

statusstring

Comma-separated alert statuses to include

sourcestring

Comma-separated alert source names to include

severitystring

Comma-separated severities to include

assignedAgentIdstring uuid

Only include alerts assigned to this response agent

detectionstring

Alert detection filter key returned by /api/alerts/filter-options

detectionIdstring uuid

Only include alerts tied to this Cotool detection

originAgentIdstring uuid

Only include alerts created by this origin agent

originDetectionHitIdstring uuid

Only include the alert created from this detection hit

createdAfterstring date-time

Only include alerts created at or after this ISO timestamp

createdBeforestring date-time

Only include alerts created before this ISO timestamp

qstring

Free-text search over alert title, description, detection name, and origin references

sort'created' | 'severity'

Sort order. "created" (default) is newest first. "severity" is critical before high before medium before low before unrated, then newest first, applied across all matching rows before pagination.

Response

Successful response

totalCountinteger required

Total number of matching alerts for pagination

Changes

No recorded changes to this operation across all 2 revisions of this API.