CVMs

Update Docker Compose file

Replaces the docker-compose.yml and restarts the CVM. For contract-owned KMS, requires two-phase flow with on-chain hash registration.

patch/api/v1/cvms/{cvm_id}/docker-compose

Request

Base URL
https://cloud-api.phala.com
Auth
none declared
TypeScript
https://skmtc.dev/phala/apis/phala-cloud-api/docs/api/v1/cvms/:cvm_id/docker-compose/patch.ts
A function with typed inputs. Its response is checked against the schema.

cvm_idstring required

X-Compose-Hashstring nullable

Compose hash from Phase 1 response

X-Transaction-Hashstring nullable

Transaction hash proving on-chain registration

filestring binary nullable

Docker Compose YAML file to upload

Update initiated, track via correlation_id

unknown required

No recorded changes to this operation across all 3 revisions of this API.