Fortify Alert Definitions API

openapi: 3.2.0
info:
  title: Fortify Software Security Center Alert Definitions 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: Alert Definitions
  description: Manage alert definitions
paths:
  /alertDefinitions:
    get:
      operationId: listAlertDefinitions
      summary: Fortify List alert definitions
      description: Retrieves a list of configured alert definitions.
      tags:
      - Alert Definitions
      parameters:
      - $ref: '#/components/parameters/Start'
      - $ref: '#/components/parameters/PageLimit'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: Successful response with alert definitions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDefinitionListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      description: Error response
      properties:
        errorCode:
          type: integer
          format: int32
        message:
          type: string
        data:
          type: object
    AlertDefinitionListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                format: int64
              name:
                type: string
              enabled:
                type: boolean
        count:
          type: integer
          format: int32
  responses:
    Unauthorized:
      description: Unauthorized - authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    Fields:
      name: fields
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
    PageLimit:
      name: limit
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        format: int32
        default: 200
    Start:
      name: start
      in: query
      description: Starting index for pagination (0-based)
      schema:
        type: integer
        format: int32
        default: 0
  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/