Create CVM (two-phase on one path)

curl --request POST \
  --url https://cloud-api.phala.com/api/v1/cvms \
  --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>"
    ],
    "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
  },
  "name": "<string>",
  "compose_file_raw": "<string>",
  "instance_type": "<string>",
  "vcpu": 123,
  "memory": 123,
  "disk_size": 123,
  "image": "<string>",
  "prefer_dev": true,
  "node": "<string>",
  "region": "<string>",
  "listed": false,
  "kms_id": "<string>",
  "kms": "phala",
  "kms_contract_id": "kc_0123abcd",
  "kms_contract": "<string>",
  "nonce": 123,
  "app_id": "<string>",
  "env_keys": [
    "<string>"
  ],
  "ports": [
    {
      "vm_port": 32768,
      "protocol": "tcp",
      "source_cidrs": [
        "<string>"
      ],
      "description": "<string>"
    }
  ],
  "encrypted_env": "<string>",
  "user_config": "<string>",
  "hugepages": false,
  "pin_numa": false,
  "gpus": {
    "gpus": [
      {
        "slot": "<string>",
        "product_id": "<string>"
      }
    ],
    "attach_mode": "listed"
  },
  "kms_urls": [
    "<string>"
  ],
  "gateway_urls": [
    "<string>"
  ],
  "skip_gateway": true,
  "init_scripts": [],
  "enabled_init_scripts_docker_cleanup": false,
  "launch_token": "<string>",
  "generate_launch_token": false,
  "enabled_guest_agent_access": true,
  "ssh_key_ids": [
    "<string>"
  ],
  "annotations": {}
}
'

import requests

url = "https://cloud-api.phala.com/api/v1/cvms"

payload = {
    "compose_file": {
        "name": "<string>",
        "allowed_envs": ["<string>"],
        "bash_script": "<string>",
        "default_gateway_domain": "<string>",
        "docker_compose_file": "<string>",
        "init_script": ["<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
    },
    "name": "<string>",
    "compose_file_raw": "<string>",
    "instance_type": "<string>",
    "vcpu": 123,
    "memory": 123,
    "disk_size": 123,
    "image": "<string>",
    "prefer_dev": True,
    "node": "<string>",
    "region": "<string>",
    "listed": False,
    "kms_id": "<string>",
    "kms": "phala",
    "kms_contract_id": "kc_0123abcd",
    "kms_contract": "<string>",
    "nonce": 123,
    "app_id": "<string>",
    "env_keys": ["<string>"],
    "ports": [
        {
            "vm_port": 32768,
            "protocol": "tcp",
            "source_cidrs": ["<string>"],
            "description": "<string>"
        }
    ],
    "encrypted_env": "<string>",
    "user_config": "<string>",
    "hugepages": False,
    "pin_numa": False,
    "gpus": {
        "gpus": [
            {
                "slot": "<string>",
                "product_id": "<string>"
            }
        ],
        "attach_mode": "listed"
    },
    "kms_urls": ["<string>"],
    "gateway_urls": ["<string>"],
    "skip_gateway": True,
    "init_scripts": [],
    "enabled_init_scripts_docker_cleanup": False,
    "launch_token": "<string>",
    "generate_launch_token": False,
    "enabled_guest_agent_access": True,
    "ssh_key_ids": ["<string>"],
    "annotations": {}
}
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>'],
      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
    },
    name: '<string>',
    compose_file_raw: '<string>',
    instance_type: '<string>',
    vcpu: 123,
    memory: 123,
    disk_size: 123,
    image: '<string>',
    prefer_dev: true,
    node: '<string>',
    region: '<string>',
    listed: false,
    kms_id: '<string>',
    kms: 'phala',
    kms_contract_id: 'kc_0123abcd',
    kms_contract: '<string>',
    nonce: 123,
    app_id: '<string>',
    env_keys: ['<string>'],
    ports: [
      {
        vm_port: 32768,
        protocol: 'tcp',
        source_cidrs: ['<string>'],
        description: '<string>'
      }
    ],
    encrypted_env: '<string>',
    user_config: '<string>',
    hugepages: false,
    pin_numa: false,
    gpus: {gpus: [{slot: '<string>', product_id: '<string>'}], attach_mode: 'listed'},
    kms_urls: ['<string>'],
    gateway_urls: ['<string>'],
    skip_gateway: true,
    init_scripts: [],
    enabled_init_scripts_docker_cleanup: false,
    launch_token: '<string>',
    generate_launch_token: false,
    enabled_guest_agent_access: true,
    ssh_key_ids: ['<string>'],
    annotations: {}
  })
};

