Bug Report API

Programmatically submit and query bug reports via the REST API.

Submit a Bug Report

POST /api/v1/bug
Content-Type: application/json
X-SiteDash-Token: YOUR_TOKEN

{
  "title": "Application crashes on startup",
  "software_version": "1.1.0",
  "description": "Detailed description of the issue...",
  "logs": "ERROR 2026-03-14 09:15:22 - Stack trace...",
  "user_reference": "user@example.com",
  "severity": "High",
  "steps_to_reproduce": "1. Open app\n2. Click X\n3. Crash"
}

Response

HTTP/1.1 201 Created

{
  "id": 42,
  "status": "New"
}

Field Reference

FieldTypeRequiredDescription
titlestringNoBug title (auto-generated from version if omitted)
software_versionstringYesVersion where the bug was found
logsstringYesError logs or stack trace
user_referencestringYesReporter email address
descriptionstringNoDetailed bug description
severitystringNoCritical, High, Medium, or Low (default: Medium)
steps_to_reproducestringNoSteps to reproduce the issue

Error Responses

  • 401 — Invalid or missing authentication token
  • 422 — Missing required fields (software_version, logs, user_reference)