Reset password
POST/vms/:vm_id/password/reset
Changes the password of an existing OS user through the guest agent. If login is omitted or null, the actual installation login is used (normally admin for Windows and root for Linux). If that login is unknown, HTTP 409 with code vm_login_required asks for an explicit login. An explicitly supplied login is preserved. Windows password policy is enforced by the guest OS. A working guest agent is required. A failed or unconfirmed operation does not prove the password remained unchanged: check access before another command.
Send a unique Idempotency-Key for each intended action. If the response is lost, retry with the same key and unchanged parameters; do not create a new key for the same purchase.
HTTP 202 accepts the request; it does not confirm completion. Save the order_id or operation id and check its status.
Request rules and errors · Lifecycle · Webhooks
Request
Responses
- 202
- 401
- 403
- 404
- 409
- 422
- 500
- 503
Accepted for processing
Missing or invalid key, mismatched ID, or inactive integration
Client IP is not in the integration allowlist (ip_not_allowed).
Resource not found in this integration
Business or state conflict; inspect detail
Invalid request fields or unsupported parameters
Unexpected server error
Service unavailable or result unconfirmed; for a mutation retain its idempotency key