Change the VPS root password
POST/services/:id/password
Changes the root password via a Virtualizor act=editvs round-trip (the official WHMCS module pattern: first GET the full config, then POST it back with editvps=1 + rootpass).
IMPORTANT: For the password to take EFFECT on the VPS, most virtualization types require a power cycle (off/on). This endpoint ONLY writes the new password to Virtualizor; the reseller module performs the poweroff + start orchestration after the change itself.
Idempotency-Key: OPTIONAL (rewriting the same password is harmless; not destructive like rebuild).
Rate limit: services_changes_120rpm bucket.
Security: The password is NEITHER LOGGED NOR returned in the response.
vps_id null: 422 service_not_provisioned.
Request
Responses
- 200
- 400
- 401
- 403
- 422
- 429
- 502
Password changed (a power cycle may still be required)
Response Headers
The per-minute limit defined for this key
Number of requests remaining in the current window
Unix epoch of the start of the next window (UTC seconds)
Invalid password (length/characters) or body
Authentication failed — missing header, wrong credential, outside the IP whitelist, or a revoked key. No detail is leaked; all cases return a single message.
Response Headers
RFC 7617 Basic Auth challenge
Insufficient authorization — the reseller tried to access another reseller's service_id, or has insufficient scope for an endpoint requiring admin scope. The message is kept generic (ServiceOwnershipMiddleware prevents leakage).
VPS not yet provisioned
Per-minute limit exceeded
Response Headers
Seconds to wait before retrying after a 429 (RFC 7231 §7.1.3)
The per-minute limit defined for this key
Unix epoch of the start of the next window (UTC seconds)
Virtualizor upstream error (no editvs done flag)