Fortify Issues API

openapi: 3.2.0
info:
  title: Fortify Software Security Center Issues API
  description: REST API for the on-premise Fortify Software Security Center (SSC), which provides centralized management and reporting of security assessment data across an organization's application portfolio. Enables managing projects, application versions, issues, artifacts, reports, users, and authentication tokens. The SSC REST API uses token-based authentication via the FortifyToken authorization header.
  version: v1
  contact:
    name: OpenText Fortify Support
    url: https://www.opentext.com/support
    email: fortify-support@microfocus.com
  license:
    name: Proprietary
    url: https://www.opentext.com/about/legal/website-terms-of-use
  x-logo:
    url: https://www.microfocus.com/brand/fortify-logo.png
servers:
- url: '{protocol}://{host}/ssc/api/v1'
  description: Fortify SSC Server
  variables:
    protocol:
      default: https
      enum:
      - https
      - http
    host:
      default: localhost
      description: Your SSC server hostname and optional port
security:
- fortifyToken: []
tags:
- name: Issues
  description: Access and manage vulnerability issues
paths:
  /projectVersions/{parentId}/issues:
    get:
      operationId: listProjectVersionIssues
      summary: Fortify List project version issues
      description: Retrieves a paginated list of vulnerability issues for the specified project version. Supports filtering using Fortify search syntax.
      tags:
      - Issues
      parameters:
      - $ref: '#/components/parameters/ParentId'
      - $ref: '#/components/parameters/Start'
      - $ref: '#/components/parameters/PageLimit'
      - $ref: '#/components/parameters/Q'
      - name: qm
        in: query
        description: Query mode for filtering (e.g., issues, hidden, removed, suppressed)
        schema:
          type: string
      - name: filter
        in: query
        description: Named filter to apply
        schema:
          type: string
      - name: filterset
        in: query
        description: Filter set GUID to use
        schema:
          type: string
      - name: groupid
        in: query
        description: Group identifier for issue grouping
        schema:
          type: string
      - name: groupingtype
        in: query
        description: Type of grouping to apply
        schema:
          type: string
      - $ref: '#/components/parameters/OrderBy'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Successful response with list of issues
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /projectVersions/{parentId}/issues/{id}:
    get:
      operationId: getProjectVersionIssue
      summary: Fortify Get project version issue
      description: Retrieves details for a specific issue within a project version.
      tags:
      - Issues
      parameters:
      - $ref: '#/components/parameters/ParentId'
      - $ref: '#/components/parameters/ResourceId'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Successful response with issue details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResultIssue'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: Unauthorized - authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Not found - the specified resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    Issue:
      type: object
      description: Represents a vulnerability issue
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier
        issueInstanceId:
          type: string
          description: Instance identifier
        issueName:
          type: string
          description: Name of the issue
        primaryLocation:
          type: string
          description: Primary source file location
        lineNumber:
          type: integer
          format: int32
          description: Line number of the issue
        fullFileName:
          type: string
          description: Full file path
        frilessSeverity:
          type: number
          format: float
          description: Friless severity score
        severity:
          type: number
          format: float
          description: Numeric severity score
        confidence:
          type: number
          format: float
          description: Confidence score
        kingdom:
          type: string
          description: Vulnerability kingdom
        issueStatus:
          type: string
          description: Current issue status
        removedDate:
          type: string
          format: date-time
          description: Date when the issue was removed
        foundDate:
          type: string
          format: date-time
          description: Date when the issue was first found
        hasAttachments:
          type: boolean
          description: Whether the issue has attachments
        hasCorrelatedIssues:
          type: boolean
          description: Whether the issue has correlated issues
        scanStatus:
          type: string
          description: Scan status
        engineCategory:
          type: string
          description: Engine category
        audienceSet:
          type: boolean
          description: Whether the audience is set
        reviewed:
          type: boolean
          description: Whether the issue has been reviewed
        issueState:
          type: string
          description: State of the issue
        analyzer:
          type: string
          description: Analyzer that found the issue
        primaryTag:
          type: string
          description: Primary tag value
        folderGuid:
          type: string
          description: Folder GUID
        projectVersionId:
          type: integer
          format: int64
          description: Parent project version identifier
    ApiResultIssue:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Issue'
        count:
          type: integer
          format: int32
        responseCode:
          type: integer
          format: int32
    ErrorResponse:
      type: object
      description: Error response
      properties:
        errorCode:
          type: integer
          format: int32
        message:
          type: string
        data:
          type: object
    IssueListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
        count:
          type: integer
          format: int32
  parameters:
    OrderBy:
      name: orderby
      in: query
      description: Sort field and direction (e.g., name for ascending, -name for descending)
      schema:
        type: string
    ResourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource
      schema:
        type: integer
        format: int64
    Fields:
      name: fields
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
    ParentId:
      name: parentId
      in: path
      required: true
      description: Unique identifier of the parent resource
      schema:
        type: integer
        format: int64
    Start:
      name: start
      in: query
      description: Starting index for pagination (0-based)
      schema:
        type: integer
        format: int32
        default: 0
    Q:
      name: q
      in: query
      description: Search query using Fortify search syntax (e.g., name:MyApp)
      schema:
        type: string
    PageLimit:
      name: limit
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        format: int32
        default: 200
  securitySchemes:
    fortifyToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Fortify token-based authentication. Pass as: FortifyToken <token_value>. Obtain a token via POST /api/v1/tokens with HTTP Basic credentials.'
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Only supported on the /tokens endpoint for obtaining API tokens.
externalDocs:
  description: Fortify Software Security Center Documentation
  url: https://www.microfocus.com/documentation/fortify-software-security-center/