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

Read the runner's connectivity and backlog

GET/api/admin/runner
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Success

idnumberrequired
connectedbooleanrequired
runtimeReadybooleanrequired
runnerVersionstring | nullrequired
Show properties
Any of:
string
string
null
null
backlognumberrequired
checkerSourcePoolnumberrequired
lastHeartbeatAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
lastResultAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
terminalErrorstring | nullrequired
Show properties
Any of:
string
string
null
null
restartOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
restartStatusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
restartRequestedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
restartRequestedBystring | nullrequired
Show properties
Any of:
string
string
null
null
restartMessagestring | nullrequired
Show properties
Any of:
string
string
null
null
updatedAtstring<date-time>required
401

Unauthorized

errorstringrequired
404

Response for status 404

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Request
curl -X GET '/api/admin/runner' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": 0,
  "connected": true,
  "runtimeReady": true,
  "runnerVersion": "string",
  "backlog": 0,
  "checkerSourcePool": 0,
  "lastHeartbeatAt": "2019-08-24T14:15:22Z",
  "lastResultAt": "2019-08-24T14:15:22Z",
  "terminalError": "string",
  "restartOperationId": "string",
  "restartStatus": "failed",
  "restartRequestedAt": "2019-08-24T14:15:22Z",
  "restartRequestedBy": "string",
  "restartMessage": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Was this page helpful?