Compute

Rename a VM

Change the display name of a VM. Does not change the guest hostname.

patch/agent/compute/vms/{id}

Request

  • Base URL: https://edge.network
  • URL: https://edge.network/agent/compute/vms/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

VM id.

Headers

X-Dry-Run'true' | 'false'

Set to "true" to preview the operation (validation, cost, plan) without making changes.

Idempotency-Keystring

Unique key for safe retries. Repeating a request with the same key returns the original response instead of re-executing.

Request body

namestring required

New display name.

Response

Success.

tell_userstring

Human-readable summary of what happened, for the agent to relay to its operator.

Changes

No recorded changes to this operation across all 1 revision of this API.