PHphala
CVMs

Restart CVM

Changed on

Stops and starts CVM. Use force=true to skip graceful shutdown.

post/api/v1/cvms/{cvm_id}/restart

Request

Path parameters

cvm_idstring required

Request body

forceboolean

Skip graceful shutdown

Response

CVM record with restarting status

namestring required
statusstring required
teepod_idinteger required
app_idstring required
vm_uuidstring nullable
instance_idstring nullable
app_urlstring nullable
base_imagestring nullable
vcpuinteger required
memoryinteger required
disk_sizeinteger required
manifest_versioninteger nullable
versionstring nullable
runnerstring nullable
docker_compose_filestring nullable
featuresstring[] nullable
created_atstring date-time required
encrypted_env_pubkeystring nullable

Example response

{
  "id": "cvm_0123abcd",
  "user_id": "usr_0123abcd"
}

Changes

  • c71a8dc90391Revision changes
    • breaking

      response property id list-of-types was widened by adding types string to media type application/json of response 200

    • breaking

      response property user_id list-of-types was widened by adding types string to media type application/json of response 200