Skip to main content
POST
This request changes the service password that the client uses to access their VPS.

Behavior

This endpoint is used for managing the remote desktop password for the VPS. This is the same password that the client uses to access their service. A successful submission changes the service password immediately. From this point forward the old password will no longer work, and the client must use the new password to access their service. You may use the “email_client” parameter to send a new VPS welcome email to the client, which contains the new password.

Errors

All error responses have success: false and an error object.

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.

success
boolean
required
data
object
required
message
string
pagination
object
Last modified on August 2, 2026