Skip to content

Integrations and API

BattleTest integrates with your existing tooling through the GitHub status check and finding export today, with a REST API on the roadmap.

Every PR review creates a BattleTest Security Review check run on the PR. Use it as a required check in GitHub branch protection rules to block merges until the security review has completed.

The check reports success when the risk score is below 40, action_required at 40 or higher (“request changes”), and failure only on an internal review error. On its own it blocks nothing; add it as a required status check to gate merges on risky PRs. See How to require security review before merging for setup. No CI config, no runner minutes, no GitHub Actions dependency.

Scan reports and PR findings export as PDF for auditors or JSON for ticketing systems and security dashboards, per run or across every PR in a repository. See How to export findings.

BattleTest runs on an internal versioned API (/api/v1) that the web app and integrations use today. A public, documented, stable REST API is not yet released. When it is, it will support:

  • Triggering PR and live scan runs programmatically
  • Querying findings, scan history, and risk score trends
  • Managing targets, repository connections, and settings
  • Bulk export of finding data

To be notified when the public API is available, email [email protected].