v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB

Security Information

Get a Vulnerability by ID

Retrieve the currently stored Vulnerability data for the given ID.

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

get/rest/security/1.0/vulnerability/{vulnerabilityId}

Path parameters

vulnerabilityIdstring required

The ID of the Vulnerability to fetch.

Response

The Vulnerability data currently stored for the given ID.

schemaVersion'1.0' required

The VulnerabilityData schema version used for this vulnerability data.

Placeholder to support potential schema changes in the future.

idstring required

The identifier for the Vulnerability. Must be unique for a given Provider.

updateSequenceNumberinteger 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.

containerIdstring 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\\-_.~@:{}=]+)*

displayNamestring required

The human-readable name for the Vulnerability. Will be shown in the UI.

If not provided, will use the ID for display.

descriptionstring 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.

urlstring 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.

introducedDatestring date-time required

The timestamp to present to the user that shows when the Vulnerability was introduced.

Expected format is an RFC3339 formatted string.

lastUpdatedstring 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.

status'open' | 'closed' | 'ignored' | 'unknown' required

The current status of the Vulnerability.

associationsLastUpdatedstring 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.

associationsUpdateSequenceNumberinteger

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.

Example response

{
  "schemaVersion": "1.0",
  "id": "111-222-333",
  "updateSequenceNumber": 1523494301448,
  "containerId": "111-222-333",
  "displayName": "curl/libcurl3 - Buffer Override",
  "description": "## Overview\n\n\nAffected versions of this package are vulnerable to MeltLeak",
  "url": "https://example.com/project/CWE-123/summary",
  "type": "sca",
  "introducedDate": "2018-01-20T23:27:25.000Z",
  "lastUpdated": "2018-01-20T23:27:25.000Z",
  "severity": {
    "level": "critical"
  },
  "identifiers": [
    {
      "displayName": "CWE-123",
      "url": "https://cwe.mitre.org/data/definitions/123.html"
    }
  ],
  "status": "open",
  "additionalInfo": {
    "content": "More information on the vulnerability, as a string",
    "url": "https://example.com/project/CWE-123/additionalInfo"
  },
  "addAssociations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "PROJ-1234"
      ]
    }
  ],
  "removeAssociations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "PROJ-1234"
      ]
    }
  ],
  "associationsLastUpdated": "2018-01-20T23:27:25.000Z",
  "associationsUpdateSequenceNumber": 1523494301448
}