XBOW API
Product · API / developer platform · Engineering & development by XBOW
Everything XBOW Finds and Proves, Through One API.
A REST API for developers to automate autonomous penetration testing, trigger assessments programmatically, and retrieve validated findings with reproducible proof. It is designed for security teams to build CI/CD security gates and automate vulnerability management at scale.
- Languages
- English
Category: Application Security
- APIs and SDKs
- REST API with bearer token authentication
- Platforms
- API
- Deployment
- US, EU, and Singapore hosts for data residency
- API Type
- REST
- Authentication Method
- Bearer Token
- API Versioning Format
- Date-based (YYYY-MM-DD)
- REST API for autonomous pentesting lifecycle management
- Automated finding retrieval with reproducible proof and CWEs
- Regional data residency in US, EU, and Singapore
- Webhooks for real-time assessment and finding updates
- Date-based API versioning for stable integrations
Overview
The XBOW API is a REST-based developer platform that enables security and engineering teams to integrate autonomous offensive security into their existing workflows. It provides programmatic control over the entire assessment lifecycle, allowing users to create assets, configure safety guardrails, and trigger penetration tests on demand. The API delivers validated findings complete with evidence, reproduction steps, and severity scores, which can be fed directly into SIEM and vulnerability management systems. By supporting regional hosts in the US, EU, and Singapore, it addresses data residency requirements for global organizations. Teams use the API to build automated security gates in CI/CD pipelines, ensuring that every release is tested for exploitable vulnerabilities before deployment. It also features a webhook system for real-time event delivery, enabling immediate response to new security findings.
Assessment Lifecycle Management
- Asset Management: The /organizations/{id}/assets endpoint allows developers to programmatically create and manage the assets they test.
- Scope Configuration: The /assets/{id} endpoint provides programmatic control over asset scope, authentication, and safety controls.
- Assessment Triggering: The /assets/{id}/assessments endpoint enables systems to trigger and list assessments on demand.
- Lifecycle Control: The /assessments/{id} endpoint allows for fetching assessment status or pausing, resuming, and canceling running tests.
Findings and Reporting Automation
- Finding Retrieval: The /assets/{id}/findings and /findings/{id} endpoints retrieve findings with evidence, reproduction steps, severity, and CWE classification.
- Report Generation: The /assets/{id}/reports endpoint allows for pulling full pentest reports and summaries via the API.
- Webhooks and Events: The /organizations/{id}/webhooks endpoint enables subscription to events like finding.changed and assessment.changed for real-time delivery.
- Webhook Management: Webhooks support verifying delivery signatures and inspecting delivery history directly from the API.
Developer Use Cases
- Pre-Release Security Gates: Teams can trigger a pentest on merge or pre-deploy to surface exploit-proven issues before a release ships.
- Portfolio Coverage Automation: The API supports triggering per-asset pentests from a scheduler or CI across a large estate of applications.
- Vulnerability Management Integration: Proven findings can be sent directly to SIEM, vulnerability management, and ticketing tools to eliminate scanner noise.
- Custom Dashboards: Findings and intelligence can be pulled into internal dashboards and executive reporting built on custom data.
Use cases
- Security engineers trigger pentests on merge or pre-deploy to surface exploit-proven issues before a release ships.
- DevSecOps teams automate portfolio-wide coverage by triggering per-asset pentests from a scheduler or CI system.
- Vulnerability management teams send only proven findings to SIEM and ticketing tools to eliminate scanner noise.
- Security leaders pull findings and intelligence into custom internal dashboards and executive reporting.
Specifications
- APIs and SDKs
- REST API with bearer token authentication
- Platforms
- API
- Deployment
- US, EU, and Singapore hosts for data residency
- Integrations
- Jira, GitHub, SIEM, vulnerability management tools, Microsoft Sentinel, Security Copilot
- API Type
- REST
- Authentication Method
- Bearer Token
- API Versioning Format
- Date-based (YYYY-MM-DD)
- Data Residency Regions
- US, EU, Singapore
- Supported Webhook Events
- finding.changed, assessment.changed, asset.changed, challenge.changed, ping
- Finding Metadata
- Evidence, reproduction, severity, CWE
- Integration Targets
- Jira, GitHub, SIEM, Microsoft Sentinel, Security Copilot
How it works
- Authentication Setup: Generate a bearer token from the XBOW Console to authenticate your API requests.
- Configure Assets: Use the assets endpoints to define your target applications, scope, and safety guardrails.
- Trigger Assessments Scan: Programmatically launch assessments via the assessments endpoint or integrate them into CI/CD pipelines.
- Retrieve Results: Retrieve validated findings and reports or receive real-time updates through configured webhooks.
FAQ
How do I authenticate with the XBOW API?
XBOW uses bearer tokens for authentication, which must be included in the Authorization header of every request.
How is the XBOW API versioned?
The API uses date-based versioning, such as 2026-07-01, which must be pinned in the X-XBOW-API-Version request header.
Where can I host my data when using the XBOW API?
XBOW provides dedicated hosts in the US, EU, and Singapore to support regional data residency requirements.
What event types are supported by XBOW webhooks?
You can subscribe to events including finding.changed, assessment.changed, asset.changed, challenge.changed, and ping.
Added by AntSpace from public sources (xbow.com).