Child pages
  • WHM API 1 Functions - set_default

Versions Compared

Key

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

 

Description

Excerpt

This function sets the default cPanel style.

Panel
bgColor#F2F2F2
borderStylenone

Examples 

 


 

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/set_default?api.version=1&type=default&name=mystyle
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/set_default?api.version=1&type=default&name=mystyle
Expand
titleCommand Line
Code Block
languagebash
whmapi1 set_default type=default name=mystyle

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "result":1,
      "reason":"OK",
      "command":"set_default",
      "version":1
   }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <command>set_default</command>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

ReturnTypeDescriptionPossible valuesExample
typestring

Required

The style's type.

  • default
  • global
  • reseller
  • user
default 
namestring

Required

The style's name.

  • base — The default Paper Lantern style.
  • retro — The Paper Lantern Retro style.
  • Another valid style name on the server.
mystyle

Returns

This function only returns metadata.