Child pages
  • WHM API 1 Functions - remove_integration_link

Versions Compared

Key

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

Excerpt

This function removes an integration link from the cPanel interface.

Panel
bgColor#F2F2F2
borderStylenone

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/remove_integration_link?api.version=1&user=username&app=WHMCS%2BBilling
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/remove_integration_link?api.version=1&user=username&app=WHMCS%2BBilling
Expand
titleCommand Line
Code Block
languagebash
whmapi1 remove_integration_link user=username app=WHMCS_Billing

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

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

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account name.

A valid cPanel username.username
appstring

Required

The name of the integration link to remove.

A valid string.WHMCS_billing

This function only returns metadata.