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

Read the event host's desired/observed state

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

Success

idnumberrequired
agentVersionstring | nullrequired
Show properties
Any of:
string
string
null
null
desiredGenerationnumberrequired
observedGenerationnumber | nullrequired
Show properties
Any of:
number
number
null
null
desiredHashstring | nullrequired
Show properties
Any of:
string
string
null
null
baseSnapshotGenerationnumberrequired
readybooleanrequired
qualificationResultstringrequired
Show properties
Any of:
string
string
string
string
string
string
terminalErrorstring | nullrequired
Show properties
Any of:
string
string
null
null
agentConnectedbooleanrequired
blockedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
blockedReasonstring | nullrequired
Show properties
Any of:
string
string
null
null
reallocationOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
reallocationReasonstring | nullrequired
Show properties
Any of:
string
string
string
string
null
null
reallocationRequestedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
credentialFingerprintstring | nullrequired
Show properties
Any of:
string
string
null
null
credentialGenerationnumberrequired
credentialExpiresAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revokedGenerationnumberrequired
sealedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
relayPublicKeystring | nullrequired
Show properties
Any of:
string
string
null
null
relayEndpointstring | nullrequired
Show properties
Any of:
string
string
null
null
observationCollectorIdstring | nullrequired
Show properties
Any of:
string
string
null
null
observationSequencenumberrequired
observedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
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/host' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": 0,
  "agentVersion": "string",
  "desiredGeneration": 0,
  "observedGeneration": 0,
  "desiredHash": "string",
  "baseSnapshotGeneration": 0,
  "ready": true,
  "qualificationResult": "pending",
  "terminalError": "string",
  "agentConnected": true,
  "blockedAt": "2019-08-24T14:15:22Z",
  "blockedReason": "string",
  "reallocationOperationId": "string",
  "reallocationReason": "compromise",
  "reallocationRequestedAt": "2019-08-24T14:15:22Z",
  "credentialFingerprint": "string",
  "credentialGeneration": 0,
  "credentialExpiresAt": "2019-08-24T14:15:22Z",
  "revokedGeneration": 0,
  "sealedAt": "2019-08-24T14:15:22Z",
  "relayPublicKey": "string",
  "relayEndpoint": "string",
  "observationCollectorId": "string",
  "observationSequence": 0,
  "observedAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}