Fortify Software Vulnerabilities API

The Vulnerabilities API from Fortify Software — 20 operation(s) for vulnerabilities.

OpenAPI Specification

fortify-software-vulnerabilities-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: v3
  title: OpenText™ Core Application Security Web API Explorer ApiKeyManagement Vulnerabilities API
host: api.ams.fortify.com
schemes:
- https
tags:
- name: Vulnerabilities
paths:
  /api/v3/releases/{releaseId}/vulnerabilities:
    get:
      tags:
      - Vulnerabilities
      summary: Returns a list of vulnerabilities
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilities
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: filters
        in: query
        description: "A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: auditPendingAuditorStatus, auditPendingSuppression, checkId, closedDate, closedStatus, falsePositiveChallenge, instanceId, pci1_2, sink, source, stig6, suppressedBy, timeToFixDays"
        required: false
        type: string
      - name: orderBy
        in: query
        description: The field name to order the results by.
        required: false
        type: string
      - name: orderByDirection
        in: query
        description: The direction to order the results by. ASC and DESC are valid values.
        required: false
        type: string
      - name: fields
        in: query
        description: Comma separated list of fields to return.
        required: false
        type: string
      - name: offset
        in: query
        description: Offset of the starting record. 0 indicates the first record.
        required: false
        type: integer
        format: int32
      - name: limit
        in: query
        description: Maximum records to return. The maximum value allowed is in Tenant's 'Max Number of Vulnerabilities Records Per API Call'.
        required: false
        type: integer
        format: int32
      - name: excludeFilters
        in: query
        description: Indicates if filter data should be excluded in the return value. Value defaults to false if not specified.
        required: false
        type: boolean
      - name: includeFixed
        in: query
        description: Indicates if items that have been fixed should be included in the return value. Value defaults to false if not specified.
        required: false
        type: boolean
      - name: includeSuppressed
        in: query
        description: Indicates if items that have been suppressed should be included in the return value. Value defaults to false if not specified.
        required: false
        type: boolean
      - name: fortifyAviator
        in: query
        description: Indicates if SAST Aviator audited items should be included in the return value. Value defaults to null if not specified.
        required: false
        type: boolean
      - name: keywordSearch
        in: query
        description: Used for keyword searches
        required: false
        type: string
      - name: lastModifiedDate
        in: query
        description: Indicates the last modified date of the vulnerability. The format of the date is YYYY/MM/DD.
        required: false
        type: string
        format: date-time
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/GetVulnerabilitiesResponseVulnerabilityListItem'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/ErrorResponse'
        '400':
          description: BadRequest
          schema:
            $ref: '#/definitions/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
          schema:
            $ref: '#/definitions/ErrorResponse'
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data:
    get:
      tags:
      - Vulnerabilities
      summary: Returns all of the data for the vulnerability
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityAllData
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: includeSystemEvents
        in: query
        description: Include system events in the return data. Value defaults to false if not specified.
        required: false
        type: boolean
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityAllData'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/summary:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability summary
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilitySummary
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilitySummary'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/details:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability details
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityDetails
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityDetails'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/recommendations:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability recommendations
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityRecommendations
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityRecommendations'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/history:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability history
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityHistory
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: includeSystemEvents
        in: query
        description: Include system events in the return data. Value defaults to false if not specified.
        required: false
        type: boolean
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityHistory'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/screenshots:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability screenshots
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityScreenshots
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityScreenshot'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/screenshot/{screenshotId}:
    get:
      tags:
      - Vulnerabilities
      summary: Returns a screenshot
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetScreenshot
      consumes: []
      produces:
      - application/octet-stream
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: screenshotId
        in: path
        description: The screenshot id
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Ok
          schema:
            type: file
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/request-response:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability request and response
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityRequestResponse
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityRequestResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/headers:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability headers
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityHeaders
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityHeaders'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/parameters:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability parameters
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityParameters
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityParameters'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability traces
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityTraces
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityTrace'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces/{traceIndex}/{traceEntryIndex}/code:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the trace code for the specific index
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityTraceCode
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: traceIndex
        in: path
        description: The trace index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data
        required: true
        type: integer
        format: int32
      - name: traceEntryIndex
        in: path
        description: The trace entry index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityTraceCode'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/traces/{traceIndex}/{traceEntryIndex}/snippet:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the trace snippet for the specific index
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityTraceSnippet
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: traceIndex
        in: path
        description: The trace index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data
        required: true
        type: integer
        format: int32
      - name: traceEntryIndex
        in: path
        description: The trace entry index can be obtained by calling GET/api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/all-data
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityTraceCodeSnippet'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/audit-options:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability audit options
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityAuditOptions
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityAuditOptions'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/bulk-edit:
    post:
      tags:
      - Vulnerabilities
      summary: Saves audit data for the vulnerabilities
      description: 'Allowed Scopes: api-tenant, manage-issues'
      operationId: VulnerabilitiesV3_PostVulnerabilityEdit
      consumes:
      - application/json
      - text/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      - multipart/form-data
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: requestModel
        in: body
        description: PostVulnerabilityBulkEditRequest model
        required: true
        schema:
          $ref: '#/definitions/PostVulnerabilityBulkEditRequest'
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/PostVulnerabilityBulkEditResponse'
        '400':
          description: BadRequest
          schema:
            $ref: '#/definitions/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '422':
          description: UnprocessableEntity
          schema:
            $ref: '#/definitions/ErrorResponse'
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerability-filters:
    get:
      tags:
      - Vulnerabilities
      summary: Get available vulnerability filters
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityFilters
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: filters
        in: query
        description: "A delimited list of field filters.\r\n<br /><br />Field name and value should be separated by a colon (:).\r\n<br /><br />Multiple fields should be separated by a plus (+). Multiple fields are treated as an AND condition. Example, fieldname1:value+fieldname2:value\r\n<br /><br />Multiple values for a field should be separated by a pipe (|). Mulitple values for a field are treated as an OR condition. Example, fieldname1:value1|value2\r\n<br /><br />Filtering is not supported for the following fields: auditPendingAuditorStatus, auditPendingSuppression, checkId, closedDate, closedStatus, falsePositiveChallenge, instanceId, pci1_2, sink, source, stig6, suppressedBy, timeToFixDays"
        required: false
        type: string
      - name: fieldName
        in: query
        description: The specific field to return
        required: false
        type: string
      - name: includeFixed
        in: query
        description: Indicates if items that have been fixed should be included in the return value. Value defaults to false if not specified.
        required: false
        type: boolean
      - name: includeSuppressed
        in: query
        description: Indicates if items that have been suppressed should be included in the return value. Value defaults to false if not specified.
        required: false
        type: boolean
      - name: keywordSearch
        in: query
        description: Used for keyword searches
        required: false
        type: string
      - name: fields
        in: query
        description: Comma separated list of fields to return.
        required: false
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/FieldFilterListResponse'
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/bug-link:
    post:
      tags:
      - Vulnerabilities
      summary: Saves bug tracker url for the vulnerabilities
      description: 'Allowed Scopes: api-tenant, manage-issues'
      operationId: VulnerabilitiesV3_PostVulnerabilityBugLink
      consumes:
      - application/json
      - text/json
      - application/xml
      - text/xml
      - application/x-www-form-urlencoded
      - multipart/form-data
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: requestModel
        in: body
        description: PostVulnerabilityBugLinkRequest model
        required: true
        schema:
          $ref: '#/definitions/PostVulnerabilityBugLinkRequest'
      responses:
        '204':
          description: NoContent
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '422':
          description: UnprocessableEntity
          schema:
            $ref: '#/definitions/ErrorResponse'
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/comments:
    get:
      tags:
      - Vulnerabilities
      summary: Returns the vulnerability audit comments
      description: 'Allowed Scopes: api-tenant, view-issues'
      operationId: VulnerabilitiesV3_GetVulnerabilityAuditComments
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      - name: userName
        in: query
        description: The username to get user specific comments
        required: false
        type: string
      responses:
        '200':
          description: Ok
          schema:
            $ref: '#/definitions/VulnerabilityAuditCommentsResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
  /api/v3/releases/{releaseId}/vulnerabilities/{vulnId}/aviator-remediation-guidance:
    get:
      tags:
      - Vulnerabilities
      summary: Returns machine readable aviator remediation details in json format for each individual issue
      operationId: VulnerabilitiesV3_GetAviatorRemediationGuidanceForVulneribility
      consumes: []
      produces:
      - application/json
      - text/json
      - application/xml
      - text/xml
      parameters:
      - name: releaseId
        in: path
        description: The release id
        required: true
        type: integer
        format: int32
      - name: vulnId
        in: path
        description: Field accepts "id" or "vulnId". To obtain the vulnId or Id call GET /api/v3/vulnerabilities. Id is also available through portal.
        required: true
        type: string
      responses:
        '200':
          description: Ok
          schema:
            type: object
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: NotFound
        '429':
          description: TooManyRequests
        '500':
          description: InternalServerError
definitions:
  PostVulnerabilityBulkEditResponse:
    description: Post Vulnerability Bulk Edit Response
    type: object
    properties:
      results:
        description: List of results
        type: array
        items:
          $ref: '#/definitions/VulnerabilityBulkUpdateResult'
      attributeerrors:
        description: Attribute validation message
        type: array
        items:
          type: string
  LookupItem:
    description: Lookup Item
    type: object
    properties:
      value:
        description: The value property
        type: string
      text:
        description: The text property
        type: string
      group:
        description: The group property
        type: string
  PostVulnerabilityBugLinkRequest:
    description: Post Vulnerability Bug Link Request
    required:
    - bugLink
    - vulnerabilityIds
    type: object
    properties:
      bugLink:
        description: The bug link
        type: string
      vulnerabilityIds:
        de

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fortify-software/refs/heads/main/openapi/fortify-software-vulnerabilities-api-openapi.yml