Trapster Documentation

Appearance

API Reference Enterprise ​

The Trapster API is a REST API that returns JSON. Use it to:

  • Query incidents and Trapster data programmatically
  • Integrate alerts into custom dashboards or SOAR platforms
  • Automate honeytoken and breadcrumb management

Base URL ​

https://<your-trapster-dashboard>/api/v1/

Replace <your-trapster-dashboard> with your organization's URL

Authentication ​

All requests require a personal access token (PAT) in the Authorization header:

Authorization: token <your-token>

Generate tokens from Settings > Personal Access Tokens in the dashboard. See Authentication for details.

Full API reference ​

The complete endpoint reference. Including all resources, parameters, response schemas, and code examples. Is available directly from your dashboard at /api/docs. It is generated from the live API and always reflects the version your organization is running.

Response format ​

All responses are JSON objects. Successful responses have HTTP 2xx status codes. Errors return a JSON body with an error field:

json
{ "error": "Unauthorized" }

Rate limiting ​

API requests are rate-limited per token. If you exceed the limit you receive a 429 Too Many Requests response. Back off and retry with exponential delay.