Skip to content

API reference

https://api.berkutwatch.soknight.meOpenAPI: /api/v1/openapi.json
GET/Service infopublic
GET/healthHealth checkpublic
GET/api/v1/versionCurrent releasepublic
GET/api/v1/checksAvailable checkspublic
GET/api/v1/limitsPer-server limitspublic
GET/api/v1/reportsServer datatoken
GET/api/v1/reports/streamEvent streamtoken
GET/api/v1/replaysServer datatoken

Paths marked token need Authorization: Bearer <server token> and answer 401 without it. Event streams stay open and push records as they appear. Unknown paths answer 404.

GET /api/v1/checks

{
"checks": [
{
"id": "movement",
"status": "stable"
},
{
"id": "combat",
"status": "stable"
},
{
"id": "click-pattern",
"status": "beta"
}
]
}

GET /api/v1/limits

{
"reports_per_minute": 120,
"replay_seconds": 30,
"replay_retention_days": 14
}