Child pages
  • WHM API 0 Functions - set_tier

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function sets a cPanel & WHM server to a specified support tier.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/set_tier?tier=current
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/set_tier?tier=current
Expand
titleCommand Line
Code Block
languagebash
whmapi0 set_tier tier=current

Include Page
LIB:_WHMAPI0CLINote
LIB:_WHMAPI0CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
    "tier": "current",
    "statusmsg": "Update tier successfully changed to current",
    "status": 1
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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