fetch('https://cloud-api.phala.com/api/v1/cvms', 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",
  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>'
        ],
        '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
    ],
    'name' => '<string>',
    'compose_file_raw' => '<string>',
    'instance_type' => '<string>',
    'vcpu' => 123,
    'memory' => 123,
    'disk_size' => 123,
    'image' => '<string>',
    'prefer_dev' => true,
    'node' => '<string>',
    'region' => '<string>',
    'listed' => false,
    'kms_id' => '<string>',
    'kms' => 'phala',
    'kms_contract_id' => 'kc_0123abcd',
    'kms_contract' => '<string>',
    'nonce' => 123,
    'app_id' => '<string>',
    'env_keys' => [
        '<string>'
    ],
    'ports' => [
        [
                'vm_port' => 32768,
                'protocol' => 'tcp',
                'source_cidrs' => [
                                '<string>'
                ],
                'description' => '<string>'
        ]
    ],
    'encrypted_env' => '<string>',
    'user_config' => '<string>',
    'hugepages' => false,
    'pin_numa' => false,
    'gpus' => [
        'gpus' => [
                [
                                'slot' => '<string>',
                                'product_id' => '<string>'
                ]
        ],
        'attach_mode' => 'listed'
    ],
    'kms_urls' => [
        '<string>'
    ],
    'gateway_urls' => [
        '<string>'
    ],
    'skip_gateway' => true,
    'init_scripts' => [
        
    ],
    'enabled_init_scripts_docker_cleanup' => false,
    'launch_token' => '<string>',
    'generate_launch_token' => false,
    'enabled_guest_agent_access' => true,
    'ssh_key_ids' => [
        '<string>'
    ],
    'annotations' => [
        
    ]
  ]),
  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"

	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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\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")
  .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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms")

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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "compose_hash": "<string>",
  "compose_file": "<string>",
  "os_image_version": "<string>",
  "requires_gpu": true,
  "app_id": "<string>",
  "app_env_encrypt_pubkey": "<string>",
  "teepod_version": "<string>",
  "kms_info": {
    "id": "kms_0123abcd",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>",
    "ca_pubkey": "<string>",
    "k256_pubkey": "<string>"
  },
  "fmspc": "<string>",
  "device_id": "<string>",
  "os_image_hash": "<string>",
  "instance_type": "<string>",
  "token": "<string>"
}

CVMs

Create CVM (two-phase on one path)

Single entry point for CVM creation. Send a provision payload (compose_file + name) to prepare: validates the configuration, caches it for 14 days, and returns app_id, compose_hash, the env-encryption pubkey, and a commit token. Then send the token back with the encrypted environment to create the CVM. The legacy pair (POST /cvms/provision then POST /cvms with app_id + compose_hash) keeps working during the deprecation window.

POST

api

cvms

curl --request POST \
  --url https://cloud-api.phala.com/api/v1/cvms \
  --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>"
    ],
    "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
  },
  "name": "<string>",
  "compose_file_raw": "<string>",
  "instance_type": "<string>",
  "vcpu": 123,
  "memory": 123,
  "disk_size": 123,
  "image": "<string>",
  "prefer_dev": true,
  "node": "<string>",
  "region": "<string>",
  "listed": false,
  "kms_id": "<string>",
  "kms": "phala",
  "kms_contract_id": "kc_0123abcd",
  "kms_contract": "<string>",
  "nonce": 123,
  "app_id": "<string>",
  "env_keys": [
    "<string>"
  ],
  "ports": [
    {
      "vm_port": 32768,
      "protocol": "tcp",
      "source_cidrs": [
        "<string>"
      ],
      "description": "<string>"
    }
  ],
  "encrypted_env": "<string>",
  "user_config": "<string>",
  "hugepages": false,
  "pin_numa": false,
  "gpus": {
    "gpus": [
      {
        "slot": "<string>",
        "product_id": "<string>"
      }
    ],
    "attach_mode": "listed"
  },
  "kms_urls": [
    "<string>"
  ],
  "gateway_urls": [
    "<string>"
  ],
  "skip_gateway": true,
  "init_scripts": [],
  "enabled_init_scripts_docker_cleanup": false,
  "launch_token": "<string>",
  "generate_launch_token": false,
  "enabled_guest_agent_access": true,
  "ssh_key_ids": [
    "<string>"
  ],
  "annotations": {}
}
'

