Developer Documentation
Child pages
  • WHM API 0 Functions - set_tier
Skip to end of metadata
Go to start of metadata

 

_WHMAPI0Menu

Return Data 

 

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 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi0 command:

    /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

ParameterTypeDescriptionPossible valuesExample
tierstring

Required

The support tier.

  • edge
  • current
  • release
  • stable
current

 

 

Returns

ReturnTypeDescriptionPossible valuesExample
tierstringThe server's new support tier.
  • edge
  • current
  • release
  • stable
current

status

BooleanWhether the system successfully called the function.
  • 1 — Success.
  • 0 — Failure.

 

1
statusmsgstringThe result of the function.
  • Update tier successfully changed to current
  • An error message.
Update tier successfully changed to current

Function information

API Version:

WHM API 0

WHM API 1 Equivalent:

set_tier

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:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

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 root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions