API Reference

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

https://api.blackfortress.tech/v1

Endpoints

POST /events

Submit a security event for processing.

Request Body:

{
  "type": "login_attempt",
  "severity": "low|medium|high|critical",
  "source_ip": "192.168.1.1",
  "user_id": "user-001",
  "timestamp": "2026-06-19T12:00:00Z",
  "metadata": { ... }
}

Response (202 Accepted):

{
  "accepted": 1,
  "rejected": 0,
  "timestamp": "2026-06-19T12:00:00Z"
}

GET /threats

List threats detected by the system.

Query Parameters:

  • limit: Number of results (default: 50, max: 500)
  • offset: Pagination offset (default: 0)
  • severity: Filter by severity (low, medium, high, critical)
  • resolved: Show resolved threats (true/false)

POST /threats/:id/respond

Execute a response action for a threat.

Request Body:

{
  "action": "lock_account|require_mfa|isolate|notify",
  "reason": "string",
  "escalate": boolean
}

Rate Limits

  • Starter: 1,000 requests/min
  • Pro: 10,000 requests/min
  • Enterprise: Custom

Error Responses

400 Bad Request

Invalid parameters or malformed request body

401 Unauthorized

Missing or invalid API key

429 Too Many Requests

Rate limit exceeded. Check Retry-After header.

← PreviousNext →