- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function sets the provider that the AutoSSL feature uses.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_provider?api.version=1&provider=cPanel
https://hostname.example.com:2087/cpsess##########/xml-api/set_autossl_provider?api.version=1&provider=cPanel
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
{ "metadata":{ "reason":"OK", "command":"set_autossl_provider", "result":1, "version":1 } }
<result> <metadata> <version>1</version> <result>1</result> <reason>OK</reason> <command>set_autossl_provider</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
provider | string | Required The AutoSSL provider's name. | A valid AutoSSL provider name. For example:
|
|
x_* | string | Additional parameters which you wish to pass to the AutoSSL provider. Note: These additional parameters begin with the | (varies) | (varies) |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 58+
Methods:
GET, POST
Required Parameters:
provider
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - accesshash — This function regenerates or retrieves a user's access hash.
-
Page:WHM API 1 Functions - listcrts — This function lists the server's domains with installed SSL certificates.
-
Page:WHM API 1 Functions - deletesshkey — This function function deletes an SSH key from the server.
-
Page:WHM API 1 Functions - authorizesshkey — This function authorizes a key to access the server via SSH.
-
Page:WHM API 1 Functions - check_remote_ssh_connection — This function tests an SSH connection to another server.