Edit

Share via

Alert interface

  • Reference
Package:
azure-devops-extension-api

Properties

alertId

Identifier for the alert. It is unqiue within Azure DevOps organization.
alertType

Type of the alert. E.g. secret, code, etc.
confidence

Confidence level of the alert.
dismissal

Contains information for the dismissal of the alert if the alert has been dismissed.
firstSeenDate

This value is computed and returned by the service. This value represents the first time the service has seen this issue reported in an analysis instance.
fixedDate

This value is computed and returned by the service. If the issue is fixed, this value represents the time the service has seen this issue fixed in an analysis instance.
gitRef

Reference to a git object, e.g. branch ref.
introducedDate

This value is computed and returned by the service. This value represents the first time the vulnerability was introduced.
lastSeenDate

This value is computed and returned by the service. This value represents the last time the service has seen this issue reported in an analysis instance.
logicalLocations

Logical locations for the alert. This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a logical location is a component.
physicalLocations

This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a physical location is a file location.
relations

Relations between alerts and other artifacts.
repositoryUrl

Repository URL where the alert was detected.
severity

Severity of the alert.
state

This value is computed and returned by the service. It is a value based on the results from all analysis configurations.
title

Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 256.
tools

Tools that have detected this issue.
truncatedSecret

A truncated/obfuscated version of the secret pertaining to the alert (if applicable).
validationFingerprints

ValidationFingerprints for the secret liveness check. Only returned on demand in Get API with Expand parameter set to be ValidationFingerprint (not returned in List API)

Property Details

alertId

Identifier for the alert. It is unqiue within Azure DevOps organization.

alertId: number

Property Value

number

alertType

Type of the alert. E.g. secret, code, etc.

alertType: AlertType

Property Value

AlertType

confidence

Confidence level of the alert.

confidence: Confidence

Property Value

Confidence

dismissal

Contains information for the dismissal of the alert if the alert has been dismissed.

dismissal: Dismissal

Property Value

Dismissal

firstSeenDate

This value is computed and returned by the service. This value represents the first time the service has seen this issue reported in an analysis instance.

firstSeenDate: Date

Property Value

Date

fixedDate

This value is computed and returned by the service. If the issue is fixed, this value represents the time the service has seen this issue fixed in an analysis instance.

fixedDate: Date

Property Value

Date

gitRef

Reference to a git object, e.g. branch ref.

gitRef: string

Property Value

string

introducedDate

This value is computed and returned by the service. This value represents the first time the vulnerability was introduced.

introducedDate: Date

Property Value

Date

lastSeenDate

This value is computed and returned by the service. This value represents the last time the service has seen this issue reported in an analysis instance.

lastSeenDate: Date

Property Value

Date

logicalLocations

Logical locations for the alert. This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a logical location is a component.

logicalLocations: LogicalLocation[]

Property Value

LogicalLocation[]

physicalLocations

This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a physical location is a file location.

physicalLocations: PhysicalLocation[]

Property Value

PhysicalLocation[]

relations

Relations between alerts and other artifacts.

relations: RelationMetadata[]

Property Value

RelationMetadata[]

repositoryUrl

Repository URL where the alert was detected.

repositoryUrl: string

Property Value

string

severity

Severity of the alert.

severity: Severity

Property Value

Severity

state

This value is computed and returned by the service. It is a value based on the results from all analysis configurations.

state: State

Property Value

State

title

Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 256.

title: string

Property Value

string

tools

Tools that have detected this issue.

tools: Tool[]

Property Value

Tool[]

truncatedSecret

A truncated/obfuscated version of the secret pertaining to the alert (if applicable).

truncatedSecret: string

Property Value

string

validationFingerprints

ValidationFingerprints for the secret liveness check. Only returned on demand in Get API with Expand parameter set to be ValidationFingerprint (not returned in List API)

validationFingerprints: ValidationFingerprint[]

Property Value

ValidationFingerprint[]