Sign in

v1

latestOpenAPI 3.1.02026-07-26102158206.8 KB
CVMs

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

Path parameters

cvm_idstring required

Request body

allowed_envsstring[]
bash_scriptstring nullable
default_gateway_domainstring nullable
docker_compose_filestring nullable
init_scriptstring nullable
kms_enabledboolean
local_key_provider_enabledboolean
manifest_versioninteger
namestring required
no_instance_idboolean
pre_launch_scriptstring nullable
public_logsboolean
public_sysinfoboolean
public_tcbinfoboolean
runnerstring
gateway_enabledboolean
featuresstring[]
saltstring nullable
secure_timeboolean
tproxy_enabledboolean
update_env_varsboolean nullable

Whether to also update allowed_envs

Response

Provision response with compose_hash and KMS info

app_idstring required
device_idstring nullable
compose_hashstring required
compose_hash_registeredboolean

Example response

{
  "kms_info": {
    "id": "kms_0123abcd"
  }
}