Get Alerts for Device

GET 
/api/v2/alerts/device/:deviceId

Returns the most recent alerts for a specific device.

Request

Path Parameters

deviceId stringrequired

Device ID to filter alerts

Query Parameters

limit string

Maximum number of alerts to return. Defaults to 20.

activity boolean

When true, return only alerts flagged as activities.

Responses

200

Array of alert events for the device

application/json

Schema

Schema

• Array [

id stringrequired

Unique alert identifier

type stringrequired

Possible values: [discovery_new, discovery_known, delivery_started, delivery_completed, delivery_error, deploy_started, deploy_completed, deploy_error, pending_version, pending_resource, device_offline, git_sync_success, git_sync_failed, sbom_started, sbom_ready, sbom_failed, upload_started, upload_completed, upload_failed, upload_file_created, upload_file_deleted, release_created, release_published, release_archived, system]

Type of the alert event

severity stringrequired

Possible values: [critical, warning, info]

Severity level of the alert

message stringrequired

Human-readable alert message

deviceId string

Device ID associated with the alert

projectId number

Project ID associated with the alert

catalogId string

Catalog ID associated with the alert

source string

Source service that generated the alert

isActivity booleanrequired

Whether this event is a higher-level activity (true) or a regular alert (false)

metadata object

Additional metadata

createdAt stringrequired

Timestamp when the alert was created

• ]

Example (from schema)

[
  {
    "id": "string",
    "type": "discovery_new",
    "severity": "critical",
    "message": "string",
    "deviceId": "string",
    "projectId": 0,
    "catalogId": "string",
    "source": "string",
    "isActivity": true,
    "metadata": {},
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
]

Loading...