Fortify Reports API

openapi: 3.2.0
info:
  title: Fortify Reports API
  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
  version: '1.0'
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: fortify-on-demand-openapi.yml, fortify-software-security-center-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.ams.fortify.com
  description: Fortify on Demand - Americas
- url: https://api.emea.fortify.com
  description: Fortify on Demand - EMEA
- url: https://api.apac.fortify.com
  description: Fortify on Demand - APAC
- 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
tags:
- name: Reports
  description: Generate and download reports
paths:
  /api/v3/releases/{releaseId}/fpr:
    get:
      operationId: downloadReleaseFpr
      summary: Fortify Download release FPR
      description: Downloads the Fortify Project Results (FPR) file for the specified release and scan type.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/ReleaseId'
      - name: scanType
        in: query
        description: Type of scan to download FPR for
        schema:
          type: string
          enum:
          - Static
          - Dynamic
          - Mobile
          - Monitoring
          - Network
          - OpenSource
      responses:
        '200':
          description: FPR file download
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.ams.fortify.com
      description: Fortify on Demand - Americas
    - url: https://api.emea.fortify.com
      description: Fortify on Demand - EMEA
    - url: https://api.apac.fortify.com
      description: Fortify on Demand - APAC
  /reportDefinitions:
    get:
      operationId: listReportDefinitions
      summary: Fortify List report definitions
      description: Retrieves the list of available report definitions that can be used to generate reports.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/Start'
      - $ref: '#/components/parameters/PageLimit'
      - $ref: '#/components/parameters/Q'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Successful response with report definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDefinitionListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      security:
      - fortifyToken: []
    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
components:
  responses:
    NotFound:
      description: Not found - the specified resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized - authentication required or token expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden - insufficient permissions or scopes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized_2:
      description: Unauthorized - authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
  schemas:
    ErrorResponse:
      type: object
      description: Error response
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              errorCode:
                type: integer
                format: int32
              message:
                type: string
    ErrorResponse_2:
      type: object
      description: Error response
      properties:
        errorCode:
          type: integer
          format: int32
        message:
          type: string
        data:
          type: object
    ReportDefinition:
      type: object
      description: A report definition template
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier
        name:
          type: string
          description: Report name
        templateDocId:
          type: integer
          format: int64
          description: Template document identifier
        type:
          type: string
          description: Report type
          enum:
          - ISSUE
          - PROJECT
          - PORTFOLIO
        parameters:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              identifier:
                type: string
    ReportDefinitionListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportDefinition'
        count:
          type: integer
          format: int32
  parameters:
    ReleaseId:
      name: releaseId
      in: path
      required: true
      description: Unique identifier of the release
      schema:
        type: integer
        format: int32
    PageLimit:
      name: limit
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        format: int32
        default: 200
    Fields:
      name: fields
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
    Q:
      name: q
      in: query
      description: Search query using Fortify search syntax (e.g., name:MyApp)
      schema:
        type: string
    Start:
      name: start
      in: query
      description: Starting index for pagination (0-based)
      schema:
        type: integer
        format: int32
        default: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 Bearer token obtained from POST /oauth/token using either client_credentials or password grant type.
    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.
x-refined-from:
- fortify-on-demand-openapi.yml
- fortify-software-security-center-openapi.yml