import requests

url = "https://cloud-api.phala.com/api/v1/cvms"

payload = {
    "compose_file": {
        "name": "<string>",
        "allowed_envs": ["<string>"],
        "bash_script": "<string>",
        "default_gateway_domain": "<string>",
        "docker_compose_file": "<string>",
        "init_script": ["<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
    },
    "name": "<string>",
    "compose_file_raw": "<string>",
    "instance_type": "<string>",
    "vcpu": 123,
    "memory": 123,
    "disk_size": 123,
    "image": "<string>",
    "prefer_dev": True,
    "node": "<string>",
    "region": "<string>",
    "listed": False,
    "kms_id": "<string>",
    "kms": "phala",
    "kms_contract_id": "kc_0123abcd",
    "kms_contract": "<string>",
    "nonce": 123,
    "app_id": "<string>",
    "env_keys": ["<string>"],
    "ports": [
        {
            "vm_port": 32768,
            "protocol": "tcp",
            "source_cidrs": ["<string>"],
            "description": "<string>"
        }
    ],
    "encrypted_env": "<string>",
    "user_config": "<string>",
    "hugepages": False,
    "pin_numa": False,
    "gpus": {
        "gpus": [
            {
                "slot": "<string>",
                "product_id": "<string>"
            }
        ],
        "attach_mode": "listed"
    },
    "kms_urls": ["<string>"],
    "gateway_urls": ["<string>"],
    "skip_gateway": True,
    "init_scripts": [],
    "enabled_init_scripts_docker_cleanup": False,
    "launch_token": "<string>",
    "generate_launch_token": False,
    "enabled_guest_agent_access": True,
    "ssh_key_ids": ["<string>"],
    "annotations": {}
}
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>'],
      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
    },
    name: '<string>',
    compose_file_raw: '<string>',
    instance_type: '<string>',
    vcpu: 123,
    memory: 123,
    disk_size: 123,
    image: '<string>',
    prefer_dev: true,
    node: '<string>',
    region: '<string>',
    listed: false,
    kms_id: '<string>',
    kms: 'phala',
    kms_contract_id: 'kc_0123abcd',
    kms_contract: '<string>',
    nonce: 123,
    app_id: '<string>',
    env_keys: ['<string>'],
    ports: [
      {
        vm_port: 32768,
        protocol: 'tcp',
        source_cidrs: ['<string>'],
        description: '<string>'
      }
    ],
    encrypted_env: '<string>',
    user_config: '<string>',
    hugepages: false,
    pin_numa: false,
    gpus: {gpus: [{slot: '<string>', product_id: '<string>'}], attach_mode: 'listed'},
    kms_urls: ['<string>'],
    gateway_urls: ['<string>'],
    skip_gateway: true,
    init_scripts: [],
    enabled_init_scripts_docker_cleanup: false,
    launch_token: '<string>',
    generate_launch_token: false,
    enabled_guest_agent_access: true,
    ssh_key_ids: ['<string>'],
    annotations: {}
  })
};

