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

Read the current host allocation and list retired ones and recorded host incidents

GET/api/admin/host/history
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Success

currentAllocationOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
allocationsobject[]required
Show properties
Array of object
allocationOperationIdstringrequired
hostImageVersionstringrequired
admittedTeamCountnumberrequired
credentialGenerationnumberrequired
reallocationOperationIdstringrequired
reasonstringrequired
Show properties
Any of:
string
string
string
string
retiredAtstring<date-time>required
incidentsobject[]required
Show properties
Array of object
idstringrequired
reasonstringrequired
allocationOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
networkOpenedbooleanrequired
recordedBystring | nullrequired
Show properties
Any of:
string
string
null
null
recordedAtstring<date-time>required
replacedByAllocationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
replacedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
401

Unauthorized

errorstringrequired
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Request
curl -X GET '/api/admin/host/history' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "currentAllocationOperationId": "string",
  "allocations": [
    {
      "allocationOperationId": "string",
      "hostImageVersion": "string",
      "admittedTeamCount": 0,
      "credentialGeneration": 0,
      "reallocationOperationId": "string",
      "reason": "compromise",
      "retiredAt": "2019-08-24T14:15:22Z"
    }
  ],
  "incidents": [
    {
      "id": "string",
      "reason": "string",
      "allocationOperationId": "string",
      "networkOpened": true,
      "recordedBy": "string",
      "recordedAt": "2019-08-24T14:15:22Z",
      "replacedByAllocationId": "string",
      "replacedAt": "2019-08-24T14:15:22Z"
    }
  ]
}