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

Pause the game; the engine withdraws running checks and retries them on resume

POST/api/admin/game/pause
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
reasonstringrequired
min length 1 · max length 500
Responses
200

Success

idnumberrequired
epochstringrequired
phasestringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
settingsVersionnumber | nullrequired
Show properties
Any of:
number
number
null
null
rosterLockedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
networkOpenAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
networkOpenedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
tickEpochAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
pausedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
pauseKindstring | nullrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
null
null
pauseReasonstring | nullrequired
Show properties
Any of:
string
string
null
null
endOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
endRequestedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
endCutoffAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
endDrainDeadlineAtstring<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
finalNotificationsDeadlineAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
leaderIdstring | nullrequired
Show properties
Any of:
string
string
null
null
leaderFencenumberrequired
leaderHeartbeatAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
lastCompletedTicknumber | nullrequired
Show properties
Any of:
number
number
null
null
updatedAtstring<date-time>required
401

Unauthorized

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/pause' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string"
}'
Response
{
  "id": 0,
  "epoch": "string",
  "phase": "running",
  "settingsVersion": 0,
  "rosterLockedAt": "2019-08-24T14:15:22Z",
  "networkOpenAt": "2019-08-24T14:15:22Z",
  "networkOpenedAt": "2019-08-24T14:15:22Z",
  "tickEpochAt": "2019-08-24T14:15:22Z",
  "pausedAt": "2019-08-24T14:15:22Z",
  "pauseKind": "organizer",
  "pauseReason": "string",
  "endOperationId": "string",
  "endRequestedAt": "2019-08-24T14:15:22Z",
  "endCutoffAt": "2019-08-24T14:15:22Z",
  "endDrainDeadlineAt": "2019-08-24T14:15:22Z",
  "endedAt": "2019-08-24T14:15:22Z",
  "finalNotificationsDeadlineAt": "2019-08-24T14:15:22Z",
  "leaderId": "string",
  "leaderFence": 0,
  "leaderHeartbeatAt": "2019-08-24T14:15:22Z",
  "lastCompletedTick": 0,
  "updatedAt": "2019-08-24T14:15:22Z"
}