Skip to main content
POST
Set new_password or use generate_password: true to change an eligible VPS password. Choose exactly one mode. Requires admin:full.
This changes the password the client uses to access their VPS. Treat any returned password as a secret.

​
Check whether the password changed

  • operation_status: "password_updated": the password changed during the call.
  • operation_status: "password_update_queued": the VPS was locked and a retry was queued. The old password remains active until the update succeeds. A generated password in this response is not proof it is already usable.
Queued changes are first scheduled for retry after five minutes and can require further attempts or fail. There is no guaranteed completion time. Check the service’s current credentials and activity, or contact support if the change remains unresolved. Set email_client: true to request a welcome email containing the new password. For queued changes, the email is deferred until the password update succeeds.

​
Endpoint errors

For authentication, permissions, rate limits, and safe retries, see Errors and Retries.

Authorizations

​
Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Path Parameters

​
service_number
integer<int64>
required

Public service number parsed as a base-10 integer.

Body

application/json

Provide either new_password or a true generate_password value, but not both.

​
new_password
string
required

Must have uppercase, lowercase, and numeric characters and no surrounding whitespace.

Required string length: 8 - 32
​
generate_password
boolean
default:false
​
email_client
boolean
default:false

Response

Password updated or a retry queued because the VPS is locked. A queued response does not confirm the password is active; retries can fail.

​
success
boolean
required
​
data
object
required
​
message
string
​
pagination
object
Last modified on September 8, 2026