Reset the password for a virtual machine

PUT

https://api.americancloud.com/api/v1/compute/vms/:id/password/reset

Resets the VM password. You can optionally provide a custom password, or let the system generate one. The VM must be stopped for this operation. IMPORTANT: The password is only returned once - save it immediately.

Authentication

X-API-Client-IDstring

API Client ID

X-API-Client-Secretstring

API Client Secret

Path parameters

idstringRequired

ID of the virtual machine

Request

This endpoint expects an object.

passwordstringOptionalformat: "password"8-64 characters

Custom password to set for the VM. If not provided, a random password will be generated. May contain letters, digits, and symbols only (printable ASCII, no spaces).

Response

The password has been reset successfully. Save the password now - it will not be shown again.

passwordstringformat: "password"

The new VM password. Save this immediately — it will not be returned again.

messagestringOptional

Success message with a reminder to save the password.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error