/

Docs
History
Schema
Generate

Filter operations

Apps27

CVMs59

get/api/v1/cvmsList CVMs
post/api/v1/cvmsCreate CVM (two-phase on one path)
get/api/v1/cvms/paginatedList CVMs (paginated)
patch/api/v1/cvms/instance-idsBatch refresh CVM instance IDs
post/api/v1/cvms/batch-stopBatch stop CVMs
get/api/v1/cvms/{cvm_id}/statsGet CVM system stats
get/api/v1/cvms/{cvm_id}/attestationGet CVM attestation
get/api/v1/cvms/{cvm_id}/networkGet CVM network info
get/api/v1/cvms/{cvm_id}/operation-statusGet operation status
get/api/v1/cvms/{cvm_id}/stateHandle 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-idRefresh CVM instance ID
patch/api/v1/cvms/{cvm_id}/nameHandle Update Cvm Name
patch/api/v1/cvms/{cvm_id}/listedSet Trust Center listing for the app
patch/api/v1/cvms/{cvm_id}/scheduled-deleteHandle Update Cvm Scheduled Delete
post/api/v1/cvms/{cvm_id}/startStart CVM
post/api/v1/cvms/{cvm_id}/shutdownShutdown CVM
post/api/v1/cvms/{cvm_id}/stopForce stop CVM
post/api/v1/cvms/{cvm_id}/restartRestart CVM
get/api/v1/cvms/{cvm_id}/compose_fileGet raw compose file
post/api/v1/cvms/{cvm_id}/compose_fileSubmit compose file update
patch/api/v1/cvms/{cvm_id}/compose_fileTrigger compose file update
post/api/v1/cvms/{cvm_id}/compose_file/provisionProvision compose file update
post/api/v1/cvms/{cvm_id}/replicasReplicate CVM
get/api/v1/cvms/{cvm_id}/available-os-imagesList available OS images
patch/api/v1/cvms/{cvm_id}/os-imageUpdate OS image
patch/api/v1/cvms/{cvm_id}/envsUpdate environment variables
patch/api/v1/cvms/{cvm_id}/docker-composeUpdate Docker Compose file
get/api/v1/cvms/{cvm_id}/pre-launch-script/upgrade-statusPre-launch script upgrade status
get/api/v1/cvms/{cvm_id}/pre-launch-scriptGet pre-launch script
patch/api/v1/cvms/{cvm_id}/pre-launch-scriptUpdate pre-launch script
post/api/v1/cvms/{cvm_id}/pre-launch-script/upgrade-to-latest-officialUpgrade pre-launch script to the latest official version
post/api/v1/cvms/{cvm_id}/revisions/{revision_id}/redeployRedeploy CVM from a specific revision
get/api/v1/cvms/{cvm_id}/network-configGet network configuration
patch/api/v1/cvms/{cvm_id}/network-configUpdate KMS/Gateway URLs
get/api/v1/cvms/{cvm_id}/portsGet port mappings
put/api/v1/cvms/{cvm_id}/portsSet port mappings
get/api/v1/cvms/{cvm_id}/firewall-statusGet firewall availability for this CVM's node
get/api/v1/cvms/{cvm_id}/annotationsGet CVM annotations
put/api/v1/cvms/{cvm_id}/annotationsReplace CVM annotations
get/api/v1/cvms/{cvm_id}/ssh-keysList CVM SSH keys
put/api/v1/cvms/{cvm_id}/ssh-keysReplace CVM SSH keys
get/api/v1/cvms/{cvm_id}/draftGet staged CVM changes
delete/api/v1/cvms/{cvm_id}/draftDiscard staged CVM changes
patch/api/v1/cvms/{cvm_id}/draftStage CVM changes
post/api/v1/cvms/{cvm_id}/draft/applyApply staged CVM changes
get/api/v1/cvms/{cvm_id}/user_configGet CVM user config
get/api/v1/cvms/{cvm_id}/init-scriptsGet CVM init scripts
get/api/v1/cvms/{cvm_id}/app-compose.jsonGet app-compose.json
get/api/v1/cvms/{cvm_id}/docker-compose.ymlGet Docker Compose file
get/api/v1/cvms/{cvm_id}/operationsList CVM operations
post/api/v1/cvms/{cvm_id}/operations/cancelCancel in-progress CVM operation
post/api/v1/cvms/{cvm_id}/customize-domain-diagnoseDiagnose custom domain DNS
get/api/v1/cvms/{cvm_id}/commit-updateGet commit token info (no auth required)
post/api/v1/cvms/{cvm_id}/commit-updateCommit CVM update (token-based, no auth required)
post/api/v1/cvms/{cvm_id}/commit-replicaCommit CVM replica (token-based, no auth required)
get/api/v1/apps/{app_id}/commit-instanceGet instance commit token info (no auth required)

KMS1

public20

SSH Keys1

user7

Webhooks11

CVMs

Changes to Get CVM annotations

get/api/v1/cvms/{cvm_id}/annotations

Nov 7, 2026c71a8dc90391 Revision changes
- info
  endpoint added