Jump to Content
FOSSA - Guides & Documentation
DocumentationAPI Reference
OPEN FOSSA APPFOSSA - Guides & Documentation
Documentation
OPEN FOSSA APP
DocumentationAPI Reference

Welcome

  • Introduction
  • Setup
    • Get started with Quick Import
    • Get started with CLI
    • Import SBOMs
    • Import Binaries
    • Import Containers
    • Import On-Prem VCS
    • CLI Cheat Sheet
    • CLI Considerations
    • When to use CLI or Quick Import
  • Organizing within FOSSA
    • Teams
    • Release Groups
  • Supported Languages
    • Clojure
    • Dart
    • Elixir
    • Erlang
    • Fortran
    • Go (Golang)
    • Haskell
    • iOS (Objective-C, Swift)
    • JavaScript
    • Java / Scala
    • .NET (C#, F# VB)
    • PHP
    • Perl
    • Python
    • Ruby
    • Rust
    • Git Submodules
    • Binaries, Archives or Custom (vendored code, etc...)
    • Code Snippets
    • C/C++
    • Buildroot
    • FOSSA Manual Dependency types explained
  • Using FOSSA Compliance
    • Create Licensing Policy
    • Customizing Policies
      • Configuring Conditional Policy Rules
      • Configuring Default Policy Rules
    • Reviewing Licensing Issues
    • Generating Attributions
    • Dependencies
    • Unknown and Failed Dependencies
    • Editing a Dependency
  • Using FOSSA Security
    • Creating a security policy
    • Reviewing security issues
    • Prioritizing reachable vulnerabilities
    • Vulnerability detection in SBOM via CPE
    • Remediation Guidance
  • Using FOSSA Quality
    • Create Quality Policies
    • Reviewing Quality Issues
    • Package Management
  • Using FOSSA SBOM Management
    • Generating SBOMs
    • SBOM Portal and Distribution
    • SBOM Policy
  • API Reference
    • Introduction to the FOSSA API
    • Authentication
    • Errors
    • Issues API
    • API Documentation
    • Deprecated Issues V1 Endpoints
    • API Usage Examples
      • Creating Jira tickets
      • Download Project Attribution Reports API Guide
      • Modifying release groups
      • Retrieving latest revision
      • Best practices for rotating FOSSA access tokens
  • Getting Support
    • Generating a debug log bundle

Product Guides

  • Project Support Docs
    • Release Groups
    • Manually adding a dependency to a project
    • Declared Licenses - "0 Files Matched"
    • Fail CI/CD checks
    • Ignoring a Dependency
    • Custom License and Keyword Search
    • Using Package Labels
    • Time Based Ignore Rules
  • Issue Support Docs
    • Saving an Issues Filter
    • Security Filters - Upgrade Distance
  • Frequently Asked Questions
    • Contents Cached in FOSSA Object Storage
    • License Mis-detection
    • How to move a user from their organization into mine
    • Deleting your Account or Organization
    • My dependency's data is incorrect
    • Ignoring open source package issues

ADMINISTRATION

  • Managing Projects
    • Filtering Projects
  • Automatic Updates & Notifications
    • Modifying the Notification List via API
  • Creating Jira Tickets
  • Inviting Users
  • Organization Settings
  • Single Sign On
    • Active Directory Federation Service
    • Auth0
    • Azure AD
    • G Suite
    • LDAP
    • Okta
    • SAML Attributes
  • Teams & Roles (RBAC)
  • Audit Logs
  • Counting Contributors
  • Architectural Diagram

Integrations

  • API & Custom Integrations
  • Atlassian Jira
  • AWS CodeBuild
  • Azure Repos
  • Bitbucket Server (Stash)
  • CircleCI
  • Concourse-CI
  • Generic CI
  • GitHub
  • GitLab
  • Jenkins
  • JFrog Artifactory
  • Nexus
  • Slack
  • TravisCI
  • TeamCity

On-Premises Deployments

  • Installing On Premises
    • Preparing your installation
    • Setting up Helm
    • Configuring FOSSA's Helm values
    • Using managed external hosting for external services
    • Installing and verifying FOSSA
    • Customizing FOSSA to your needs
    • Updating Helm values
    • advanced.values.yaml
    • simplified.self-hosted.values.yaml
    • simplified.values.yaml
  • Maintaining On Premises
    • Upgrading FOSSA
    • Global License Corrections
    • Postgres 17 Upgrade
  • Debugging On Premises
  • Architectural Overview
  • On-Prem Vulnerability Database
  • IP Space Allowlisting
  • Helm Chart Changelog
    • Helm Chart 2.14.x
    • Helm Chart 2.13.x

Past Security Incidents

  • [2022-11] API Token Privilege Escalation

Legal

  • Terms of Service
  • Privacy Policy
  • Security & Compliance Policy
  • Responsible Disclosure Policy
  • DMCA Notice
  • Acceptable Use Policy
  • Enterprise Terms of Service
Powered by 

API Reference

Suggest Edits

The FOSSA API is a RESTful API that accepts form-encoded request bodies, returns responses in JSON, and uses standard HTTP response codes, authentication, and verbs.

Enterprise API

Other guides:

Introduction to the FOSSA API

Authentication

Errors

Issues v2 API

API Documentation

Deprecated Issues V1 Endpoints

Updated 10 months ago