PHphala
Apps

Create CVM replica

Changed on

Clones a CVM to a target node. Uses source node if target not specified.

post/api/v1/apps/{app_id}/cvms/{vm_uuid}/replicas

Request

Path parameters

app_idstring required

Hex app identifier

vm_uuidstring required

Source CVM UUID

Headers

X-Prepare-Onlystring nullable

Request body

nodestring nullable

Physical node name

os_imagestring nullable

Target OS image name or slug

encrypted_envstring nullable

New encrypted env blob (hex). Required when the source CVM has managed_env enabled.

compose_hashstring nullable

Explicit compose hash to replicate. Required when the source app has multiple live instances.

Response

Replica CVM created

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

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /