Provision compose file update

Validates new compose file and returns compose_hash for on-chain registration. Cache expires after 14 days.

POST /api/v1/cvms/{cvm_id}/compose_file/provision

Provision compose file update

cURL

curl --request POST \
  --url https://cloud-api.phala.com/api/v1/cvms/{cvm_id}/compose_file/provision \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "allowed_envs": [
    "<string>"
  ],
  "bash_script": "<string>",
  "default_gateway_domain": "<string>",
  "docker_compose_file": "<string>",
  "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,
  "update_env_vars": false
}
'

200

{
  "app_id": "<string>",
  "compose_hash": "<string>",
  "device_id": "<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>"
  },
  "compose_hash_registered": false,
  "compose_unchanged": false
}

Path Parameters

cvm_id · string · required

Body

application/json

Updated compose configuration

name · string · required

allowed_envs · string[]

bash_script · string | null

default_gateway_domain · string | null

docker_compose_file · string | null

key_provider · enum<string> | null

Available options: none, kms, local, tpm

key_provider_id · string | null

kms_enabled · boolean · default: true

local_key_provider_enabled · boolean · default: false

manifest_version · integer string · default: 2

no_instance_id · boolean · default: false

port_policy · PortPolicy · object | null

Per-instance port policy declared in app-compose. >= v0.5.9.

restrict_mode=True with an empty ports list is a valid lockdown. Field order is alphabetical for compose_hash stability.

Show child attributes

pre_launch_script · string | null

public_logs · boolean · default: true

public_sysinfo · boolean · default: true

public_tcbinfo · boolean · default: true

runner · string · default: docker-compose

requirements · Requirements · object | null

Guest requirements (dstack >= 0.6.0), mirroring dstack_types::Requirements.

Only keys the caller sent are serialized (see AppComposeV2._serialize_requirements), so a default-valued key sent explicitly is measured and an unsent key is never added. Fields are declared alphabetically to match the canonical JSON layout.

Show child attributes

storage_discard · boolean | null

event_log_version · enum<integer> | null

Available options: 1, 2

snapshotter · enum<string> | null

Available options: overlayfs, stargz

verity_volumes · VerityVolume · object[] | null

Show child attributes

gateway_enabled · boolean · default: true

features · string[]

salt · string | null

secure_time · boolean · default: false

storage_fs · Storage Fs · string Storage Fs · string · default: zfs

Allowed value: "ext4"

swap_size · string | null

tproxy_enabled · boolean · default: true

update_env_vars · boolean · default: false

Whether to also update allowed_envs

Response

200

application/json

Provision response with compose_hash and KMS info

API response model for compose file provision

app_id · string · required

compose_hash · string · required

device_id · string | null

kms_info · KMSInfo · object | null

KMS instance information.

Show child attributes

compose_hash_registered · boolean · default: false

compose_unchanged · boolean · default: false