Fortify

opencollection: 1.0.0
info:
  name: Fortify Software Security Center API
  version: v1
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: Fortify List projects
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projects'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: orderby
        value: ''
        type: query
        description: Sort field and direction (e.g., name for ascending, -name for descending)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of projects. Projects are the top-level organizational unit containing one or more application
      versions.
  - info:
      name: Fortify Create project
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/projects'
      body:
        type: json
        data: '{}'
    docs: Creates a new project for organizing application versions.
  - info:
      name: Fortify Get project
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projects/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific project by identifier.
  - info:
      name: Fortify Update project
      type: http
    http:
      method: PUT
      url: '{protocol}://{host}/ssc/api/v1/projects/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      body:
        type: json
        data: '{}'
    docs: Updates an existing project's properties.
  - info:
      name: Fortify Delete project
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/projects/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
    docs: Permanently deletes a project and all associated versions and data.
- info:
    name: Project Versions
    type: folder
  items:
  - info:
      name: Fortify List project versions
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: orderby
        value: ''
        type: query
        description: Sort field and direction (e.g., name for ascending, -name for descending)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of all project versions (application versions) accessible to the authenticated user.
  - info:
      name: Fortify Create project version
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/projectVersions'
      body:
        type: json
        data: '{}'
    docs: Creates a new project version. Requires committing the version after creation to activate it.
  - info:
      name: Fortify Get project version
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific project version by identifier.
  - info:
      name: Fortify Update project version
      type: http
    http:
      method: PUT
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      body:
        type: json
        data: '{}'
    docs: Updates an existing project version's properties.
  - info:
      name: Fortify Delete project version
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
    docs: Permanently deletes a project version and all associated scan data.
  - info:
      name: Fortify Perform project version action
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/action'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      body:
        type: json
        data: '{}'
    docs: Performs an action on a project version such as committing, copying state, or sending for analysis.
- info:
    name: Issues
    type: folder
  items:
  - info:
      name: Fortify List project version issues
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/issues'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: qm
        value: ''
        type: query
        description: Query mode for filtering (e.g., issues, hidden, removed, suppressed)
      - name: filter
        value: ''
        type: query
        description: Named filter to apply
      - name: filterset
        value: ''
        type: query
        description: Filter set GUID to use
      - name: groupid
        value: ''
        type: query
        description: Group identifier for issue grouping
      - name: groupingtype
        value: ''
        type: query
        description: Type of grouping to apply
      - name: orderby
        value: ''
        type: query
        description: Sort field and direction (e.g., name for ascending, -name for descending)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of vulnerability issues for the specified project version. Supports filtering using Fortify
      search syntax.
  - info:
      name: Fortify Get project version issue
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/issues/:id'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific issue within a project version.
- info:
    name: Artifacts
    type: folder
  items:
  - info:
      name: Fortify List project version artifacts
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/artifacts'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of artifacts (uploaded scan results) for the specified project version.
  - info:
      name: Fortify Upload artifact
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/artifacts'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
    docs: Uploads a scan artifact (FPR file) to the specified project version for processing.
  - info:
      name: Fortify Get artifact
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/artifacts/:id'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific artifact.
  - info:
      name: Fortify Delete artifact
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/artifacts/:id'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
    docs: Deletes a specific artifact from the project version.
- info:
    name: Attributes
    type: folder
  items:
  - info:
      name: Fortify List project version attributes
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/attributes'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves attribute values assigned to the specified project version.
  - info:
      name: Fortify Update project version attributes
      type: http
    http:
      method: PUT
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/attributes'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      body:
        type: json
        data: '{}'
    docs: Updates attribute values for the specified project version.
  - info:
      name: Fortify List attribute definitions
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/attributeDefinitions'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves the list of attribute definitions configured in the system.
  - info:
      name: Fortify Create attribute definition
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/attributeDefinitions'
      body:
        type: json
        data: '{}'
    docs: Creates a new attribute definition.
- info:
    name: Auth Entities
    type: folder
  items:
  - info:
      name: Fortify List project version auth entities
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/authEntities'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves authentication entities (users and LDAP groups) assigned to the specified project version.
  - info:
      name: Fortify Update project version auth entities
      type: http
    http:
      method: PUT
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/authEntities'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      body:
        type: json
        data: '{}'
    docs: Assigns or updates authentication entities for the specified project version.
