Project API

API to manage projects, versions, and documents in Ketryx

Ketryx exposes an API to manage projects programmatically. There is also a formal OpenAPI specification defining this API, and a separate page about authentication and API keys.

Projects

Project

Versions

Version

Generated documents

Use this API to generate and download the SBOM document for a given project. Optionally, a certain version ID can be specified:

  • If no versionId is specified, the document for the "current draft" state (corresponding to the main analyzed branch, not specific to a certain version) is downloaded.

  • If a versionId is specified, the document is generated for the given version (and its corresponding release ref).

The response is an Excel file in binary form.

Last updated

© 2024 Ketryx Corporation