Sonatype Security Vulnerability Overrides API

Use this REST API to retrieve security vulnerabilities that have been overridden.

OpenAPI Specification

sonatype-security-vulnerability-overrides-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Sonatype Lifecycle Public REST Advanced Search Security Vulnerability Overrides API
  version: 1.201.0-02
  description: Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.
security:
- BasicAuth: []
  BearerAuth: []
tags:
- description: Use this REST API to retrieve security vulnerabilities that have been overridden.
  name: Security Vulnerability Overrides
paths:
  /api/v2/securityOverrides:
    get:
      description: 'Use this method to retrieve security vulnerabilities that have been overridden.


        Permissions required: View IQ Elements'
      operationId: getSecurityVulnerabilityOverrides
      parameters:
      - description: Enter the CVE ID or Sonatype Vulnerability Identifier.
        in: query
        name: refId
        schema:
          type: string
      - description: Enter the component packageUrl e.g. `pkg:format/Group/ArtifactCoord@VersionCoord`
        in: query
        name: componentPurl
        schema:
          type: string
      - description: Enter the ownerId (e.g. applicationId) containing the vulnerability.
        in: query
        name: ownerId
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSecurityVulnerabilityOverrideResponseDTOV2'
          description: The response contains security overrides and affected components.
      tags:
      - Security Vulnerability Overrides
components:
  schemas:
    ApiSecurityVulnerabilityOverrideResponseDTOV2:
      properties:
        securityOverrides:
          items:
            $ref: '#/components/schemas/ApiSecurityVulnerabilityOverrideDTOV2'
          type: array
      type: object
    ApiComponentDTOV2:
      properties:
        componentIdentifier:
          $ref: '#/components/schemas/ApiComponentIdentifierDTOV2'
        displayName:
          type: string
        hash:
          nullable: true
          type: string
        originalPurl:
          type: string
        packageUrl:
          type: string
        proprietary:
          type: boolean
        sha256:
          type: string
        thirdParty:
          type: boolean
      type: object
    ApiComponentIdentifierDTOV2:
      properties:
        coordinates:
          additionalProperties:
            type: string
          type: object
        format:
          type: string
      type: object
    ApiOwnerDTO:
      properties:
        ownerId:
          type: string
        ownerName:
          type: string
        ownerPublicId:
          type: string
        ownerType:
          type: string
      type: object
    ApiSecurityVulnerabilityOverrideDTOV2:
      properties:
        comment:
          type: string
        currentlyAffectedComponents:
          items:
            $ref: '#/components/schemas/ApiComponentDTOV2'
          type: array
        hash:
          type: string
        owner:
          $ref: '#/components/schemas/ApiOwnerDTO'
        referenceId:
          type: string
        securityOverrideId:
          type: string
        status:
          type: string
      type: object
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http