Skip to main content
POST
Start Upgrade

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Consent to what a self-upgrade destroys.

Restarting the API closes every RUNNING executor as SYSTEM_CLEANUP and they are not restored, so the one field here is the acknowledgement of that -- and it defaults to False, which means a caller that sends an empty body is refused rather than served. Bot containers are separate and keep running.

acknowledge_executor_loss
boolean
default:false

Confirms that every running executor will be closed as SYSTEM_CLEANUP and not restored. Required when the server has any running executor.

Response

Successful Response