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

Dispatch a diagnostic check against a team's box

POST/api/admin/diagnostics
Authorization
AuthorizationBearer token · headerrequired
Request body
requiredapplication/json
teamIdstringrequired
min length 1
serviceIdstringrequired
min length 1
storeIndexinteger | null
Show properties
Any of:
integer
integer
null
null
operationstringrequired
default: "check_service"
Allowed:check_service
Responses
200

Success

messagestring | nullrequired
Show properties
Any of:
string
string
null
null
idstringrequired
teamIdstringrequired
idempotencyKeystringrequired
startedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
requestedBystringrequired
deadlineAtstring<date-time>required
dispatchedAtstring<date-time>required
finishedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
serviceIdstringrequired
storeIdstring | nullrequired
Show properties
Any of:
string
string
null
null
operationstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
durationMsnumber | nullrequired
Show properties
Any of:
number
number
null
null
withdrawnAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
withdrawalAckedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
withdrawalDeliveriesnumberrequired
withdrawalAbandonedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
stdoutstring | nullrequired
Show properties
Any of:
string
string
null
null
stderrstring | nullrequired
Show properties
Any of:
string
string
null
null
401

Unauthorized

errorstringrequired
404

Response for status 404

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/diagnostics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "teamId": "string",
  "serviceId": "string",
  "storeIndex": 0,
  "operation": "check_service"
}'
Response
{
  "message": "string",
  "id": "string",
  "teamId": "string",
  "idempotencyKey": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "pending",
  "requestedBy": "string",
  "deadlineAt": "2019-08-24T14:15:22Z",
  "dispatchedAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "serviceId": "string",
  "storeId": "string",
  "operation": "put_flag",
  "durationMs": 0,
  "withdrawnAt": "2019-08-24T14:15:22Z",
  "withdrawalAckedAt": "2019-08-24T14:15:22Z",
  "withdrawalDeliveries": 0,
  "withdrawalAbandonedAt": "2019-08-24T14:15:22Z",
  "stdout": "string",
  "stderr": "string"
}

Was this page helpful?