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

Welcome

  • Introduction
  • Setup
    • Get started with Quick Import
    • Get started with CLI
    • Import SBOMs
    • Import Containers
    • Import On-Prem VCS
  • 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++
  • Using FOSSA Compliance
    • Create Licensing Policy
    • Reviewing Licensing Issues
    • Generating Attributions
    • Dependencies
    • Editing a Dependency
  • Using FOSSA Security
    • Configuring a Security Policy
    • Reviewing Security Issues
  • Customizing Policies
    • Configuring Conditional Policy Rules
    • Configuring Default Policy Rules
  • API Reference
    • Authentication
    • Errors
    • Issues v2 API
    • API Documentation
    • Introduction to the FOSSA API
  • API Usage Examples
    • Creating Jira tickets
    • Downloading attribution reports
    • Modifying release groups
    • Retrieving latest revision
    • Rotating FOSSA API key
  • Getting Support

Product Guides

  • Project Support Docs
    • Release Groups
    • Manually adding a dependency to a project
  • Issue Support Docs
    • Saving an Issues Filter

ADMINISTRATION

  • Managing Projects
    • Projects - What's New
  • Automatic Updates & Notifications
    • Modifying the Notification List via API
  • Creating a Jira Ticket
  • Inviting Users
  • Single Sign On
    • Active Directory Federation Service
    • Auth0
    • Azure AD
    • G Suite
    • LDAP
    • Okta
    • SAML Attributes
  • Teams & Roles (RBAC)
  • Audit Logs
  • Counting Contributors

Integrations

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

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
  • Debugging On Premises
  • Architectural Overview
  • S3 Configuration
  • On-Prem Vulnerability Database
  • IP Space Whitelisting

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

API Usage Examples

Suggest Edits

In addition to the starter docs you'll find in our API Reference page, here is a list of real world usages of our APIs.

  • Creating Jira tickets
  • Downloading attribution reports
  • Modifying release groups
  • Retrieving latest revision
  • Rotating FOSSA API key

Updated about 1 month ago


What’s Next
  • FOSSA Support Utilities