--- title: "Get a Vulnerability by ID" method: GET path: "/rest/security/1.0/vulnerability/{vulnerabilityId}" tags: ["Security Information"] --- # Get a Vulnerability by ID `GET /rest/security/1.0/vulnerability/{vulnerabilityId}` Retrieve the currently stored Vulnerability data for the given ID. The result will be what is currently stored, ignoring any pending updates or deletes. ## Path parameters - `vulnerabilityId` string, required ## Response `200` The Vulnerability data currently stored for the given ID. - object — Data related to a specific vulnerability in a specific workspace that the vulnerability is present in. Must specify at least one association. - `schemaVersion` '1.0', required — The VulnerabilityData schema version used for this vulnerability data. Placeholder to support potential schema changes in the future. - `id` string, required — The identifier for the Vulnerability. Must be unique for a given Provider. - `updateSequenceNumber` integer, required — An ID used to apply an ordering to updates for this Vulnerability in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Vulnerability and increment that on each update to Jira). Updates for a Vulnerability that are received with an updateSequenceId lower than what is currently stored will be ignored. - `containerId` string, required — The identifier of the Container where this Vulnerability was found. Must be unique for a given Provider. This must follow this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*` - `displayName` string, required — The human-readable name for the Vulnerability. Will be shown in the UI. If not provided, will use the ID for display. - `description` string, required — A description of the issue in markdown format that will be shown in the UI and used when creating Jira Issues. HTML tags are not supported in the markdown format. For creating a new line `\n` can be used. Read more about the accepted markdown transformations [here](https://atlaskit.atlassian.com/packages/editor/editor-markdown-transformer). - `url` string, uri, required — A URL users can use to link to a summary view of this vulnerability, if appropriate. This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the vulnerability in that project). - `type` 'sca' | 'sast' | 'dast' | 'unknown', required — The type of Vulnerability detected. - `introducedDate` string, date-time, required — The timestamp to present to the user that shows when the Vulnerability was introduced. Expected format is an RFC3339 formatted string. - `lastUpdated` string, date-time, required — The last-updated timestamp to present to the user the last time the Vulnerability was updated. Expected format is an RFC3339 formatted string. - `severity` object, required — Severity information for a single Vulnerability. This is the severity information that will be presented to the user on e.g. the Jira Security screen. - `level` 'critical' | 'high' | 'medium' | 'low' | 'unknown', required — The severity level of the Vulnerability. - `identifiers` object[] — The identifying information for the Vulnerability. - `displayName` string, required — The display name of the Vulnerability identified. - `url` string, uri, required — A URL users can use to link to the definition of the Vulnerability identified. - `status` 'open' | 'closed' | 'ignored' | 'unknown', required — The current status of the Vulnerability. - `additionalInfo` object — Extra information (optional). This data will be shown in the security feature under the vulnerability displayName. - `content` string, required — The content of the additionalInfo. - `url` string, uri — Optional URL linking to the information - `addAssociations` object[] — The associations (e.g. Jira issue) to add in addition to the currently stored associations of the Security Vulnerability. - `associationType` 'issueIdOrKeys', required — Defines the association type. - `values` string[], required — The Jira issue id or keys to associate the Security information with. The number of values counted across all associationTypes (issueIdOrKeys) must not exceed a limit of 500. - `removeAssociations` object[] — The associations (e.g. Jira issue) to remove from currently stored associations of the Security Vulnerability. - `associationType` 'issueIdOrKeys', required — Defines the association type. - `values` string[], required — The Jira issue id or keys to associate the Security information with. The number of values counted across all associationTypes (issueIdOrKeys) must not exceed a limit of 500. - `associationsLastUpdated` string, date-time — An ISO-8601 Date-time string representing the last time the provider updated associations on this entity. Expected format is an RFC3339 formatted string. - `associationsUpdateSequenceNumber` integer — A sequence number to compare when writing entity associations to the database. This can be any monotonically increasing number. A highly recommended implementation is to use epoch millis. This is an optional field. If it is not provided it will default to being equal to the corresponding entity's `updateSequenceNumber`. Associations are written following a LastWriteWins strategy, association that are received with an associationsUpdateSequenceNumber lower than what is currently stored will be ignored. ## Other responses - `401` — Missing a JWT token, or token is invalid. - `403` — The app does not define a security info provider module, or does not have the required scope to access this resource. - `404` — No data found for the given Vulnerability ID. - `429` — API rate limit has been exceeded. - `503` — Service is unavailable due to maintenance or other reasons. - `default` — An unknown error has occurred. --- [API](https://skmtc.net/atlassian/apis/jira-software-cloud-api.md) · [All operations](https://skmtc.net/atlassian/apis/jira-software-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jira-software-cloud-api/revisions/4e108d54b990/schema)