Class AlertApi

Hierarchy (View Summary)

ClientApiBase
- AlertApi

Implements

IAlertApi

Index

Constructors

constructor

new AlertApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): AlertApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns AlertApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:33

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IAlertApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IAlertApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IAlertApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getAlert

getAlert(
    project: string,
    alertId: number,
    repository: string,
    ref?: string,
    expand?: ExpandOption,
): Promise<Alert>
Get an alert.
Parameters
- project: string
  Project ID or project name
- alertId: number
  ID of alert to retrieve
- repository: string
  Name or id of a repository that alert is part of
- Optionalref: string
- Optionalexpand: ExpandOption
  Expand alert attributes. Possible options are {ValidationFingerprint, None}
Returns Promise<Alert>
Implementation of IAlertApi.getAlert
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:46

getAlertInstances

getAlertInstances(
    project: string,
    alertId: number,
    repository: string,
    ref?: string,
): Promise<AlertAnalysisInstance[]>
Get instances of an alert.
Parameters
- project: string
  Project ID or project name
- alertId: number
  ID of alert to retrieve
- repository: string
  Name or id of a repository that alert is part of
- Optionalref: string
Returns Promise<AlertAnalysisInstance[]>
Implementation of IAlertApi.getAlertInstances
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:268

getAlerts

getAlerts(
    project: string,
    repository: string,
    top?: number,
    orderBy?: string,
    criteria?: SearchCriteria,
    continuationToken?: string,
): Promise<PagedList<Alert>>
Get alerts for a repository
Parameters
- project: string
  Project ID or project name
- repository: string
  The name or ID of the repository
- Optionaltop: number
  The maximum number of alerts to return
- OptionalorderBy: string
  Must be "id" "firstSeen" "lastSeen" "fixedOn" or "severity" Defaults to "id"
- Optionalcriteria: SearchCriteria
  Options to limit the alerts returned
- OptionalcontinuationToken: string
  If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header. Use that token here to get the next page of alerts
Returns Promise<PagedList<Alert>>
Implementation of IAlertApi.getAlerts
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:104

getAlertSarif

getAlertSarif(
    project: string,
    alertId: number,
    repository: string,
    ref?: string,
    expand?: ExpandOption,
): Promise<string>
Get an alert.
Parameters
- project: string
  Project ID or project name
- alertId: number
  ID of alert to retrieve
- repository: string
  Name or id of a repository that alert is part of
- Optionalref: string
- Optionalexpand: ExpandOption
  Expand alert attributes. Possible options are {ValidationFingerprint, None}
Returns Promise<string>
Implementation of IAlertApi.getAlertSarif
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:163

getSarif

getSarif(sarifId: number): Promise<SarifUploadStatus>
Get the status of the Sarif processing job
Parameters
- sarifId: number
  Sarif ID returned when the Sarif was uploaded
Returns Promise<SarifUploadStatus>
Implementation of IAlertApi.getSarif
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:468

getUxFilters

getUxFilters(
    project: string,
    repository: string,
    alertType: AlertType,
): Promise<UxFilters>
Parameters
- project: string
  Project ID or project name
- repository: string
- alertType: AlertType
Returns Promise<UxFilters>
Implementation of IAlertApi.getUxFilters
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:416

updateAlert

updateAlert(
    stateUpdate: AlertStateUpdate,
    project: string,
    alertId: number,
    repository: string,
): Promise<Alert>
Update the status of an alert
Parameters
- stateUpdate: AlertStateUpdate
  The new status of the alert
- project: string
  Project ID or project name
- alertId: number
  The ID of the alert
- repository: string
  The name or ID of the repository
Returns Promise<Alert>
Implementation of IAlertApi.updateAlert
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:219

updateAlertsMetadata

updateAlertsMetadata(
    alertsMetadata: AlertMetadata[],
    project: string,
    repository: string,
): Promise<AlertMetadataChange[]>
Update alert metadata associations.
Parameters
- alertsMetadata: AlertMetadata[]
  A list of metadata to associate with alerts.
- project: string
  Project ID or project name
- repository: string
  The name or ID of the repository.
Returns Promise<AlertMetadataChange[]>
Implementation of IAlertApi.updateAlertsMetadata
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:321

uploadSarif

uploadSarif(
    customHeaders: any,
    contentStream: ReadableStream,
    project: string,
    repository: string,
): Promise<number>
Upload a Sarif containing security alerts
Parameters
- customHeaders: any
- contentStream: ReadableStream
  Content to upload
- project: string
  Project ID or project name
- repository: string
  The name or ID of a repository
Returns Promise<number>
Implementation of IAlertApi.uploadSarif
- Defined in repos/azure-devops-node-api/api/AlertApi.ts:367

Class AlertApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AlertApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createRequestOptions

Parameters

Returns IRequestOptions

formatResponse

Parameters

Returns any

getAlert

Parameters

Returns Promise<Alert>

getAlertInstances

Parameters

Returns Promise<AlertAnalysisInstance[]>

getAlerts

Parameters

Returns Promise<PagedList<Alert>>

getAlertSarif

Parameters

Returns Promise<string>

getSarif

Parameters

Returns Promise<SarifUploadStatus>

getUxFilters

Parameters

Returns Promise<UxFilters>

updateAlert

Parameters

Returns Promise<Alert>

updateAlertsMetadata

Parameters

Returns Promise<AlertMetadataChange[]>

uploadSarif

Parameters

Returns Promise<number>

Settings

On This Page