jira.js
    Preparing search index...

    Function submitVulnerabilities

    • Update / Insert Vulnerability data.

      Vulnerabilities are identified by their ID, any existing Vulnerability data with the same ID will be replaced if it exists and the updateSequenceNumber of the existing data is less than the incoming data.

      Submissions are performed asynchronously. Most updates are available within a short period of time but may take some time during peak load and/or maintenance times. The GET vulnerability endpoint can be used to confirm that data has been stored successfully (if needed).

      In the case of multiple Vulnerabilities being submitted in one request, each is validated individually prior to submission. Details of Vulnerabilities that failed submission (if any) are available in the response object.

      A maximum of 1000 vulnerabilities can be submitted in one request.

      Parameters

      • client: Client
      • parameters: {
            operationType?: string & {} | "NORMAL" | "BACKFILL" | "SCAN";
            properties?: Record<string, any>;
            providerMetadata?: { product?: string };
            vulnerabilities: {
                addAssociations?: {
                    associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                    values: string[];
                    [key: string]: unknown;
                }[];
                additionalInfo?: { content: string; url?: string };
                associationsLastUpdated?: string | Date;
                associationsUpdateSequenceNumber?: number;
                containerId: string;
                description: string;
                displayName: string;
                id: string;
                identifiers?: { displayName: string; url: string }[];
                introducedDate: string | Date;
                lastUpdated: string | Date;
                removeAssociations?: {
                    associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                    values: string[];
                    [key: string]: unknown;
                }[];
                schemaVersion: string & {}
                | "1.0";
                severity: {
                    level:
                        | "high"
                        | "low"
                        | "medium"
                        | "unknown"
                        | string & {}
                        | "critical";
                };
                status: "unknown"
                | "closed"
                | "open"
                | string & {}
                | "ignored";
                type: "unknown" | string & {} | "sca" | "sast" | "dast";
                updateSequenceNumber: number;
                url: string;
            }[];
        }
        • OptionaloperationType?: string & {} | "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

        • Optionalproperties?: Record<string, any>

          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 '_'.

        • OptionalproviderMetadata?: { product?: string }

          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

          • Optionalproduct?: string

            An optional name of the source of the vulnerabilities.

        • vulnerabilities: {
              addAssociations?: {
                  associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              additionalInfo?: { content: string; url?: string };
              associationsLastUpdated?: string | Date;
              associationsUpdateSequenceNumber?: number;
              containerId: string;
              description: string;
              displayName: string;
              id: string;
              identifiers?: { displayName: string; url: string }[];
              introducedDate: string | Date;
              lastUpdated: string | Date;
              removeAssociations?: {
                  associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              schemaVersion: string & {}
              | "1.0";
              severity: {
                  level: "high" | "low" | "medium" | "unknown" | string & {} | "critical";
              };
              status: "unknown"
              | "closed"
              | "open"
              | string & {}
              | "ignored";
              type: "unknown" | string & {} | "sca" | "sast" | "dast";
              updateSequenceNumber: number;
              url: string;
          }[]
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              acceptedVulnerabilities?: string[];
              failedVulnerabilities?: Record<string, any>;
              unknownAssociations?: {
                  associationType: string & {} | "issueKeys" | "issueIdOrKeys";
                  values: string[];
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility