Interface getFindingsParams

interface getFindingsParams {
    assetVersionId?: string;
    category?: ReportType | ReportType[];
    count?: boolean;
    findingId?: string;
    limit?: number;
    severity?:
        | "CRITICAL"
        | "HIGH"
        | "MEDIUM"
        | "LOW"
        | "INFO"
        | "UNKNOWN";
    status?: string;
}

Properties

assetVersionId? category? count? findingId? limit? severity? status?

Properties

OptionalassetVersionId

assetVersionId?: string

Asset Version ID to get findings for. If not provided, will get all findings in the organization.

Optionalcategory

category?: ReportType | ReportType[]

The category of Findings to return. Valid values are "CONFIG_ISSUES", "CREDENTIALS", "CRYPTO_MATERIAL", "CVE", "SAST_ANALYSIS". If not specified, will return all findings. See https://docs.finitestate.io/types/finding-category. This can be a single string, or an array of values.

Optionalcount

count?: boolean

If True, will return the count of findings instead of the findings themselves. Defaults to False.

OptionalfindingId

findingId?: string

The ID of a specific finding to get. If specified, will return only the finding with that ID.

Optionallimit

limit?: number

The maximum number of findings to return. By default, this is Null. Limit must be between 1 and 1000.

Optionalseverity

severity?:
    | "CRITICAL"
    | "HIGH"
    | "MEDIUM"
    | "LOW"
    | "INFO"
    | "UNKNOWN"

The severity of Findings to return. Valid values are "CRITICAL", "HIGH", "MEDIUM", "LOW", "INFO", and "UNKNOWN". If not specified, will return all findings.

Optionalstatus

status?: string

The status of Findings to return.

Settings

Member Visibility

On This Page

Properties