@api-emulator/xbow
v0.2.2
Published
XBOW provides automated penetration-testing APIs for organizations, assets, assessments, findings, reports, resources, and webhooks.
Readme
@api-emulator/xbow
XBOW provides automated penetration-testing APIs for organizations, assets, assessments, findings, reports, resources, and webhooks.
Use this emulator for local tests, CI, and offline agent runs. It keeps your tests separate from the production API.
Start the emulator
- Install the package.
npm install @api-emulator/xbow- From this registry, start the emulator.
npx -p api-emulator api --plugin ./providers/@xbow/api-emulator.mjs --service xbowThe emulator uses the local URL that api-emulator prints. Set your client base URL to this local URL.
Supported API
GET /api/v1/assessments/{assessmentId}POST /api/v1/assessments/{assessmentId}/cancelPOST /api/v1/assessments/{assessmentId}/pausePOST /api/v1/assessments/{assessmentId}/resumeGET /api/v1/assets/{assetId}PUT /api/v1/assets/{assetId}GET /api/v1/assets/{assetId}/assessmentsPOST /api/v1/assets/{assetId}/assessmentsGET /api/v1/assets/{assetId}/findingsGET /api/v1/assets/{assetId}/reportsGET /api/v1/findings/{findingId}PATCH /api/v1/findings/{findingId}POST /api/v1/findings/{findingId}/verify-fixPOST /api/v1/integrations/{integrationId}/lightspeedGET /api/v1/integrations/{integrationId}/organizationsPOST /api/v1/integrations/{integrationId}/organizationsDELETE /api/v1/keys/{keyId}GET /api/v1/meta/addressesGET /api/v1/meta/openapi.jsonGET /api/v1/meta/webhooks-signing-keysGET /api/v1/organizations/{organizationId}PUT /api/v1/organizations/{organizationId}GET /api/v1/organizations/{organizationId}/assetsPOST /api/v1/organizations/{organizationId}/assetsPOST /api/v1/organizations/{organizationId}/keysGET /api/v1/organizations/{organizationId}/resourcesPOST /api/v1/organizations/{organizationId}/resourcesGET /api/v1/organizations/{organizationId}/webhooksPOST /api/v1/organizations/{organizationId}/webhooksGET /api/v1/reports/{reportId}GET /api/v1/reports/{reportId}/summaryDELETE /api/v1/resources/{resourceId}GET /api/v1/resources/{resourceId}POST /api/v1/resources/{resourceId}/commitPOST /api/v1/resources/{resourceId}/partsDELETE /api/v1/webhooks/{webhookId}GET /api/v1/webhooks/{webhookId}PATCH /api/v1/webhooks/{webhookId}GET /api/v1/webhooks/{webhookId}/deliveriesPOST /api/v1/webhooks/{webhookId}/ping
Coverage
- Level:
contract-backed - Meaning: Automated tests compare this emulator with a defined API contract.
- Evidence: 83% medium conformance score.
- Smoke:
node providers/@xbow/smoke.mjs - Contract checks:
node scripts/check-xbow-openapi-coverage.mjs
Credentials
Use a fixed bearer token or API key in each test. The emulator does not send these credentials to the provider.
Test data
Add repeatable test data to the provider configuration.
xbow:
# Add provider-specific seed state here.