Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Record the End operation; the engine drains, scores and acknowledges it

Only the Athena platform’s own key for this event may call this. It is part of the platform’s event lifecycle, and every other key is refused with 403.

POST/api/admin/game/end
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
operationIdstringrequired
min length 1 · max length 64
triggerstringrequired
Allowed:scheduledrequested
Responses
200

Success

finalNotificationsobject | nullrequired
Show properties
Any of:
object
deadlineAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
emailstringrequired
Show properties
Any of:
string
string
string
string
discordstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
settledbooleanrequired
null
null
operationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
requestedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
cutoffAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
drainDeadlineAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
endedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
acknowledgedbooleanrequired
finalTicknumber | nullrequired
Show properties
Any of:
number
number
null
null
acceptedbooleanrequired
401

Unauthorized

errorstringrequired
403

Response for status 403

errorstringrequired
409

Response for status 409

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST '/api/admin/game/end' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "operationId": "string",
  "trigger": "scheduled"
}'
Response
{
  "finalNotifications": {
    "deadlineAt": "2019-08-24T14:15:22Z",
    "email": "pending",
    "discord": "pending",
    "settled": true
  },
  "operationId": "string",
  "requestedAt": "2019-08-24T14:15:22Z",
  "cutoffAt": "2019-08-24T14:15:22Z",
  "drainDeadlineAt": "2019-08-24T14:15:22Z",
  "endedAt": "2019-08-24T14:15:22Z",
  "acknowledged": true,
  "finalTick": 0,
  "accepted": true
}