CVM Deployment via API

Deploy CVMs programmatically using the Phala Cloud API. The API exposes the same backend used by the Phala Cloud dashboard, so anything you can do in the UI you can automate via API.

Authentication

All API requests require an API key passed in the X-API-Key header. Generate your key at Settings → API Keys in the Phala Cloud dashboard.

Deployment Flow

CVM deployment follows a two-phase provision → commit workflow:

Provision — reserve resources and receive a compose_hash and app_env_encrypt_pubkey
Commit — finalize the deployment with the provisioned values

Browse the interactive API reference for full request/response details on each endpoint.

KMS Types

Feature	Built-in KMS	On-chain KMS
Setup	Automatic	Requires smart contract deployment
App ID	Derived from compose hash	Contract address
Best for	Development and standard production	Decentralized access control

For on-chain KMS details, see the On-chain KMS guide.

Using SDKs

For a simpler experience, use one of the official SDKs instead of raw API calls:

JavaScript SDK

@phala/cloud — provision, deploy, and manage CVMs

Python SDK

phala-cloud — sync and async client

Go SDK

github.com/Phala-Network/phala-cloud/sdks/go

Apps

Authentication
Deployment Flow
KMS Types
Using SDKs

Phala Cloud

​Authentication

​Deployment Flow

​KMS Types

​Using SDKs