Child pages
  • WHM API 1 Functions - reset_autossl_provider

Versions Compared

Key

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

 

Description

Excerpt

This function resets the AutoSSL registration with a remote AutoSSL provider.

Panel
bgColor#F2F2F2
borderStylenone

Examples


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

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

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

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

     

Parameters

ReturnTypeDescriptionPossible valuesExample
providerstring

Required

The AutoSSL provider's name.

A valid AutoSSL provider's name.

cPanel

x_*string

Additional parameters which you wish to pass to the AutoSSL provider.

Note
titleNote:

These additional parameters begin with the x_ prefix. For example, the Let's Encrypt provider accepts the x_terms_of_service_accepted parameter, to which you would pass the URL of the terms of service that you accept.

(varies)(varies)

Returns

This function only returns metadata.