Skip to main content
POST
/
api
/
v1
/
cvms
/
batch-stop
Batch stop CVMs
curl --request POST \
  --url https://cloud-api.phala.com/api/v1/cvms/batch-stop \
  --header 'Content-Type: application/json' \
  --data '
{
  "cvm_ids": [
    "<string>"
  ]
}
'
{
  "total": 123,
  "stopped": 123,
  "skipped": 123,
  "errors": [
    {
      "cvm_id": "<string>",
      "error": "<string>"
    }
  ]
}

Body

application/json

Request to batch stop multiple CVMs.

​
cvm_ids
string[]
required

List of CVM hash IDs to stop

Maximum array length: 50

Response

Batch stop summary

Summary of batch stop operation.

​
total
integer
required

Total CVMs requested

​
stopped
integer
required

CVMs successfully scheduled for stop

​
skipped
integer
required

CVMs skipped (in_progress, no vm_uuid, GPU rental managed)

​
errors
BatchStopErrorEntry · object[]

CVMs that failed to stop