- info:
    name: Issue Selectors
    type: folder
  items:
  - info:
      name: Fortify Get issue selector set
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/issueSelectorSet'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves the issue selector set (filter metadata) for the specified project version, providing available groupings,
      filters, and filter sets for issue queries.
- info:
    name: Custom Tags
    type: folder
  items:
  - info:
      name: Fortify List project version custom tags
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/projectVersions/:parentId/customTags'
      params:
      - name: parentId
        value: ''
        type: path
        description: Unique identifier of the parent resource
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves custom tags configured for the specified project version.
  - info:
      name: Fortify Get custom tag
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/customTags/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific custom tag.
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Fortify Create authentication token
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/tokens'
      body:
        type: json
        data: '{}'
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Creates an authentication token for API access. Supports UnifiedLoginToken, AnalysisUploadToken, AuditToken, and
      DownloadFileTransferToken types. This endpoint accepts HTTP Basic authentication.
  - info:
      name: Fortify Revoke authentication token
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/tokens/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
    docs: Revokes an existing authentication token.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Fortify List local users
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/localUsers'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of local user accounts.
  - info:
      name: Fortify Create local user
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/localUsers'
      body:
        type: json
        data: '{}'
    docs: Creates a new local user account.
  - info:
      name: Fortify Get local user
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/localUsers/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific local user.
  - info:
      name: Fortify Update local user
      type: http
    http:
      method: PUT
      url: '{protocol}://{host}/ssc/api/v1/localUsers/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      body:
        type: json
        data: '{}'
    docs: Updates an existing local user account.
  - info:
      name: Fortify Delete local user
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/localUsers/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
    docs: Permanently deletes a local user account.
- info:
    name: Reports
    type: folder
  items:
  - info:
      name: Fortify List report definitions
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/reportDefinitions'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves the list of available report definitions that can be used to generate reports.
- info:
    name: Saved Reports
    type: folder
  items:
  - info:
      name: Fortify List saved reports
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/savedReports'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a list of generated reports.
  - info:
      name: Fortify Generate report
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/savedReports'
      body:
        type: json
        data: '{}'
    docs: Schedules a report for generation based on a report definition and parameters.
  - info:
      name: Fortify Get saved report
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/savedReports/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific saved report.
  - info:
      name: Fortify Delete saved report
      type: http
    http:
      method: DELETE
      url: '{protocol}://{host}/ssc/api/v1/savedReports/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
    docs: Deletes a saved report.
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: Fortify List jobs
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/jobs'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: q
        value: ''
        type: query
        description: Search query using Fortify search syntax (e.g., name:MyApp)
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a paginated list of processing jobs (artifact processing, report generation, etc.).
  - info:
      name: Fortify Get job
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/jobs/:id'
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the resource
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves details for a specific processing job.
- info:
    name: Features
    type: folder
  items:
  - info:
      name: Fortify List features
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/features'
    docs: Retrieves a list of system features and connectivity information, useful for verifying API availability.
- info:
    name: File Tokens
    type: folder
  items:
  - info:
      name: Fortify Create file token
      type: http
    http:
      method: POST
      url: '{protocol}://{host}/ssc/api/v1/fileTokens'
      body:
        type: json
        data: '{}'
    docs: Creates a single-use file transfer token for uploading or downloading artifacts.
- info:
    name: Alert Definitions
    type: folder
  items:
  - info:
      name: Fortify List alert definitions
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/alertDefinitions'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a list of configured alert definitions.
- info:
    name: Cloud Pools
    type: folder
  items:
  - info:
      name: Fortify List cloud pools
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/cloudpools'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves a list of cloud scan worker pools.
- info:
    name: Performance Indicators
    type: folder
  items:
  - info:
      name: Fortify List performance indicators
      type: http
    http:
      method: GET
      url: '{protocol}://{host}/ssc/api/v1/performanceIndicators'
      params:
      - name: start
        value: ''
        type: query
        description: Starting index for pagination (0-based)
      - name: limit
        value: ''
        type: query
        description: Maximum number of records to return
      - name: fields
        value: ''
        type: query
        description: Comma-separated list of fields to include in the response
    docs: Retrieves performance indicator data for monitoring SSC system health.
bundled: true