API reference

https://api.punishsync.soknight.meOpenAPI: /api/v1/openapi.json

GET/Service infopublic

GET/healthHealth checkpublic

GET/api/v1/versionCurrent releasepublic

GET/api/v1/federationPublic federation summarypublic

GET/api/v1/policiesBan policies shared by memberspublic

GET/api/v1/federation/syncEvent streamtoken

GET/api/v1/bansServer datatoken

GET/api/v1/appealsServer 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.

Examples

GET /api/v1/federation

{
  "federation": "public",
  "members": 148,
  "policies": "/api/v1/policies",
  "sync": "streaming"
}

GET /api/v1/policies

{
  "policies": [
    {
      "id": "cheating",
      "min_evidence": 2,
      "expires_days": null
    },
    {
      "id": "chat-abuse",
      "min_evidence": 1,
      "expires_days": 30
    },
    {
      "id": "griefing",
      "min_evidence": 2,
      "expires_days": 90
    }
  ]
}