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

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function sets the provider that the AutoSSL feature uses.

Note:

To disable AutoSSL, call WHM API 1's disable_autossl function.

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_provider?api.version=1&provider=cPanel
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_autossl_provider?api.version=1&provider=cPanel
 Command Line
whmapi1 set_autossl_provider provider=cPanel


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

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

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "reason":"OK",
      "command":"set_autossl_provider",
      "result":1,
      "version":1
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
        <command>set_autossl_provider</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

     

Parameters

ParameterTypeDescriptionPossible valuesExample
providerstring

Required

The AutoSSL provider's name.

A valid AutoSSL provider name. For example:

  • cPanel
  • LetsEncrypt

cPanel

x_*string

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

Note:

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.

Function information

API Version:

WHM API 1

Available in:

WHM 58+

Methods:

GET, POST

Required Parameters:

provider

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

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