Submit compose file update
curl --request POST \
--url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file \
--header 'Content-Type: application/json' \
--data '
{
"compose_file": {
"name": "<string>",
"allowed_envs": [
"<string>"
],
"bash_script": "<string>",
"default_gateway_domain": "<string>",
"docker_compose_file": "<string>",
"key_provider_id": "<string>",
"kms_enabled": true,
"local_key_provider_enabled": false,
"manifest_version": 2,
"no_instance_id": false,
"port_policy": {
"ports": [
{
"port": 123,
"pp": false
}
],
"restrict_mode": false
},
"pre_launch_script": "<string>",
"public_logs": true,
"public_sysinfo": true,
"public_tcbinfo": true,
"runner": "docker-compose",
"requirements": {
"ephemeral_data_disk": false,
"gpu_policy": {
"allow_debug": false,
"allow_devtools": false,
"allow_insecure_boot": false,
"attest_gpu": true,
"rego": "<string>"
},
"health_check": false,
"health_status_file": "<string>",
"launch_token_hash": "<string>",
"platforms": [
"<string>"
],
"tdx_measure_acpi_tables": true
},
"storage_discard": true,
"verity_volumes": [
{
"source": "<string>",
"target": "<string>",
"verity_root": "<string>"
}
],
"gateway_enabled": true,
"features": [
"kms",
"tproxy-net"
],
"salt": "<string>",
"secure_time": false,
"storage_fs": "zfs",
"swap_size": "<string>",
"tproxy_enabled": true
},
"compose_hash": "<string>",
"encrypted_env": "<string>",
"env_keys": [
"<string>"
]
}
'import requests
url = "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file"
payload = {
"compose_file": {
"name": "<string>",
"allowed_envs": ["<string>"],
"bash_script": "<string>",
"default_gateway_domain": "<string>",
"docker_compose_file": "<string>",
"key_provider_id": "<string>",
"kms_enabled": True,
"local_key_provider_enabled": False,
"manifest_version": 2,
"no_instance_id": False,
"port_policy": {
"ports": [
{
"port": 123,
"pp": False
}
],
"restrict_mode": False
},
"pre_launch_script": "<string>",
"public_logs": True,
"public_sysinfo": True,
"public_tcbinfo": True,
"runner": "docker-compose",
"requirements": {
"ephemeral_data_disk": False,
"gpu_policy": {
"allow_debug": False,
"allow_devtools": False,
"allow_insecure_boot": False,
"attest_gpu": True,
"rego": "<string>"
},
"health_check": False,
"health_status_file": "<string>",
"launch_token_hash": "<string>",
"platforms": ["<string>"],
"tdx_measure_acpi_tables": True
},
"storage_discard": True,
"verity_volumes": [
{
"source": "<string>",
"target": "<string>",
"verity_root": "<string>"
}
],
"gateway_enabled": True,
"features": ["kms", "tproxy-net"],
"salt": "<string>",
"secure_time": False,
"storage_fs": "zfs",
"swap_size": "<string>",
"tproxy_enabled": True
},
"compose_hash": "<string>",
"encrypted_env": "<string>",
"env_keys": ["<string>"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
compose_file: {
name: '<string>',
allowed_envs: ['<string>'],
bash_script: '<string>',
default_gateway_domain: '<string>',
docker_compose_file: '<string>',
key_provider_id: '<string>',
kms_enabled: true,
local_key_provider_enabled: false,
manifest_version: 2,
no_instance_id: false,
port_policy: {ports: [{port: 123, pp: false}], restrict_mode: false},
pre_launch_script: '<string>',
public_logs: true,
public_sysinfo: true,
public_tcbinfo: true,
runner: 'docker-compose',
requirements: {
ephemeral_data_disk: false,
gpu_policy: {
allow_debug: false,
allow_devtools: false,
allow_insecure_boot: false,
attest_gpu: true,
rego: '<string>'
},
health_check: false,
health_status_file: '<string>',
launch_token_hash: '<string>',
platforms: ['<string>'],
tdx_measure_acpi_tables: true
},
storage_discard: true,
verity_volumes: [{source: '<string>', target: '<string>', verity_root: '<string>'}],
gateway_enabled: true,
features: ['kms', 'tproxy-net'],
salt: '<string>',
secure_time: false,
storage_fs: 'zfs',
swap_size: '<string>',
tproxy_enabled: true
},
compose_hash: '<string>',
encrypted_env: '<string>',
env_keys: ['<string>']
})
};
fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'compose_file' => [
'name' => '<string>',
'allowed_envs' => [
'<string>'
],
'bash_script' => '<string>',
'default_gateway_domain' => '<string>',
'docker_compose_file' => '<string>',
'key_provider_id' => '<string>',
'kms_enabled' => true,
'local_key_provider_enabled' => false,
'manifest_version' => 2,
'no_instance_id' => false,
'port_policy' => [
'ports' => [
[
'port' => 123,
'pp' => false
]
],
'restrict_mode' => false
],
'pre_launch_script' => '<string>',
'public_logs' => true,
'public_sysinfo' => true,
'public_tcbinfo' => true,
'runner' => 'docker-compose',
'requirements' => [
'ephemeral_data_disk' => false,
'gpu_policy' => [
'allow_debug' => false,
'allow_devtools' => false,
'allow_insecure_boot' => false,
'attest_gpu' => true,
'rego' => '<string>'
],
'health_check' => false,
'health_status_file' => '<string>',
'launch_token_hash' => '<string>',
'platforms' => [
'<string>'
],
'tdx_measure_acpi_tables' => true
],
'storage_discard' => true,
'verity_volumes' => [
[
'source' => '<string>',
'target' => '<string>',
'verity_root' => '<string>'
]
],
'gateway_enabled' => true,
'features' => [
'kms',
'tproxy-net'
],
'salt' => '<string>',
'secure_time' => false,
'storage_fs' => 'zfs',
'swap_size' => '<string>',
'tproxy_enabled' => true
],
'compose_hash' => '<string>',
'encrypted_env' => '<string>',
'env_keys' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file"
payload := strings.NewReader("{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file")
.header("Content-Type", "application/json")
.body("{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyCVMs
Submit compose file update
Submit complete compose file with hash verification. Use when you have pre-computed compose_hash and want to skip provision step.
POST
/
api
/
v1
/
cvms
/
{cvm_id}
/
compose_file
Submit compose file update
curl --request POST \
--url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file \
--header 'Content-Type: application/json' \
--data '
{
"compose_file": {
"name": "<string>",
"allowed_envs": [
"<string>"
],
"bash_script": "<string>",
"default_gateway_domain": "<string>",
"docker_compose_file": "<string>",
"key_provider_id": "<string>",
"kms_enabled": true,
"local_key_provider_enabled": false,
"manifest_version": 2,
"no_instance_id": false,
"port_policy": {
"ports": [
{
"port": 123,
"pp": false
}
],
"restrict_mode": false
},
"pre_launch_script": "<string>",
"public_logs": true,
"public_sysinfo": true,
"public_tcbinfo": true,
"runner": "docker-compose",
"requirements": {
"ephemeral_data_disk": false,
"gpu_policy": {
"allow_debug": false,
"allow_devtools": false,
"allow_insecure_boot": false,
"attest_gpu": true,
"rego": "<string>"
},
"health_check": false,
"health_status_file": "<string>",
"launch_token_hash": "<string>",
"platforms": [
"<string>"
],
"tdx_measure_acpi_tables": true
},
"storage_discard": true,
"verity_volumes": [
{
"source": "<string>",
"target": "<string>",
"verity_root": "<string>"
}
],
"gateway_enabled": true,
"features": [
"kms",
"tproxy-net"
],
"salt": "<string>",
"secure_time": false,
"storage_fs": "zfs",
"swap_size": "<string>",
"tproxy_enabled": true
},
"compose_hash": "<string>",
"encrypted_env": "<string>",
"env_keys": [
"<string>"
]
}
'import requests
url = "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file"
payload = {
"compose_file": {
"name": "<string>",
"allowed_envs": ["<string>"],
"bash_script": "<string>",
"default_gateway_domain": "<string>",
"docker_compose_file": "<string>",
"key_provider_id": "<string>",
"kms_enabled": True,
"local_key_provider_enabled": False,
"manifest_version": 2,
"no_instance_id": False,
"port_policy": {
"ports": [
{
"port": 123,
"pp": False
}
],
"restrict_mode": False
},
"pre_launch_script": "<string>",
"public_logs": True,
"public_sysinfo": True,
"public_tcbinfo": True,
"runner": "docker-compose",
"requirements": {
"ephemeral_data_disk": False,
"gpu_policy": {
"allow_debug": False,
"allow_devtools": False,
"allow_insecure_boot": False,
"attest_gpu": True,
"rego": "<string>"
},
"health_check": False,
"health_status_file": "<string>",
"launch_token_hash": "<string>",
"platforms": ["<string>"],
"tdx_measure_acpi_tables": True
},
"storage_discard": True,
"verity_volumes": [
{
"source": "<string>",
"target": "<string>",
"verity_root": "<string>"
}
],
"gateway_enabled": True,
"features": ["kms", "tproxy-net"],
"salt": "<string>",
"secure_time": False,
"storage_fs": "zfs",
"swap_size": "<string>",
"tproxy_enabled": True
},
"compose_hash": "<string>",
"encrypted_env": "<string>",
"env_keys": ["<string>"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
compose_file: {
name: '<string>',
allowed_envs: ['<string>'],
bash_script: '<string>',
default_gateway_domain: '<string>',
docker_compose_file: '<string>',
key_provider_id: '<string>',
kms_enabled: true,
local_key_provider_enabled: false,
manifest_version: 2,
no_instance_id: false,
port_policy: {ports: [{port: 123, pp: false}], restrict_mode: false},
pre_launch_script: '<string>',
public_logs: true,
public_sysinfo: true,
public_tcbinfo: true,
runner: 'docker-compose',
requirements: {
ephemeral_data_disk: false,
gpu_policy: {
allow_debug: false,
allow_devtools: false,
allow_insecure_boot: false,
attest_gpu: true,
rego: '<string>'
},
health_check: false,
health_status_file: '<string>',
launch_token_hash: '<string>',
platforms: ['<string>'],
tdx_measure_acpi_tables: true
},
storage_discard: true,
verity_volumes: [{source: '<string>', target: '<string>', verity_root: '<string>'}],
gateway_enabled: true,
features: ['kms', 'tproxy-net'],
salt: '<string>',
secure_time: false,
storage_fs: 'zfs',
swap_size: '<string>',
tproxy_enabled: true
},
compose_hash: '<string>',
encrypted_env: '<string>',
env_keys: ['<string>']
})
};
fetch('https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'compose_file' => [
'name' => '<string>',
'allowed_envs' => [
'<string>'
],
'bash_script' => '<string>',
'default_gateway_domain' => '<string>',
'docker_compose_file' => '<string>',
'key_provider_id' => '<string>',
'kms_enabled' => true,
'local_key_provider_enabled' => false,
'manifest_version' => 2,
'no_instance_id' => false,
'port_policy' => [
'ports' => [
[
'port' => 123,
'pp' => false
]
],
'restrict_mode' => false
],
'pre_launch_script' => '<string>',
'public_logs' => true,
'public_sysinfo' => true,
'public_tcbinfo' => true,
'runner' => 'docker-compose',
'requirements' => [
'ephemeral_data_disk' => false,
'gpu_policy' => [
'allow_debug' => false,
'allow_devtools' => false,
'allow_insecure_boot' => false,
'attest_gpu' => true,
'rego' => '<string>'
],
'health_check' => false,
'health_status_file' => '<string>',
'launch_token_hash' => '<string>',
'platforms' => [
'<string>'
],
'tdx_measure_acpi_tables' => true
],
'storage_discard' => true,
'verity_volumes' => [
[
'source' => '<string>',
'target' => '<string>',
'verity_root' => '<string>'
]
],
'gateway_enabled' => true,
'features' => [
'kms',
'tproxy-net'
],
'salt' => '<string>',
'secure_time' => false,
'storage_fs' => 'zfs',
'swap_size' => '<string>',
'tproxy_enabled' => true
],
'compose_hash' => '<string>',
'encrypted_env' => '<string>',
'env_keys' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file"
payload := strings.NewReader("{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file")
.header("Content-Type", "application/json")
.body("{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"compose_file\": {\n \"name\": \"<string>\",\n \"allowed_envs\": [\n \"<string>\"\n ],\n \"bash_script\": \"<string>\",\n \"default_gateway_domain\": \"<string>\",\n \"docker_compose_file\": \"<string>\",\n \"key_provider_id\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"port_policy\": {\n \"ports\": [\n {\n \"port\": 123,\n \"pp\": false\n }\n ],\n \"restrict_mode\": false\n },\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"requirements\": {\n \"ephemeral_data_disk\": false,\n \"gpu_policy\": {\n \"allow_debug\": false,\n \"allow_devtools\": false,\n \"allow_insecure_boot\": false,\n \"attest_gpu\": true,\n \"rego\": \"<string>\"\n },\n \"health_check\": false,\n \"health_status_file\": \"<string>\",\n \"launch_token_hash\": \"<string>\",\n \"platforms\": [\n \"<string>\"\n ],\n \"tdx_measure_acpi_tables\": true\n },\n \"storage_discard\": true,\n \"verity_volumes\": [\n {\n \"source\": \"<string>\",\n \"target\": \"<string>\",\n \"verity_root\": \"<string>\"\n }\n ],\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\n \"swap_size\": \"<string>\",\n \"tproxy_enabled\": true\n },\n \"compose_hash\": \"<string>\",\n \"encrypted_env\": \"<string>\",\n \"env_keys\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyPath Parameters
Body
application/json
Complete compose file with hash
User-facing compose body. Cloud-owned fields are not accepted.
init_script is Cloud-managed. It is absent from the request schema and
any submitted value is dropped before validation so it cannot affect the
compose hash. Response models keep AppComposeV2 and still expose the
field read-only.
Show child attributes
Show child attributes
Response
Update initiated
Was this page helpful?