Interface SearchCriteria

interface SearchCriteria {
    alertIds?: number[];
    alertType?: AlertType;
    confidenceLevels?: Confidence[];
    dependencyName?: string;
    fromDate?: Date;
    keywords?: string;
    modifiedSince?: Date;
    onlyDefaultBranchAlerts?: boolean;
    phaseId?: string;
    phaseName?: string;
    pipelineName?: string;
    ref?: string;
    ruleId?: string;
    ruleName?: string;
    severities?: Severity[];
    states?: State[];
    toDate?: Date;
    toolName?: string;
}

Properties

alertIds? alertType? confidenceLevels? dependencyName? fromDate? keywords? modifiedSince? onlyDefaultBranchAlerts? phaseId? phaseName? pipelineName? ref? ruleId? ruleName? severities? states? toDate? toolName?

Properties

OptionalalertIds

alertIds?: number[]

If provided, only return alerts with the ids specified.
Otherwise, return any alert.

OptionalalertType

alertType?: AlertType

If provided, only return alerts of this type. Otherwise, return alerts of all types.

OptionalconfidenceLevels

confidenceLevels?: Confidence[]

If provided, only return alerts at these confidence levels.
Otherwise, return alerts at any confidence level.

OptionaldependencyName

dependencyName?: string

If provided, only alerts for this dependency are returned.
Otherwise, return alerts for all dependencies.
In a sarif submission, a dependency (or a vulnerable component) is specified in result.RelatedLocations[].logicalLocation.

OptionalfromDate

fromDate?: Date

If provided, only return alerts last seen after this date.
Otherwise return all alerts.

Optionalkeywords

keywords?: string

If provided, only return alerts whose titles match this pattern.

OptionalmodifiedSince

modifiedSince?: Date

If provided, only return alerts that were modified since this date.
Otherwise return all alerts.

OptionalonlyDefaultBranchAlerts

onlyDefaultBranchAlerts?: boolean

If true, only return alerts found on the default branch of the repository.
If there have been no runs completed on the default branch, the last run is used instead regardless of the branch used for that run.
This option is ignored if ref is provided.

OptionalphaseId

phaseId?: string

If provided with pipelineName, only return alerts detected in this pipeline phase
Otherwise, return alerts detected in all phases.

OptionalphaseName

phaseName?: string

If provided with pipelineName, only return alerts detected in this pipeline phase
Otherwise, return alerts detected in all phases.

OptionalpipelineName

pipelineName?: string

If provided, only return alerts detected in this pipeline.
Otherwise, return alerts detected in all pipelines.

Optionalref

ref?: string

If provided, only include alerts for this ref.
If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch.
Otherwise, include alerts from all branches.

OptionalruleId

ruleId?: string

If provided, only return alerts for this rule.
Otherwise, return alerts of all rules.

OptionalruleName

ruleName?: string

If provided, only return alerts for this rule.
Otherwise, return alerts for all rules.

Optionalseverities

severities?: Severity[]

If provided, only return alerts at these severities.
Otherwise, return alerts at any serverity.

Optionalstates

states?: State[]

If provided, only return alerts in these states.
Otherwise, return alerts in any state.

OptionaltoDate

toDate?: Date

If provided, only return alerts last seen before this date.
Otherwise return all alerts.

OptionaltoolName

toolName?: string

If provided with toolName, only return alerts detected by this tool.
Otherwise, return alerts detected by all tools.

Settings

Member Visibility

On This Page

Properties