fetch('https://cloud-api.phala.com/api/v1/cvms', 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",
  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>'
        ],
        '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
    ],
    'name' => '<string>',
    'compose_file_raw' => '<string>',
    'instance_type' => '<string>',
    'vcpu' => 123,
    'memory' => 123,
    'disk_size' => 123,
    'image' => '<string>',
    'prefer_dev' => true,
    'node' => '<string>',
    'region' => '<string>',
    'listed' => false,
    'kms_id' => '<string>',
    'kms' => 'phala',
    'kms_contract_id' => 'kc_0123abcd',
    'kms_contract' => '<string>',
    'nonce' => 123,
    'app_id' => '<string>',
    'env_keys' => [
        '<string>'
    ],
    'ports' => [
        [
                'vm_port' => 32768,
                'protocol' => 'tcp',
                'source_cidrs' => [
                                '<string>'
                ],
                'description' => '<string>'
        ]
    ],
    'encrypted_env' => '<string>',
    'user_config' => '<string>',
    'hugepages' => false,
    'pin_numa' => false,
    'gpus' => [
        'gpus' => [
                [
                                'slot' => '<string>',
                                'product_id' => '<string>'
                ]
        ],
        'attach_mode' => 'listed'
    ],
    'kms_urls' => [
        '<string>'
    ],
    'gateway_urls' => [
        '<string>'
    ],
    'skip_gateway' => true,
    'init_scripts' => [
        
    ],
    'enabled_init_scripts_docker_cleanup' => false,
    'launch_token' => '<string>',
    'generate_launch_token' => false,
    'enabled_guest_agent_access' => true,
    'ssh_key_ids' => [
        '<string>'
    ],
    'annotations' => [
        
    ]
  ]),
  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"

	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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\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")
  .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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud-api.phala.com/api/v1/cvms")

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\": [\n      \"<string>\"\n    ],\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  \"name\": \"<string>\",\n  \"compose_file_raw\": \"<string>\",\n  \"instance_type\": \"<string>\",\n  \"vcpu\": 123,\n  \"memory\": 123,\n  \"disk_size\": 123,\n  \"image\": \"<string>\",\n  \"prefer_dev\": true,\n  \"node\": \"<string>\",\n  \"region\": \"<string>\",\n  \"listed\": false,\n  \"kms_id\": \"<string>\",\n  \"kms\": \"phala\",\n  \"kms_contract_id\": \"kc_0123abcd\",\n  \"kms_contract\": \"<string>\",\n  \"nonce\": 123,\n  \"app_id\": \"<string>\",\n  \"env_keys\": [\n    \"<string>\"\n  ],\n  \"ports\": [\n    {\n      \"vm_port\": 32768,\n      \"protocol\": \"tcp\",\n      \"source_cidrs\": [\n        \"<string>\"\n      ],\n      \"description\": \"<string>\"\n    }\n  ],\n  \"encrypted_env\": \"<string>\",\n  \"user_config\": \"<string>\",\n  \"hugepages\": false,\n  \"pin_numa\": false,\n  \"gpus\": {\n    \"gpus\": [\n      {\n        \"slot\": \"<string>\",\n        \"product_id\": \"<string>\"\n      }\n    ],\n    \"attach_mode\": \"listed\"\n  },\n  \"kms_urls\": [\n    \"<string>\"\n  ],\n  \"gateway_urls\": [\n    \"<string>\"\n  ],\n  \"skip_gateway\": true,\n  \"init_scripts\": [],\n  \"enabled_init_scripts_docker_cleanup\": false,\n  \"launch_token\": \"<string>\",\n  \"generate_launch_token\": false,\n  \"enabled_guest_agent_access\": true,\n  \"ssh_key_ids\": [\n    \"<string>\"\n  ],\n  \"annotations\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "compose_hash": "<string>",
  "compose_file": "<string>",
  "os_image_version": "<string>",
  "requires_gpu": true,
  "app_id": "<string>",
  "app_env_encrypt_pubkey": "<string>",
  "teepod_version": "<string>",
  "kms_info": {
    "id": "kms_0123abcd",
    "url": "<string>",
    "version": "<string>",
    "slug": "<string>",
    "chain_id": 123,
    "kms_contract_address": "<string>",
    "gateway_app_id": "<string>",
    "ca_pubkey": "<string>",
    "k256_pubkey": "<string>"
  },
  "fmspc": "<string>",
  "device_id": "<string>",
  "os_image_hash": "<string>",
  "instance_type": "<string>",
  "token": "<string>"
}

Body

application/json

ProvisionDstackAppRequestV2
ProvisionDstackAppRequestV2
CommitCvmCreateRequest
CreateTappRequest

Request for provisioning a DStack app with automatic resource matching.

Most fields are optional and will be automatically determined by the resource matching logic in preflight_dstack_app. Only compose_file and name are required.

compose_file

AppComposeV2 · object

required

Show child attributes

name

string

required

CVM name (used as hostname): 5-63 chars, must start with letter, can contain letters/numbers/hyphens

compose_file_raw

string

A whole app-compose JSON file, sent instead of compose_file. Phala Cloud parses it with the same rules as compose_file and serializes it the same way, so the deployed bytes and compose hash match the structured form, not the sent bytes. Needs the compose_advanced feature flag.

instance_type

string | null

vcpu

integer | null

memory

integer | null

disk_size

integer | null

image

string | null

prefer_dev

boolean | null

For OS images before 0.6.0, True selects dev and False selects non-dev. Ignored for unified images (0.6.0 or later). When None, inferred from the image name or defaults to dev.

node

string | null

Physical node name

Minimum string length: 1

region

string | null

listed

boolean

default:false

kms_id

string | null

kms

enum<string> | null

default:phala

Available options:

phala,

ethereum,

base,

local,

legacy

