CVMs

Create CVM (two-phase on one path)

Changed on Nov 7, 2026

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/v1/cvms

Request

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

Request body

Example request

{
  "kms_contract_id": "kc_0123abcd"
}

Response

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

Example response

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

Changes

Nov 7, 2026c71a8dc90391 Revision changes
- breaking
  the request's body type changed from object to no type
- breaking
  added to the response body oneOf list for the response status
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id handle_create_cvm_from_povision_api_v1_cvms_post removed and replaced with handle_create_cvm_api_v1_cvms_post
- info
  added to the request body oneOf list
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history