Skip to main content

End a battle that is under way

POST 
/admin/battles/:id/abort

The operator's way out of a battle that started and got stuck. It ends as FAILED, never CANCELLED: a lobby nobody joined is cancelled, while a battle with recordings in flight ended badly, and telling the casino "cancelled" would describe a refund it is not getting.

Only STARTING and RUNNING are accepted. An OPEN lobby is a 409 and belongs to /cancel; a battle that already ended is a 409 too, rather than a no-op success that would claim the operator stopped something.

It goes through the lobby, so the terminal event is published and every connected viewer is told. Seats already in flight are not stopped — they die on their own deadline — and nothing is refunded: settlement is the consuming backend's, as it is for every other failure.

Permission: battles.write

Request​

Responses​

Aborted, with the battle as it now stands