API and Development

API and Development

Overview

Ossprey exposes a public REST API for triggering scans, retrieving scan results, and managing projects programmatically. The API is the same surface used by the dashboard and CI integrations, so anything you can do in the UI you can do via the API.

Authentication

All endpoints require an API key passed in the Authorization header. API keys can be generated from the dashboard under your project settings.

Common use cases

  • Submitting an SBOM or dependency manifest for scanning
  • Polling scan status and fetching results
  • Listing projects, scans, and detected findings
  • Integrating Ossprey into custom CI/CD pipelines beyond the standard GitHub Action

Full API reference

For the complete endpoint list, request/response schemas, and code examples, see the API docs at  https://ossprey.readme.io/ .