clientapi_cpanel.AutoGeneratedSSLCertificatesApi

All URIs are relative to https://cpanel-server.tld:2083/execute

Method	HTTP request	Description
add_autossl_excluded_domains	GET /SSL/add_autossl_excluded_domains	Disable AutoSSL for domains
get_autossl_excluded_domains	GET /SSL/get_autossl_excluded_domains	Return AutoSSL disabled domains
get_autossl_problems	GET /SSL/get_autossl_problems	Return domains with AutoSSL problems
is_autossl_check_in_progress	GET /SSL/is_autossl_check_in_progress	Return whether AutoSSL check in progress
remove_autossl_excluded_domains	GET /SSL/remove_autossl_excluded_domains	Enable AutoSSL for specifed domains
set_autossl_excluded_domains	GET /SSL/set_autossl_excluded_domains	Disable AutoSSL for specifed domains
start_autossl_check	GET /SSL/start_autossl_check	Start AutoSSL for current user

add_autossl_excluded_domains

InlineResponse200402 add_autossl_excluded_domains(domains)

Disable AutoSSL for domains

This function disables AutoSSL for the domains that you specify.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200402 import InlineResponse200402
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)
    domains = 'example.com,example2.com' # str | A comma-separated list of domains for which to disable AutoSSL.  **Note:**  For browser-based calls, use a URI encoded comma (`%2C`).

    try:
        # Disable AutoSSL for domains
        api_response = api_instance.add_autossl_excluded_domains(domains)
        print("The response of AutoGeneratedSSLCertificatesApi->add_autossl_excluded_domains:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->add_autossl_excluded_domains: %s\n" % e)

Parameters

Name	Type	Description	Notes
domains	str	A comma-separated list of domains for which to disable AutoSSL. Note: For browser-based calls, use a URI encoded comma (`%2C`).

Return type

InlineResponse200402

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_autossl_excluded_domains

InlineResponse200420 get_autossl_excluded_domains()

Return AutoSSL disabled domains

This function lists the domains with AutoSSL disabled.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200420 import InlineResponse200420
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)

    try:
        # Return AutoSSL disabled domains
        api_response = api_instance.get_autossl_excluded_domains()
        print("The response of AutoGeneratedSSLCertificatesApi->get_autossl_excluded_domains:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->get_autossl_excluded_domains: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200420

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_autossl_problems

InlineResponse200421 get_autossl_problems()

Return domains with AutoSSL problems

This function retrieves a list of domains that possess AutoSSL problems.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200421 import InlineResponse200421
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)

    try:
        # Return domains with AutoSSL problems
        api_response = api_instance.get_autossl_problems()
        print("The response of AutoGeneratedSSLCertificatesApi->get_autossl_problems:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->get_autossl_problems: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200421

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

is_autossl_check_in_progress

InlineResponse200427 is_autossl_check_in_progress()

Return whether AutoSSL check in progress

This function verifies whether the autossl_check task is in progress for the current user.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200427 import InlineResponse200427
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)

    try:
        # Return whether AutoSSL check in progress
        api_response = api_instance.is_autossl_check_in_progress()
        print("The response of AutoGeneratedSSLCertificatesApi->is_autossl_check_in_progress:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->is_autossl_check_in_progress: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200427

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_autossl_excluded_domains

InlineResponse200437 remove_autossl_excluded_domains(domains)

Enable AutoSSL for specifed domains

This function enables AutoSSL for the domains that you specify.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200437 import InlineResponse200437
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)
    domains = 'domains=example1.com,example2.com' # str | Enable AutoSSL for this domain.

    try:
        # Enable AutoSSL for specifed domains
        api_response = api_instance.remove_autossl_excluded_domains(domains)
        print("The response of AutoGeneratedSSLCertificatesApi->remove_autossl_excluded_domains:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->remove_autossl_excluded_domains: %s\n" % e)

Parameters

Name	Type	Description	Notes
domains	str	Enable AutoSSL for this domain.

Return type

InlineResponse200437

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_autossl_excluded_domains

InlineResponse200438 set_autossl_excluded_domains(domains=domains)

Disable AutoSSL for specifed domains

This function disables AutoSSL for every domain that you specify.

Warning:

This function replaces the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function SSL::add_autossl_excluded_domains.

Important:

When you disable the the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200438 import InlineResponse200438
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)
    domains = 'example.com,example.net' # str | A comma-separated list of domains for which to disable AutoSSL.  **Note:**  If you do not include this parameter, the function will **enable** AutoSSL for every domain on the account. (optional)

    try:
        # Disable AutoSSL for specifed domains
        api_response = api_instance.set_autossl_excluded_domains(domains=domains)
        print("The response of AutoGeneratedSSLCertificatesApi->set_autossl_excluded_domains:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->set_autossl_excluded_domains: %s\n" % e)

Parameters

Name	Type	Description	Notes
domains	str	A comma-separated list of domains for which to disable AutoSSL. Note: If you do not include this parameter, the function will enable AutoSSL for every domain on the account.	[optional]

Return type

InlineResponse200438

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

start_autossl_check

InlineResponse200447 start_autossl_check()

Start AutoSSL for current user

This function initiates an AutoSSL check for the user.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200447 import InlineResponse200447
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.AutoGeneratedSSLCertificatesApi(api_client)

    try:
        # Start AutoSSL for current user
        api_response = api_instance.start_autossl_check()
        print("The response of AutoGeneratedSSLCertificatesApi->start_autossl_check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AutoGeneratedSSLCertificatesApi->start_autossl_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200447

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AutoGeneratedSSLCertificatesApi.md

Latest commit

History

AutoGeneratedSSLCertificatesApi.md

File metadata and controls

clientapi_cpanel.AutoGeneratedSSLCertificatesApi

add_autossl_excluded_domains

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_autossl_excluded_domains

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_autossl_problems

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

is_autossl_check_in_progress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_autossl_excluded_domains

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_autossl_excluded_domains

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_autossl_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details