Introduction to the FOSSA API

Overview

The FOSSA API is a RESTful API for programmatic access to your FOSSA data. This guide walks you from generating an API key to making your first authenticated request.

Making your first request

1. 1

   Generate an API key

   In the FOSSA dashboard, go to Account Settings → Integrations → API and create a new token. See Authentication for the difference between Push-Only and Full tokens; most API calls require a Full token.

2. 2

   Authenticate your request

   Pass your token in the Authorization header, prefixed with Bearer:

   Copy

   Authorization: Bearer YOUR_API_KEY

3. 3

   Call an endpoint

   Send a GET request to /api/v2/projects to list the projects in your organization.

Common requests

Listing all projects

curl --request GET \  --url 'https://app.fossa.com/api/v2/projects' \  --header 'Authorization: Bearer YOUR_API_KEY'

Use page and count to paginate, and title to filter by name.

Listing the revisions of a project

Once you have a project locator, retrieve its revisions:

curl --request GET \  --url 'https://app.fossa.com/api/revisions?projectId=<project-locator>' \  --header 'Authorization: Bearer YOUR_API_KEY'

Next steps

• Authentication: token types and security best practices.
• Managing issues: query and filter issues programmatically.
• Usage examples: end-to-end recipes for common tasks.
• Endpoint Reference: every endpoint, parameter, and response.