- Created by Documentation, last modified on Apr 09, 2018
Description
This function sets a cPanel & WHM server to a specified support tier.
Examples
JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_tier?tier=current
XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_tier?tier=current
Command Line
whmapi0 set_tier tier=current
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 0 documentation or run the
whmapi0 --helpcommand. If you run CloudLinux™, you must use the full path of the
whmapi0command:/usr/local/cpanel/bin/whmapi0
Output (JSON)
{
"tier": "current",
"statusmsg": "Update tier successfully changed to current",
"status": 1
}
Output (XML)
<set_tier>
<status>1</status>
<statusmsg>Update tier successfully changed to edge</statusmsg>
<tier>edge</tier>
</set_tier>
Parameters
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
| tier | string | Required The support tier. |
| current |
Returns
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
tier | string | The server's new support tier. |
| current |
| Boolean | Whether the system successfully called the function. |
| 1 |
statusmsg | string | The result of the function. |
| Update tier successfully changed to current |
Function information
API Version:
WHM API 1 Equivalent:
Important:
We strongly recommend that you use WHM API 1. WHM API 0 is deprecated.
Available in:
WHM 11.32+
Methods:
GET, POST
Required Parameters:
tier
Return Formats:
About WHM API 0
WHM API 0 performs functions and accesses data in WHM.
Warning:
WHM API 0 is deprecated. We strongly recommend that you use the equivalent WHM API 1 function instead.
Notes:
- Some functions and parameters may require that you authenticate as the
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 0 Sections - Accounts — Account functions allow you to manage cPanel accounts, WHM accounts, and their settings.
-
Page:WHM API 0 Functions - accountsummary — This function retrieves a user's account summary.
-
Page:WHM API 0 Functions - domainuserdata — This function retrieves domain data.
-
Page:WHM API 0 Functions - editquota — This function modifies a user's disk quota.
-
Page:WHM API 0 Functions - limitbw — This function modifies a cPanel account's bandwidth quota.