passwd — WAP API
Change an account password through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/passwd/Also accepts GETChanges the existing hosting account password; it does not rotate API Manager credentials. If password is omitted or blank, a 15-character password is generated internally. The success response does not return that generated password, so supply a known replacement when the integration must deliver credentials. The underlying operation updates the operating-system password hash through chpasswd; it does not return the plaintext replacement.
Request
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/passwd/ |
| Default path | /api/passwd/ |
| Authentication | WAP root administrator API credentials. |
| Header | Required value |
|---|---|
X-API-USER | Your WAP API username. |
X-API-PASSWORD | Its API password. |
Parameters
| Field | Required | Type and behavior |
|---|---|---|
password | No | String. Plaintext hosting password sent over HTTPS. Omitted/blank generates 15 characters; password changes do not return the generated value. |
user | Yes | String. Existing hosting username; required account state is described above. |
POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Although GET is supported, use POST for account changes and login-link generation so action fields are not placed in URLs. Authentication remains in the two headers. Undeclared fields are not additional API options.
Replace server.example.com, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.
Success response
HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.
{
"data": "User password changed for exampleuser",
"info": "Hosting account password changed successfully",
"status": 200
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | string | Success message. |
Errors and demo mode
| Condition | Actual HTTP status | Response behavior |
|---|---|---|
| Missing credentials with no other authenticated identity | 403 | detail: Authentication credentials were not provided. |
| Rejected password or source IP | 403 | detail: Invalid API credentials |
| Demo server | 400 | error: Demo server; info: Api Operations not available in demo server; JSON status: 403. |
| Invalid/missing operation fields or invalid target state | 400 | Field errors in error; JSON status: 400. |
| Backend reports failure | 400 | Operation error in error; JSON status: 500. |
| Unsupported method | 405 after authentication | Method-not-allowed response. |
Validation failure description: Unable to change hosting account password. The data is invalid.
Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.