Skip to main content
PATCH
/
api
/
v1
/
cvms
/
instance-ids
Batch refresh CVM instance IDs
curl --request PATCH \
  --url https://cloud-api.phala.com/api/v1/cvms/instance-ids \
  --header 'Content-Type: application/json' \
  --data '
{
  "cvm_ids": [
    "<string>"
  ],
  "running_only": true,
  "missing_only": true,
  "overwrite": false,
  "limit": 100,
  "dry_run": false
}
'
{
  "total": 123,
  "scanned": 123,
  "updated": 123,
  "unchanged": 123,
  "skipped": 123,
  "conflicts": 123,
  "errors": 123,
  "items": [
    {
      "cvm_id": 123,
      "identifier": "<string>",
      "status": "updated",
      "old_instance_id": "<string>",
      "new_instance_id": "<string>",
      "source": "none",
      "verified_with_gateway": false,
      "reason": "<string>"
    }
  ]
}

Body

application/json
cvm_ids
string[] | null

Optional CVM identifiers. Admin can pass cross-workspace IDs.

running_only
boolean
default:true

Only process CVMs with status=running

missing_only
boolean
default:true

Only process CVMs with missing instance_id

overwrite
boolean
default:false

Overwrite existing instance_id when different

limit
integer
default:100

Max CVMs to process in one request

Required range: 1 <= x <= 500
dry_run
boolean
default:false

Preview changes without persisting

Response

Successful Response

total
integer
required
scanned
integer
required
updated
integer
required
unchanged
integer
required
skipped
integer
required
conflicts
integer
required
errors
integer
required
items
InstanceIdRefreshResult · object[]
required