# Phala Network CVMs API

**Canonical:** https://apis.io/apis/phala/phala-cvms-api/  
**Provider:** Phala Network — https://apis.io/providers/phala/  
**Base URL:** https://cloud-api.phala.com  
**Documentation:** https://docs.phala.com/phala-cloud/phala-cloud-api/overview

Phala Network CVMs API is one of 11 APIs that [Phala Network](https://apis.io/providers/phala/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include CVMs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

Confidential Virtual Machine (CVM) lifecycle management on Phala Network

## Operations (51)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/cvms/provision/eliza` | Provision Eliza app |
| POST | `/api/v1/cvms/provision` | Provision DStack app |
| POST | `/api/v1/cvms/workload` | Create GPU workload CVM |
| POST | `/api/v1/cvms` | Create CVM from provision |
| GET | `/api/v1/cvms` | List CVMs |
| POST | `/api/v1/cvms/eliza` | Create Eliza from provision |
| GET | `/api/v1/cvms/{cvm_id}/compose_file` | Get raw compose file |
| PATCH | `/api/v1/cvms/{cvm_id}/compose_file` | Trigger compose file update |
| POST | `/api/v1/cvms/{cvm_id}/compose_file` | Submit compose file update |
| POST | `/api/v1/cvms/{cvm_id}/compose_file/provision` | Provision compose file update |
| POST | `/api/v1/cvms/{cvm_id}/replicas` | Replicate CVM |
| GET | `/api/v1/cvms/{cvm_id}/operations` | List CVM operations |
| POST | `/api/v1/cvms/{cvm_id}/operations/cancel` | Cancel in-progress CVM operation |
| GET | `/api/v1/cvms/{cvm_id}/docker-compose.yml` | Get Docker Compose file |
| GET | `/api/v1/cvms/{cvm_id}/pre-launch-script` | Get pre-launch script |
| PATCH | `/api/v1/cvms/{cvm_id}/pre-launch-script` | Update pre-launch script |
| GET | `/api/v1/cvms/{cvm_id}/available-os-images` | List available OS images |
| PATCH | `/api/v1/cvms/{cvm_id}/os-image` | Update OS image |
| PATCH | `/api/v1/cvms/{cvm_id}/envs` | Update environment variables |
| PATCH | `/api/v1/cvms/{cvm_id}/docker-compose` | Update Docker Compose file |
| POST | `/api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeploy` | Redeploy CVM from a specific revision |
| PATCH | `/api/v1/cvms/instance-ids` | Batch refresh CVM instance IDs |
| GET | `/api/v1/cvms/paginated` | List CVMs (paginated) |
| PATCH | `/api/v1/cvms/{cvm_id}/instance-id` | Refresh CVM instance ID |
| GET | `/api/v1/cvms/{cvm_id}` | Get CVM details |
| DELETE | `/api/v1/cvms/{cvm_id}` | Delete CVM |
| PATCH | `/api/v1/cvms/{cvm_id}` | Update CVM |
| GET | `/api/v1/cvms/{cvm_id}/stats` | Get CVM system stats |
| GET | `/api/v1/cvms/{cvm_id}/attestation` | Get CVM attestation |
| GET | `/api/v1/cvms/{cvm_id}/network` | Get CVM network info |
| POST | `/api/v1/cvms/{cvm_id}/start` | Start CVM |
| POST | `/api/v1/cvms/{cvm_id}/shutdown` | Shutdown CVM |
| POST | `/api/v1/cvms/{cvm_id}/stop` | Force stop CVM |
| POST | `/api/v1/cvms/{cvm_id}/restart` | Restart CVM |
| GET | `/api/v1/cvms/{cvm_id}/operation-status` | Get operation status |
| PATCH | `/api/v1/cvms/{cvm_id}/name` | Handle Update Cvm Name |
| PATCH | `/api/v1/cvms/{cvm_id}/listed` | Handle Update Cvm Listed |
| PATCH | `/api/v1/cvms/{cvm_id}/scheduled-delete` | Handle Update Cvm Scheduled Delete |
| POST | `/api/v1/cvms/batch-stop` | Batch stop CVMs |
| POST | `/api/v1/status/batch` | Handle Batch Cvm Status |
| GET | `/api/v1/cvms/{cvm_id}/state` | Handle Get Cvm State |
| GET | `/api/v1/cvms/{cvm_id}/network-config` | Get network configuration |
| PATCH | `/api/v1/cvms/{cvm_id}/network-config` | Update KMS/Gateway URLs |
| GET | `/api/v1/cvms/{cvm_id}/ports` | Get port mappings |
| PUT | `/api/v1/cvms/{cvm_id}/ports` | Set port mappings |
| GET | `/api/v1/cvms/{cvm_id}/firewall-status` | Get firewall availability for this CVM's node |
| GET | `/api/v1/cvms/{cvm_id}/commit-update` | Get commit token info (no auth required) |
| POST | `/api/v1/cvms/{cvm_id}/commit-update` | Commit CVM update (token-based, no auth required) |
| POST | `/api/v1/cvms/{cvm_id}/commit-replica` | Commit CVM replica (token-based, no auth required) |
| POST | `/api/v1/cvms/{cvm_id}/customize-domain-diagnose` | Diagnose custom domain DNS |
| GET | `/api/v1/cvms/{cvm_id}/user_config` | Get CVM user config |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/phala/openapi/phala-cvms-api-openapi.yml
- **Documentation** — https://docs.phala.com/phala-cloud/phala-cloud-api/overview
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-teehouse-api-routes-cvms-management-cvm-basic-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-cvminfo-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-provision-dstack-app-request-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-teehouse-api-routes-cvms-v20260121-schemas-cvminfo-schema.json
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-update-cvm-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/phala/json-schema/phala-provision-compose-file-update-request-schema.json

## Other Phala Network APIs (10)

- [Phala Private AI API](https://apis.io/apis/phala/phala-private-ai-api/)
- [Phala Network Apps API](https://apis.io/apis/phala/phala-apps-api/)
- [Phala Network Apps Kms Info API](https://apis.io/apis/phala/phala-apps-kms-info-api/)
- [Phala Network Apps Pending Updates API](https://apis.io/apis/phala/phala-apps-pending-updates-api/)
- [Phala Network Attestations API](https://apis.io/apis/phala/phala-attestations-api/)
- [Phala Network Cvms Network Config API](https://apis.io/apis/phala/phala-cvms-network-config-api/)
- [Phala Network Instance Types API](https://apis.io/apis/phala/phala-instance-types-api/)
- [Phala Network KMS API](https://apis.io/apis/phala/phala-kms-api/)
- [Phala Network SSH Keys API](https://apis.io/apis/phala/phala-ssh-keys-api/)
- [Phala Network Webhooks API](https://apis.io/apis/phala/phala-webhooks-api/)

## Tags

CVMs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/phala/phala-cvms-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/phala/.