API Reference

Programmatically access Agent Breach features through our REST API.

Authentication

All API requests require authentication using an API key. You can generate API keys from your settings page.

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.agentbreach.com/api/v1

Endpoints

Targets

  • GET /targets - List all targets
  • POST /targets - Create a new target
  • GET /targets/:id - Get target details
  • PUT /targets/:id - Update target
  • DELETE /targets/:id - Delete target

Scans

  • GET /scans - List all scans
  • POST /scans - Create and start a scan
  • GET /scans/:id - Get scan details
  • POST /scans/:id/retry - Retry a failed scan

Findings

  • GET /findings - List all findings
  • GET /findings/:id - Get finding details
  • PUT /findings/:id - Update finding status

Rate Limits

API rate limits vary by plan:

  • Free: 100 requests per hour
  • Startup: 1,000 requests per hour
  • Pro: 10,000 requests per hour
  • Enterprise: 100,000 requests per hour

Need More Details?

For complete API documentation with request/response examples, check out our documentation or contact support.