clientapi_cpanel.WordPressManagerBackupsApi

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

Method	HTTP request	Description
any_running	GET /WordPressBackup/any_running	Return all WordPress sites' backup status
cancel	GET /WordPressBackup/cancel	Stop WordPress site backup
cleanup	GET /WordPressBackup/cleanup	Delete WordPress backup temporary files
get_available_backups	GET /WordPressBackup/get_available_backups	Return WordPress site backups
is_running	GET /WordPressBackup/is_running	Return WordPress site backup status
start	GET /WordPressBackup/start	Backup WordPress site
word_press_restore_any_running	GET /WordPressRestore/any_running	Return WordPress site restore status
word_press_restore_cleanup	GET /WordPressRestore/cleanup	Delete restored WordPress site's temporary files
word_press_restore_start	GET /WordPressRestore/start	Restore WordPress site

any_running

InlineResponse200556 any_running()

Return all WordPress sites' backup status

This function checks for any active WordPress® site backups on the cPanel account.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200556 import InlineResponse200556
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.WordPressManagerBackupsApi(api_client)

    try:
        # Return all WordPress sites' backup status
        api_response = api_instance.any_running()
        print("The response of WordPressManagerBackupsApi->any_running:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->any_running: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200556

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]

cancel

InlineResponse200557 cancel(site)

Stop WordPress site backup

This function cancels a WordPress® site backup.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200557 import InlineResponse200557
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.WordPressManagerBackupsApi(api_client)
    site = clientapi_cpanel.Site() # Site | The WordPress site's URL without the protocol prefix.

    try:
        # Stop WordPress site backup
        api_response = api_instance.cancel(site)
        print("The response of WordPressManagerBackupsApi->cancel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->cancel: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	Site	The WordPress site's URL without the protocol prefix.

Return type

InlineResponse200557

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]

cleanup

InlineResponse200558 cleanup(site)

Delete WordPress backup temporary files

This function releases any system resources from a previous WordPress® site backup.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200558 import InlineResponse200558
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.WordPressManagerBackupsApi(api_client)
    site = 'example.com/wordpress' # str | The WordPress site's URL **without** the protocol prefix.

    try:
        # Delete WordPress backup temporary files
        api_response = api_instance.cleanup(site)
        print("The response of WordPressManagerBackupsApi->cleanup:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->cleanup: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	str	The WordPress site's URL without the protocol prefix.

Return type

InlineResponse200558

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_available_backups

InlineResponse200559 get_available_backups(site)

Return WordPress site backups

This function retrieves a list of available WordPress® site backups of a single site.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200559 import InlineResponse200559
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.WordPressManagerBackupsApi(api_client)
    site = 'example.com/wordpress' # str | The WordPress site's URL **without** the protocol prefix.

    try:
        # Return WordPress site backups
        api_response = api_instance.get_available_backups(site)
        print("The response of WordPressManagerBackupsApi->get_available_backups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->get_available_backups: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	str	The WordPress site's URL without the protocol prefix.

Return type

InlineResponse200559

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_running

InlineResponse200560 is_running(site)

Return WordPress site backup status

This function checks for an active WordPress® site backup.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200560 import InlineResponse200560
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.WordPressManagerBackupsApi(api_client)
    site = 'example.com  example.com/wordpress' # str | The WordPress site's URL **without** `http://`.

    try:
        # Return WordPress site backup status
        api_response = api_instance.is_running(site)
        print("The response of WordPressManagerBackupsApi->is_running:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->is_running: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	str	The WordPress site's URL without `http://`.

Return type

InlineResponse200560

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

InlineResponse200561 start(site)

Backup WordPress site

This function starts a single WordPress® site backup.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200561 import InlineResponse200561
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.WordPressManagerBackupsApi(api_client)
    site = clientapi_cpanel.Site1() # Site1 | The WordPress site's URL without the protocol prefix.

    try:
        # Backup WordPress site
        api_response = api_instance.start(site)
        print("The response of WordPressManagerBackupsApi->start:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->start: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	Site1	The WordPress site's URL without the protocol prefix.

Return type

InlineResponse200561

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]

word_press_restore_any_running

InlineResponse200573 word_press_restore_any_running()

Return WordPress site restore status

This function returns whether a WordPress® site backup restoration is in progress.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.
The output of this function changes, depending on the state of the backup restoration.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200573 import InlineResponse200573
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.WordPressManagerBackupsApi(api_client)

    try:
        # Return WordPress site restore status
        api_response = api_instance.word_press_restore_any_running()
        print("The response of WordPressManagerBackupsApi->word_press_restore_any_running:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->word_press_restore_any_running: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200573

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]

word_press_restore_cleanup

InlineResponse200574 word_press_restore_cleanup(site)

Delete restored WordPress site's temporary files

This function cleans up any temporary system resources after a WordPress® site backup restoration.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200574 import InlineResponse200574
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.WordPressManagerBackupsApi(api_client)
    site = 'example.com' # str | The WordPress site's URL **without** the protocol prefix.

    try:
        # Delete restored WordPress site's temporary files
        api_response = api_instance.word_press_restore_cleanup(site)
        print("The response of WordPressManagerBackupsApi->word_press_restore_cleanup:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->word_press_restore_cleanup: %s\n" % e)

Parameters

Name	Type	Description	Notes
site	str	The WordPress site's URL without the protocol prefix.

Return type

InlineResponse200574

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]

word_press_restore_start

InlineResponse200575 word_press_restore_start(backup_path, site)

Restore WordPress site

This function starts a single WordPress® site backup restoration.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200575 import InlineResponse200575
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.WordPressManagerBackupsApi(api_client)
    backup_path = '/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz' # str | The file path to the backup archive.
    site = 'example.com' # str | The WordPress site's URL to restore.

    try:
        # Restore WordPress site
        api_response = api_instance.word_press_restore_start(backup_path, site)
        print("The response of WordPressManagerBackupsApi->word_press_restore_start:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WordPressManagerBackupsApi->word_press_restore_start: %s\n" % e)

Parameters

Name	Type	Description	Notes
backup_path	str	The file path to the backup archive.
site	str	The WordPress site's URL to restore.

Return type

InlineResponse200575

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

WordPressManagerBackupsApi.md

Latest commit

History

WordPressManagerBackupsApi.md

File metadata and controls

clientapi_cpanel.WordPressManagerBackupsApi

any_running

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cleanup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_available_backups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

is_running

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

word_press_restore_any_running

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

word_press_restore_cleanup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

word_press_restore_start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details