---
title: "Refresh CVM instance ID"
method: PATCH
path: "/api/v1/cvms/{cvm_id}/instance-id"
tags: ["CVMs"]
---

# Refresh CVM instance ID

`PATCH /api/v1/cvms/{cvm_id}/instance-id`

Resolve and persist instance_id for a CVM. Default behavior only backfills missing values.

## Path parameters

- `cvm_id` string, required

## Request body

- InstanceIdRefreshRequest
  - `overwrite` boolean — Overwrite existing instance_id when different
  - `dry_run` boolean — Preview changes without persisting

## Response `200`

Successful Response

- InstanceIdRefreshResult
  - `cvm_id` integer, required
  - `identifier` string, required
  - `status` 'updated' | 'unchanged' | 'skipped' | 'conflict' | 'error', required
  - `old_instance_id` string, nullable
  - `new_instance_id` string, nullable
  - `source` 'teepod_state' | 'teepod_info' | 'gateway' | 'none'
  - `verified_with_gateway` boolean
  - `reason` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/phala/apis/phala-cloud-api.md) · [All operations](https://skmtc.net/phala/apis/phala-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/phala/phala-cloud-api/versions/83c6ae62e860/schema)