Skip to content

Function: getVulnerabilityById() ​

ts
function getVulnerabilityById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  addAssociations?: object[];
  additionalInfo?: {
   [key: string]: unknown;
     content: string;
     url?: string;
  };
  associationsLastUpdated?: Date;
  associationsUpdateSequenceNumber?: number;
  containerId: string;
  description: string;
  displayName: string;
  id: string;
  identifiers?: object[];
  introducedDate: Date;
  lastUpdated: Date;
  removeAssociations?: object[];
  schemaVersion: string & object | "1.0";
  severity: {
   [key: string]: unknown;
     level: "high" | "low" | "medium" | "unknown" | string & object | "critical";
  };
  status: "unknown" | "closed" | "open" | string & object | "ignored";
  type: "unknown" | string & object | "sca" | "sast" | "dast";
  updateSequenceNumber: number;
  url: string;
}>;

Defined in: src/agile/api/securityInformation.ts:165

Retrieve the currently stored Vulnerability data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ vulnerabilityId: string; }-
parameters.vulnerabilityIdstringThe ID of the Vulnerability to fetch.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; addAssociations?: object[]; additionalInfo?: { [key: string]: unknown; content: string; url?: string; }; associationsLastUpdated?: Date; associationsUpdateSequenceNumber?: number; containerId: string; description: string; displayName: string; id: string; identifiers?: object[]; introducedDate: Date; lastUpdated: Date; removeAssociations?: object[]; schemaVersion: string & object | "1.0"; severity: { [key: string]: unknown; level: "high" | "low" | "medium" | "unknown" | string & object | "critical"; }; status: "unknown" | "closed" | "open" | string & object | "ignored"; type: "unknown" | string & object | "sca" | "sast" | "dast"; updateSequenceNumber: number; url: string; }>