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

Read a team's box

GET/api/admin/boxes/{teamId}
Authorization
AuthorizationBearer token · headerrequired
Path parameters
teamIdstringrequired
min length 1
Responses
200

Success

sshKeysobject[]required
Show properties
Array of object
idstringrequired
fingerprintstringrequired
labelstringrequired
createdAtstring<date-time>required
idstringrequired
teamIdstringrequired
containerNamestring | nullrequired
Show properties
Any of:
string
string
null
null
gameAddressstring | nullrequired
Show properties
Any of:
string
string
null
null
cpuLimitnumber | nullrequired
Show properties
Any of:
number
number
null
null
memoryLimitMibnumber | nullrequired
Show properties
Any of:
number
number
null
null
diskLimitGibnumber | nullrequired
Show properties
Any of:
number
number
null
null
pidsLimitnumber | nullrequired
Show properties
Any of:
number
number
null
null
lifecycleStatestringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
snapshotGenerationnumberrequired
restoreStatusstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
restoreOperationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
restoreRequestedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
restoreRequestedBystring | nullrequired
Show properties
Any of:
string
string
null
null
restoreProgressnumber | nullrequired
Show properties
Any of:
number
number
null
null
restoreMessagestring | nullrequired
Show properties
Any of:
string
string
null
null
lastHealthyAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
lastObservedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
usageCpuMillicoresnumber | nullrequired
Show properties
Any of:
number
number
null
null
usageMemoryMibnumber | nullrequired
Show properties
Any of:
number
number
null
null
usageDiskMibnumber | nullrequired
Show properties
Any of:
number
number
null
null
usagePidsnumber | nullrequired
Show properties
Any of:
number
number
null
null
usageSampleSecondsnumber | nullrequired
Show properties
Any of:
number
number
null
null
usageSampledAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
limitViolationsobject[]required
Show properties
Array of object
dimensionstringrequired
observednumberrequired
limitnumberrequired
observedAtstringrequired
createdAtstring<date-time>required
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
Parameters
Request
curl -X GET '/api/admin/boxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "sshKeys": [
    {
      "id": "string",
      "fingerprint": "string",
      "label": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "id": "string",
  "teamId": "string",
  "containerName": "string",
  "gameAddress": "string",
  "cpuLimit": 0,
  "memoryLimitMib": 0,
  "diskLimitGib": 0,
  "pidsLimit": 0,
  "lifecycleState": "pending",
  "snapshotGeneration": 0,
  "restoreStatus": "failed",
  "restoreOperationId": "string",
  "restoreRequestedAt": "2019-08-24T14:15:22Z",
  "restoreRequestedBy": "string",
  "restoreProgress": 0,
  "restoreMessage": "string",
  "lastHealthyAt": "2019-08-24T14:15:22Z",
  "lastObservedAt": "2019-08-24T14:15:22Z",
  "usageCpuMillicores": 0,
  "usageMemoryMib": 0,
  "usageDiskMib": 0,
  "usagePids": 0,
  "usageSampleSeconds": 0,
  "usageSampledAt": "2019-08-24T14:15:22Z",
  "limitViolations": [
    {
      "dimension": "string",
      "observed": 0,
      "limit": 0,
      "observedAt": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Was this page helpful?