Alert

Update alert state

Updates the lifecycle state of an alert, optionally recording a comment. A dismiss reason is required when closing an alert.

patch/v1/alerts/{id}/state

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/alerts/{id}/state
  • Auth: HTTP bearer

Path parameters

idstring required

The unique alert ID

Request body

state'NEW' | 'OPEN' | 'IN_PROGRESS' | 'CLOSED'

Response

Alert state updated

assetIdstring
createdBystring
createdDatestring date-time
evaluationType'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL'
idstring
lastModifiedBystring
lastModifiedDatestring date-time
metricTypeIdstring
metricValueIdstring
observationKindstring
observerIdstring
severity'WARN' | 'CRITICAL' | 'ALERT'
state'NEW' | 'OPEN' | 'IN_PROGRESS' | 'CLOSED'
tagsstring[]
timestampstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.