Phala Network

Phala Network CVMs API

Confidential Virtual Machine (CVM) lifecycle management on Phala Network

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 51

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 #

Documentation

📖
Documentation
https://docs.phala.com/phala-cloud/phala-cloud-api/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/phala/openapi/phala-cvms-api-openapi.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/phala:phala-cvms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

phala-cvms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Phala Cloud CVMs API
  version: 0.1.0
  description: Confidential Virtual Machine (CVM) lifecycle management on Phala Network
servers:
- url: https://cloud-api.phala.com
tags:


# --- truncated at 32 KB (154 KB total) ---
# Full source: https://artifacts.apis.io/phala/openapi/phala-cvms-api-openapi.yml