PHphala
CVMs

Provision compose file update

Changed on

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

Request

Path parameters

cvm_idstring required

Request body

allowed_envsstring[]
bash_scriptstring nullable
default_gateway_domainstring nullable
docker_compose_filestring nullable
key_provider'none' | 'kms' | 'local' | 'tpm' nullable
key_provider_idstring nullable
kms_enabledboolean
local_key_provider_enabledboolean
namestring required
no_instance_idboolean
pre_launch_scriptstring nullable
public_logsboolean
public_sysinfoboolean
public_tcbinfoboolean
runnerstring
storage_discardboolean nullable
event_log_version1 | 2 nullable
snapshotter'overlayfs' | 'stargz' nullable
gateway_enabledboolean
featuresstring[]
saltstring nullable
secure_timeboolean
swap_sizestring nullable
tproxy_enabledboolean
update_env_varsboolean

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
compose_unchangedboolean

Example response

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

Changes

  • c71a8dc90391Revision changes
    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types string to media type application/json

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status