/
PH
phala
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Apps
27
CVMs
59
get
/api/v1/cvms
List CVMs
post
/api/v1/cvms
Create CVM (two-phase on one path)
get
/api/v1/cvms/paginated
List CVMs (paginated)
patch
/api/v1/cvms/instance-ids
Batch refresh CVM instance IDs
post
/api/v1/cvms/batch-stop
Batch stop CVMs
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
get
/api/v1/cvms/{cvm_id}/operation-status
Get operation status
get
/api/v1/cvms/{cvm_id}/state
Handle Get Cvm State
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
patch
/api/v1/cvms/{cvm_id}/instance-id
Refresh CVM instance ID
patch
/api/v1/cvms/{cvm_id}/name
Handle Update Cvm Name
patch
/api/v1/cvms/{cvm_id}/listed
Set Trust Center listing for the app
patch
/api/v1/cvms/{cvm_id}/scheduled-delete
Handle Update Cvm Scheduled Delete
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}/compose_file
Get raw compose file
post
/api/v1/cvms/{cvm_id}/compose_file
Submit compose file update
patch
/api/v1/cvms/{cvm_id}/compose_file
Trigger 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}/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
get
/api/v1/cvms/{cvm_id}/pre-launch-script/upgrade-status
Pre-launch script upgrade status
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
post
/api/v1/cvms/{cvm_id}/pre-launch-script/upgrade-to-latest-official
Upgrade pre-launch script to the latest official version
post
/api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeploy
Redeploy CVM from a specific revision
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}/annotations
Get CVM annotations
put
/api/v1/cvms/{cvm_id}/annotations
Replace CVM annotations
get
/api/v1/cvms/{cvm_id}/ssh-keys
List CVM SSH keys
put
/api/v1/cvms/{cvm_id}/ssh-keys
Replace CVM SSH keys
get
/api/v1/cvms/{cvm_id}/draft
Get staged CVM changes
delete
/api/v1/cvms/{cvm_id}/draft
Discard staged CVM changes
patch
/api/v1/cvms/{cvm_id}/draft
Stage CVM changes
post
/api/v1/cvms/{cvm_id}/draft/apply
Apply staged CVM changes
get
/api/v1/cvms/{cvm_id}/user_config
Get CVM user config
get
/api/v1/cvms/{cvm_id}/init-scripts
Get CVM init scripts
get
/api/v1/cvms/{cvm_id}/app-compose.json
Get app-compose.json
get
/api/v1/cvms/{cvm_id}/docker-compose.yml
Get Docker Compose file
get
/api/v1/cvms/{cvm_id}/operations
List CVM operations
post
/api/v1/cvms/{cvm_id}/operations/cancel
Cancel in-progress CVM operation
post
/api/v1/cvms/{cvm_id}/customize-domain-diagnose
Diagnose custom domain DNS
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)
get
/api/v1/apps/{app_id}/commit-instance
Get instance commit token info (no auth required)
KMS
1
public
20
SSH Keys
1
user
7
Webhooks
11
CVMs
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get firewall availability for this CVM's node
get
/api/v1/cvms/{cvm_id}/firewall-status
Nov 7, 2026
c71a8dc90391
Revision changes
info
added the optional property
capabilities
to the response with the
200
status