Request a snapshot restore for a team's box
POST
/api/admin/boxes/{teamId}/restoreAuthorization
AuthorizationBearer token · headerrequiredPath parameters
teamIdstringrequiredmin length 1
Responses
200
Success
idstringrequiredteamIdstringrequiredcontainerNamestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullgameAddressstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullcpuLimitnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullmemoryLimitMibnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nulldiskLimitGibnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullpidsLimitnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nulllifecycleStatestringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringstring
stringstring
stringstring
stringstring
stringsnapshotGenerationnumberrequiredrestoreStatusstringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringstring
stringstring
stringstring
stringrestoreOperationIdstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullrestoreRequestedAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullrestoreRequestedBystring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullrestoreProgressnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullrestoreMessagestring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nulllastHealthyAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nulllastObservedAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nullusageCpuMillicoresnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullusageMemoryMibnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullusageDiskMibnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullusagePidsnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullusageSampleSecondsnumber | nullrequiredShow propertiesHide properties
Any of:
number
numbernull
nullusageSampledAtstring<date-time> | nullrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>null
nulllimitViolationsobject[]requiredShow propertiesHide properties
Array of
objectdimensionstringrequiredobservednumberrequiredlimitnumberrequiredobservedAtstringrequiredcreatedAtstring<date-time>requiredupdatedAtstring<date-time>required401
Unauthorized
errorstringrequired404
Response for status 404
errorstringrequired409
Response for status 409
errorstringrequired422
Validation failed
typestringrequiredonstringrequiredsummarystringmessagestringfoundanypropertystringexpectedstring500
Unhandled server error
errorstringrequired