Interface SubmitVulnerabilitiesRequest

SubmitVulnerabilitiesRequest

The payload used to submit (update / insert) Vulnerability data.

interface SubmitVulnerabilitiesRequest {
    operationType?: "NORMAL" | "BACKFILL" | "SCAN";
    properties?: {
        [key: string]: string;
    };
    providerMetadata?: {
        product?: string;
    } & {
        [key: string]: unknown;
    };
    vulnerabilities: unknown[];
}

Hierarchy

  • Record<string, unknown>
    • SubmitVulnerabilitiesRequest

Properties

operationType? properties? providerMetadata? vulnerabilities

Properties

OptionaloperationType

operationType?: "NORMAL" | "BACKFILL" | "SCAN"

Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during real-time, user-triggered actions (e.g. user closed or updated a vulnerability). "SCAN" - Data sent through some automated process (e.g. some periodically scheduled repository scan). "BACKFILL" - Data received while backfilling existing data (e.g. pushing historical vulnerabilities when re-connect a workspace). Default is "NORMAL". "NORMAL" traffic has higher priority but tighter rate limits, "SCAN" traffic has medium priority and looser limits, "BACKFILL" has lower priority and much looser limits

Example

SCAN

Optionalproperties

properties?: {
    [key: string]: string;
}

Properties

Properties assigned to vulnerability data that can then be used for delete / query operations.

Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.

Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.

Example

{
  "accountId": "account-234",
  "projectId": "project-123"
}

OptionalproviderMetadata

providerMetadata?: {
    product?: string;
} & {
    [key: string]: unknown;
}

ProviderMetadata

Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. Information in this property is not considered private, so it should not contain personally identifiable information

Type declaration

  • Optionalproduct?: string

    An optional name of the source of the vulnerabilities.

    Example

    Atlassian Security Platform 2.1.0

vulnerabilities

vulnerabilities: unknown[]

Settings

Member Visibility

On This Page

Properties