Sign in

v1

latestOpenAPI 3.1.02026-07-26363186558.0 KB
DTM Alerts

Update field(s) of an alert

patch/alerts/{id}

Path parameters

idstring required
Example:c4huif0mhcmiku5g7jsg

The ID of the alert.

Headers

x-apikeystring required

Your API key

Acceptstring required

The accept type for the response body.

Content-Typestring required

The content type of the request body.

Request body

status'new' | 'read' | 'closed' | 'escalated' | 'in_progress' | 'no_action_required' | 'duplicate' | 'not_relevant' | 'tracked_external'
tagsstring[]

Response

OK

namestring

Identifier. Server generated name for the alert. format is projects/{project}/alerts/{alert}

findingsstring[]

Output only. Findings that are covered by this alert.

state'STATE_UNSPECIFIED' | 'NEW' | 'READ' | 'TRIAGED' | 'ESCALATED' | 'RESOLVED' | 'DUPLICATE' | 'FALSE_POSITIVE' | 'NOT_ACTIONABLE' | 'BENIGN' | 'TRACKED_EXTERNALLY'

Output only. State of the alert.

displayNamestring

Output only. A short title for the alert.

duplicateOfstring

Output only. alert name of the alert this alert is a duplicate of. Format: projects/{project}/alerts/{alert}

duplicatedBystring[]

Output only. alert names of the alerts that are duplicates of this alert. Format: projects/{project}/alerts/{alert}

etagstring

Optional. If included when updating an alert, this should be set to the current etag of the alert. If the etags do not match, the update will be rejected and an ABORTED error will be returned.

externalIdstring

Output only. External ID for the alert. This is used internally to provide protection against out of order updates.

aiSummarystring

Optional. AI summary of the alert.

findingCountstring int64

Output only. The number of findings associated with this alert.

configurationsstring[]

Output only. The resource names of the Configurations bound to this alert. Format: projects/{project}/configurations/{configuration}