Skip to main content
POST
/
api
/
v1
/
cvms
/
{cvm_id}
/
compose_file
/
provision
Provision compose file update
curl --request POST \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file/provision \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "allowed_envs": [
    "<string>"
  ],
  "bash_script": "<string>",
  "default_gateway_domain": "<string>",
  "docker_compose_file": "<string>",
  "init_script": "<string>",
  "kms_enabled": true,
  "local_key_provider_enabled": false,
  "manifest_version": 2,
  "no_instance_id": false,
  "pre_launch_script": "<string>",
  "public_logs": true,
  "public_sysinfo": true,
  "public_tcbinfo": true,
  "runner": "docker-compose",
  "gateway_enabled": true,
  "features": [
    "kms",
    "tproxy-net"
  ],
  "salt": "<string>",
  "secure_time": false,
  "storage_fs": "zfs",
  "tproxy_enabled": true,
  "update_env_vars": false
}
'
{
  "app_id": "<string>",
  "compose_hash": "<string>",
  "device_id": "<string>",
  "kms_info": {
    "id": "<string>",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>"
  },
  "compose_hash_registered": false
}

Path Parameters

cvm_id
string
required

Body

application/json

Updated compose configuration

name
string
required
allowed_envs
string[]
bash_script
string | null
default_gateway_domain
string | null
docker_compose_file
string | null
init_script
string | null
kms_enabled
boolean
default:true
local_key_provider_enabled
boolean
default:false
manifest_version
integer
default:2
no_instance_id
boolean
default:false
pre_launch_script
string | null
public_logs
boolean
default:true
public_sysinfo
boolean
default:true
public_tcbinfo
boolean
default:true
runner
string
default:docker-compose
gateway_enabled
boolean
default:true
features
string[]
salt
string | null
secure_time
boolean
default:false
storage_fs
default:zfs
Allowed value: "ext4"
tproxy_enabled
boolean
default:true
update_env_vars
boolean | null
default:false

Whether to also update allowed_envs

Response

Provision response with compose_hash and KMS info

API response model for compose file provision

app_id
string
required
compose_hash
string
required
device_id
string | null
kms_info
KMSInfo · object

KMS instance information.

compose_hash_registered
boolean
default:false