API Reference

Bug0 provides a REST API for triggering tests and integrating with your CI/CD pipelines.

Base URL

https://app.bug0.com/api

Authentication

Bug0 API supports two authentication methods:

API Key (Recommended for CI/CD)

Include your API key in the x-api-key header:

curl -H "x-api-key: bug0_abc123..."

Learn about API Keys →

Service Token (Internal)

For internal service-to-service communication:

curl -H "x-bug0-service-token: your-token"

Available Endpoints

EndpointMethodDescription
/run-testsPOSTTrigger test execution

Rate Limits

LimitValue
Requests per minute10
Requests per hour100

Rate limits are per project. Contact support for higher limits.

Response Format

All responses are JSON:

{
  "success": true,
  "message": "Tests triggered successfully",
  "executionId": "abc123"
}

Error Responses

{
  "success": false,
  "error": "Invalid API key"
}

HTTP Status Codes

CodeDescription
200Success
400Bad request (invalid parameters)
401Unauthorized (invalid/missing API key)
403Forbidden (no access to resource)
404Not found
429Rate limit exceeded
500Server error

Next Steps