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>",
"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
},
"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>",
"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
},
"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>',
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
},
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>',
'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
],
'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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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>",
"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
},
"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>",
"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
},
"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>',
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
},
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>',
'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
],
'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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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 \"init_script\": \"<string>\",\n \"kms_enabled\": true,\n \"local_key_provider_enabled\": false,\n \"manifest_version\": 2,\n \"no_instance_id\": false,\n \"pre_launch_script\": \"<string>\",\n \"public_logs\": true,\n \"public_sysinfo\": true,\n \"public_tcbinfo\": true,\n \"runner\": \"docker-compose\",\n \"gateway_enabled\": true,\n \"features\": [\n \"kms\",\n \"tproxy-net\"\n ],\n \"salt\": \"<string>\",\n \"secure_time\": false,\n \"storage_fs\": \"zfs\",\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_bodyWas this page helpful?
⌘I

