changepackage — WAP API
Change the hosting package through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/changepackage/Also accepts GETApplies the selected existing hosting package to the account and updates its package-controlled limits, including disk quota and inherited email limits. Current package-change code preserves the existing shell and dedicated-IP choices rather than provisioning a new IP. Review the target package and verify the resulting limits after the change.
Request
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/changepackage/ |
| Default path | /api/changepackage/ |
| 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 |
|---|---|---|
user | Yes | String. Existing hosting username; required account state is described above. |
package | Yes | String. Existing hosting package name, without the .yaml suffix. |
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 hosting package changed for exampleuser",
"info": "Hosting account package 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 package. 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.