SOLFIND
Web Lens
Portal home

API Reference — FOSSA Docs

https://docs.fossa.com/docs/api • 145 KB fetched
Open original page


API Reference — FOSSA Docs Docs Search docs... ⌘K Docs API CLI Glossary Launch App User Guides Product Guides Get Started Project Setup Release Groups Issues Licenses Vulnerabilities Quality SBOM Policies Reports FOSSA CLI API Reference Introduction to the FOSSA API Authentication Errors Webhook Notifications CPE Lookup API Usage examples Endpoint Reference Integrations fossabot Organization Management On-Premises Deployment Help & Support Legal Get Support fossa.com On this page * Overview * What you can do with the API * Start here * Guides and reference On this page Docs API Reference API Reference Build integrations and automate workflows with the FOSSA REST API. 1 min read Updated Aug 26, 2026 Copy link Overview The FOSSA REST API lets you query and manage your FOSSA data programmatically (projects, revisions, issues, vulnerabilities, release groups, and reports) so you can automate workflows from CI/CD or custom tooling. Browse the Endpoint Reference → All guides Introduction to the FOSSA API Generate an API key and make your first request to the FOSSA REST API. Read more Authentication Authenticate to the FOSSA API using an API token in the Authorization header. Read more Errors Interpret FOSSA API error responses, 4xx codes indicate client errors, 5xx codes indicate server-side issues. Read more Webhook Notifications Automatically re-analyze FOSSA projects on a schedule or via an inbound webhook trigger. Read more CPE Lookup API Query FOSSA's vulnerability database for security metadata and CVEs by CPE string, no project scan required. Read more Endpoint Reference Browse all REST endpoints by category. Read more Usage examples Managing issues Query, filter, bulk-ignore, and manage auto-ignore rules across licensing, security, and quality issues. Read more Managing users and teams Enterprise Create users, manage team membership, and query team projects and release groups via the FOSSA API. Read more Initiating a binary scan Upload a binary or archive and start a decomposition scan through the FOSSA API, then poll for completion. Read more Generating reports Trigger org-wide reports via the API: audit/due diligence reports and global issue CSV exports. Read more Creating Jira tickets Automatically create Jira tickets from FOSSA issues without using the UI. Read more Downloading attribution reports Download project attribution (licensing) reports in TXT, HTML, Markdown, PDF, or CSV. Read more Modifying release groups Add projects to a release group and update the projects within an existing release group via the API. Read more Retrieving the latest revision Retrieve the latest revision for each branch of a project via the API. Read more Rotating access tokens Best practices for managing and rotating FOSSA access tokens securely. Read more What you can do with the API * Automate tasks in your CI/CD pipeline. * Query and manage your dependencies, projects, and revisions. * Generate custom documents and reports. * Build custom features and integrations on top of FOSSA data. Start here * Introduction : generate an API key and make your first request. * Authentication : how to authenticate and the two token types. * Errors : how to interpret API error responses. Guides and reference * Usage examples : practical recipes: managing issues, users, teams, reports, Jira tickets, and more. * Endpoint Reference : the complete, interactive endpoint catalog. © 2026 FOSSA, Inc. [email protected]

Links found on this page

  1. Docs [direct]
  2. Docs [direct]
  3. API [direct]
  4. CLI [direct]
  5. Glossary [direct]
  6. Launch App [direct]
  7. User Guides [direct]
  8. Product Guides [direct]
  9. Project Setup [direct]
  10. Release Groups [direct]
  11. Issues [direct]
  12. Licenses [direct]
  13. Vulnerabilities [direct]
  14. Quality [direct]
  15. SBOM [direct]
  16. Policies [direct]
  17. Reports [direct]
  18. Introduction to the FOSSA API [direct]
  19. Authentication [direct]
  20. Errors [direct]
  21. Webhook Notifications [direct]
  22. CPE Lookup API [direct]
  23. Usage examples [direct]
  24. Endpoint Reference [direct]
  25. Integrations [direct]
  26. fossabot [direct]
  27. Organization Management [direct]
  28. On-Premises Deployment [direct]
  29. Help & Support [direct]
  30. Legal [direct]
  31. Get Support [direct]
  32. fossa.com [direct]
  33. Managing issues Query, filter, bulk-ignore, and manage auto-ignore rules across licensing, security, and quality issues. Read more [direct]
  34. Managing users and teams Enterprise Create users, manage team membership, and query team projects and release groups via the FOSSA API. Read more [direct]
  35. Initiating a binary scan Upload a binary or archive and start a decomposition scan through the FOSSA API, then poll for completion. Read more [direct]
  36. Generating reports Trigger org-wide reports via the API: audit/due diligence reports and global issue CSV exports. Read more [direct]
  37. Creating Jira tickets Automatically create Jira tickets from FOSSA issues without using the UI. Read more [direct]
  38. Downloading attribution reports Download project attribution (licensing) reports in TXT, HTML, Markdown, PDF, or CSV. Read more [direct]
  39. Modifying release groups Add projects to a release group and update the projects within an existing release group via the API. Read more [direct]
  40. Retrieving the latest revision Retrieve the latest revision for each branch of a project via the API. Read more [direct]
  41. Rotating access tokens Best practices for managing and rotating FOSSA access tokens securely. Read more [direct]