kms_contract_id

string<hashid> | null

A hashed identifier that maps to an internal database ID

Pattern: ^kc_.+

Example:

"kc_0123abcd"

kms_contract

string | null

nonce

integer | null

Optional nonce for deterministic app_id generation. When provided, app_id must also be provided. System will verify: app_id == get_create_address(team_wallet, nonce)

app_id

string | null

Optional app_id for manual specification. Required when nonce is provided. Only works with PHALA KMS.

env_keys

string[]

Allowed encrypted environment variable names. When compose_file does not declare allowed_envs, or sends an empty list, these names populate compose_file.allowed_envs for the guest allowlist.

ports

CreateTimePortMappingEntry · object[] | null

Show child attributes

encrypted_env

string | null

user_config

string | null

hugepages

boolean

default:false

pin_numa

boolean

default:false

gpus

GpuConfig · object | null

Show child attributes

kms_urls

string[]

gateway_urls

string[]

skip_gateway

boolean | null

Deploy without dstack-gateway. Turns the gateway off in compose_file when it does not set gateway_enabled/tproxy_enabled; rejected when compose_file enables the gateway.

key_provider_mode

enum<string> | null

Key provider mode. 'local' enables the local key provider in compose_file (and turns off KMS and the gateway where compose_file does not set them); rejected when compose_file sets key_provider or local_key_provider_enabled the other way.

Available options:

kms,

local

init_scripts

enum<string>[]

Platform-owned init scripts to run on every boot, as slugs: docker_cleanup erases all local container-runtime stores (images, volumes, all containerd namespaces) and needs OS 0.6.x, ext4 storage and the docker-compose runner; env_merge merges encrypted env on boot, needs OS 0.6.0 or newer and the managed_env_create feature flag. Phala Cloud fixes the run order (docker_cleanup, then env_merge). The deprecated object form {"env_merge": bool} is still accepted. GET /cvms/{cvm_id}/init-scripts shows what an existing CVM runs.

Available options:

docker_cleanup,

env_merge

enabled_init_scripts_docker_cleanup

boolean

default:false

deprecated

Deprecated: send init_scripts: ["docker_cleanup"]. True adds docker_cleanup to init_scripts.

launch_token

string | null

Launch token (at least 32 bytes) the guest requires on every boot before key provisioning. Phala Cloud writes its hash into compose_file.requirements.launch_token_hash and stores the token on the app. For an existing app it must equal the app's token. Needs dstack OS 0.6.0 or newer. Phala Cloud and the node operator can read the token: it protects only against parties who know the public compose.

generate_launch_token

boolean

default:false

Gate the CVM with a launch token Phala Cloud generates for a new app, or with the app's existing token. A newly generated token is returned once, in the create (commit) response.

enabled_guest_agent_access

boolean | null

Restrict the guest agent (port 8090) to Phala Cloud by sending false. Omit it to leave the app unchanged; a new app starts unrestricted. Sending true never relaxes an existing restriction: it is rejected with ERR-03-030 when the app is already restricted, because relaxing requires Phala Cloud support.

ssh_key_ids

string[] | null

SSH key hashids to authorize on the new CVM. Must belong to a member of the workspace. Omit to authorize all of your own active keys.

annotations

Annotations · object

Opaque key/value metadata for host-side tooling, stored by the dstack VMM with the VM. Not passed to the guest, not measured, and not part of the compose hash: attestation does not cover it, so do not rely on it for security. A non-empty map requires the cvm_annotations feature flag (ERR-03-049) and a node running dstack VMM 0.6.1 or newer (ERR-03-050). Keys must not be empty. Phala Cloud keeps no copy as CVM state and never copies or restores it (a replica starts without it, a relocated CVM keeps what its VMM manifest carries); this create request is recorded in the audit log.

Show child attributes

Response

Prepare returns provision data with a token; commit returns the created CVM

ProvisionDstackAppResponseV2
CreatedVM

Response from DStack app preflight checks containing provisioning details.

compose_hash

string

required

compose_file

string

required

Exact final app-compose JSON bound to compose_hash

os_image_version

string

required

requires_gpu

boolean

required

app_id

string | null

app_env_encrypt_pubkey

string | null

teepod_version

string | null

kms_info

KMSInfo · object | null

KMS instance information.

Show child attributes

fmspc

string | null

device_id

string | null

os_image_hash

string | null

instance_type

string | null

token

string | null

Commit token for POST /cvms. Present for same-path two-phase create.