### Using cPanel API Tokens with cURL

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Demonstrates how to authenticate and execute cPanel API functions using an API token via a cURL command. This includes the authorization header format and example parameters.

```bash
curl -H'Authorization: cpanel username:APITOKEN' 'https://example.com:2083/execute/Module/function?parameter=value'

# Example with specific function:
curl -H'Authorization: cpanel username:U7HMR63FHY282DQZ4H5BIH16JLYSO01M' 'https://example.com:2083/execute/Email/add_pop?email=newuser&password=12345luggage'
```

--------------------------------

### Call UAPI Function with LiveAPI in Perl

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Provides an example of connecting to cPanel and executing a UAPI function using the Cpanel::LiveAPI Perl module. It includes instantiation, function calls, and disconnection.

```Perl
#!/usr/bin/perl

# Instantiate the Cpanel::LiveAPI object.
use Cpanel::LiveAPI ();

# Connect to cPanel - only do this once.
my $cpliveapi = Cpanel::LiveAPI->new();

# Call a UAPI function.
my $function_result = $cpliveapi->uapi(
    'Module', 'function',
    {
        'parameter'     => 'value',
        'parameter'     => 'value',
        'parameter'     => 'value',
    }
);

# Perform the desired actions.

# Disconnect from cPanel - only do this once.
$cpliveapi->end();
```

--------------------------------

### Getting Arguments from @_

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Demonstrates the recommended method for retrieving arguments passed to a UAPI function. It assigns the Cpanel::Args object to $args and Cpanel::Result to $result for handling input and output.

```perl
my ( $args, $result ) = @_;
# $args is a Cpanel::Args object for named parameters.
# $result is a Cpanel::Result object for returning data.
```

--------------------------------

### Using Cpanel::Args get() Method

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Illustrates how to extract specific input parameters from the $args object using its get() method. This is crucial for assigning values to local variables, assuming the parameters exist.

```perl
my ( $arg1, $arg2 ) = $args->get( 'arg1', 'arg2' );
# Assigns values from 'arg1' and 'arg2' input parameters.
```

--------------------------------

### UAPI Pagination Variables

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

This section details how to control pagination for UAPI output. It includes the structure of the pagination metadata returned by functions and the specific variables you can use to manage pagination, such as enabling/disabling it, setting the starting record, the number of records per page, and the desired page number.

```APIDOC
UAPI Pagination Overview:

When pagination is enabled, the function's output metadata includes pagination control information:

```json
"paginate": {
    "total_pages": 1,
    "total_results": 1,
    "current_page": 1,
    "results_per_page": 100,
    "start_result": "1"
}
```

Pagination Variables:

- **api.paginate**
  - Description: Controls whether pagination is enabled.
  - Values:
    - `1`: Enable pagination.
    - `0`: Disable pagination.

- **api.paginate_start**
  - Description: Specifies the first record to display on the current page.
  - Type: Nonnegative integer.
  - Example: To start with the fifth record, use `api.paginate_start=5`.

- **api.paginate_size**
  - Description: Determines the number of records to display per page.
  - Type: Nonnegative integer.
  - Example: To display ten records per page, use `api.paginate_size=10`.

- **api.paginate_page**
  - Description: Selects which page of results to display.
  - Type: Nonnegative integer.
  - Example: To display the second page of records, use `api.paginate_page=2`.
```

--------------------------------

### Cpanel::Args Methods for Parameter Handling

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Documentation for key methods within the Cpanel::Args object, used for managing input parameters in cPanel API functions. Covers checking required parameters, adding new parameters, and retrieving all parameter keys.

```APIDOC
$args->get_length_required(parameter_name)
  - Checks if a named parameter exists and is not blank or null.
  - Returns the parameter and its value if valid.
  - Returns a predetermined error message if the parameter is missing, blank, or null.
  - Recommended for assigning values from required input parameters.
  - Example:
    my ($variable) = $args->get_length_required('param1');

$args->add(key, value)
  - Adds a key=value pair to the currently available named parameters.
  - Useful for introducing additional parameters from other subroutines.
  - Example:
    $args->add('parameter_name','value');

$args->keys()
  - Retrieves all current named parameters.
  - Can be used to assign all named input parameters to an array without explicit naming.
  - Example:
    my $value = $args->keys();
```

--------------------------------

### cPanel UAPI Command Line Interface

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details on how to execute cPanel UAPI functions directly from the command line. Covers the basic structure, required arguments like user and output type, and parameter formatting.

```APIDOC
UAPI Command Structure:

uapi --user=username --output=type Module function parameter=value parameter=value

Description:
This command-line interface allows direct interaction with cPanel's Universal API (UAPI).

Components:
- `uapi`: The executable command. For CloudLinux™, use the full path: `/usr/local/cpanel/bin/uapi`.
- `--user=username`: Specifies the cPanel account username.
- `--output=type`: Defines the output format. Supported types include `json`, `jsonpretty`, and `yaml` (default).
- `Module`: The UAPI module containing the desired function.
- `function`: The specific UAPI function to execute.
- `parameter=value`: Input parameters for the function. Multiple parameters are space-separated. Special characters in values must be escaped or quoted.

Example Usage:
```bash
uapi --user username Module function key=["sslinstall","videotut"]
uapi --user username Module function key='{"videotut","sslinstall"}'
```

Notes:
- Command-line calls may not return metadata for errors that prevent successful function execution.
- The term 'Boolean' in documentation refers to `1` or `0`, not literal `true` or `false`.

For help, run: `uapi --help`
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Overview and Authentication

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Provides an overview of the cPanel Universal API (UAPI) and details on authentication methods, including API token management.

```APIDOC
cPanel UAPI:
  Overview: Access and manage hosting features via a universal API.
  Authentication:
    API Token Management:
      - Create, manage, and revoke API tokens for authentication.
      - Supports token-based authentication for API requests.
  Related Modules:
    - Introduction
    - Filters
    - Sorting
    - Pagination
    - Custom UAPI Modules
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### Call UAPI Function with LiveAPI in PHP

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Demonstrates how to connect to cPanel and execute a UAPI function using the LiveAPI PHP class. It shows the instantiation of the class and the call to the `uapi` method with module, function, and parameters.

```PHP
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Call a UAPI function.
$function_result = $cpanel->uapi(
    'Module', 'function',
    array(
        'parameter'     => 'value',
        'parameter'     => 'value',
        'parameter'     => 'value',
         )
);
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### Cpanel::Args Object Methods

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Documentation for the Cpanel::Args object methods used to process input parameters in cPanel UAPI functions. This includes checking parameter existence and retrieving parameter values.

```APIDOC
$args->exists( parameter_name )
  Checks whether a named parameter exists.
  Returns true (1) if the parameter exists, false (0) otherwise.
  Note: Returns true even if the parameter has a null or blank value.

$args->get( parameter_name1, parameter_name2, ... )
  Retrieves one or more named parameters.
  Assigns values from optional input parameters.
  Does not return runtime errors for nonexistent parameters.
  Example:
    my($arg1, $arg2) = $args->get('param1', 'param2');

$args->get_required( parameter_name )
  Checks if a named parameter exists and returns its value.
  Returns a predetermined error message if the parameter does not exist.
  Recommended for required input parameters, even if they can be blank.
  Note: Does not return an error if the parameter exists with a null or blank value.
  Example:
    my ($variable) = $args->get_required('param1');
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### UAPI Basic Usage

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details the fundamental structure for making Universal API (UAPI) calls to interact with cPanel features. It explains the session URL format, required variables like Module, function, and parameters, and provides a note on browser-based calls.

```APIDOC
UAPI Basic Usage:

URL Format:
/execute/Module/function?parameter=value&parameter=value&parameter=value

Description:
This format is used for browser-based UAPI calls, allowing programmatic access to cPanel features.

Variables:
- Module: The UAPI module containing the desired function (e.g., Email).
- function: The specific UAPI function to execute (e.g., addpop).
- parameter: Input parameters for the function (e.g., domain).
- value: The value assigned to the parameter (e.g., example.com).

Notes:
- Local access methods (LiveAPI PHP/Perl) might require a browser-based call if issues arise.
- API calls associated with disabled server roles are not permitted.
- UAPI functions cannot be called via other API's call methods.
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### cPanel UAPI Theme and Application Management

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Provides API endpoints for managing cPanel themes, applications, branding, and browser cache settings.

```APIDOC
cPanel Theme Management:
  Purpose: Customize the cPanel interface and manage related assets.
  Modules:
    - Application Information: Retrieve details about installed applications.
    - Brand Management: Manage custom branding elements.
    - Browser Cache Management: Control browser caching behavior.
    - Language: Manage language settings for the interface.
    - Theme Settings: Configure and apply cPanel themes.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI GIT Management

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Provides API endpoints for managing GIT repositories and deployment settings.

```APIDOC
GIT Management:
  Purpose: Integrate and manage GIT repositories for deployment.
  Modules:
    - Deployment Settings: Configure deployment workflows and targets.
    - Repository Management: Manage GIT repositories associated with the account.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### cPanel UAPI Plugin Framework

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Covers API functions related to the cPanel plugin framework.

```APIDOC
cPanel Plugin Framework:
  Purpose: Manage and interact with cPanel plugins.
  Module:
    - Plugins: API endpoints for plugin management and functionality.
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### cPanel UAPI Backup and Restoration

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Details API methods for performing backups and restoring files for cPanel accounts.

```APIDOC
cPanel Account Backups:
  Purpose: Manage backup and restoration processes for account data.
  Modules:
    - Backup: Initiate and manage full or partial account backups.
    - File Restoration: Restore specific files or directories from backups.
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Account Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Covers API endpoints for managing cPanel accounts, including account enhancements, information retrieval, disk quotas, and user/team management.

```APIDOC
cPanel Account Management:
  Purpose: Manage various aspects of a cPanel hosting account.
  Modules:
    - Account Enhancements: Modify account features and settings.
    - Account Information: Retrieve detailed information about the hosting account.
    - Account Management: Core functions for account operations.
    - Contact Information: Manage account contact details.
    - cPanel Features: Control access to specific cPanel features.
    - Disk Quotas: Monitor and manage disk space usage.
    - Personalization: Customize account appearance and settings.
    - Resource Usage and Statistics: View resource consumption (CPU, memory, etc.).
    - Subaccount Management: Create and manage subaccounts.
    - Team Roles: Define and assign roles within a team.
    - Team Users: Manage users associated with a team.
```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel API Token Management and Usage

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Provides an overview of cPanel API tokens, their purpose, and how they are used to interact with cPanel's functionalities. It references specific UAPI functions for token creation and general API execution.

```APIDOC
cPanel API Token Management:

Overview:
  cPanel & WHM recognize API tokens, enabling applications or users to execute API functions with cPanel account data without direct login.

Creating API Tokens:
  - Via cPanel Interface: Navigate to cPanel >> Home >> Security >> Manage API Tokens.
  - Via UAPI: Use the `Tokens::create_full_access` function.

Using API Tokens:
  - Authentication Method: HTTP Authorization header.
  - Format: `Authorization: cpanel username:APITOKEN`
  - Endpoint Structure: `https://<server_domain>:2083/execute/<Module>/<function>?<parameter>=<value>`

Key UAPI Functions Mentioned:
  - `Tokens::create_full_access`: Used for creating API tokens programmatically.
  - `Email::add_pop`: Example function for adding an email account, demonstrating parameter usage in an API call.
```

--------------------------------

### Cpanel Dependencies for UAPI Modules

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Includes essential cPanel dependencies required for UAPI module development, such as Cpanel, Cpanel::API, Cpanel::Locale, and Cpanel::Logger.

```perl
# Cpanel Dependencies
use Cpanel                   ();
use Cpanel::API              ();
use Cpanel::Locale           ();
use Cpanel::Logger           ();

```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel UAPI Two-Factor Settings

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Details API endpoints for managing two-factor authentication settings.

```APIDOC
Two-Factor Settings:
  Purpose: Configure and manage two-factor authentication (2FA) for accounts.
  Functionality: Enable, disable, or manage 2FA methods.
```

--------------------------------

### cPanel UAPI Directory Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Covers API functions for managing directories, including index settings, privacy, and protection.

```APIDOC
Directory Management:
  Purpose: Control access and display settings for website directories.
  Modules:
    - Directory Indexes: Configure directory listing behavior.
    - Directory Privacy: Set password protection for directories.
    - Directory Protection: Implement security measures for directories.
```

--------------------------------

### cPanel UAPI Directory Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Covers API functions for managing directories, including index settings, privacy, and protection.

```APIDOC
Directory Management:
  Purpose: Control access and display settings for website directories.
  Modules:
    - Directory Indexes: Configure directory listing behavior.
    - Directory Privacy: Set password protection for directories.
    - Directory Protection: Implement security measures for directories.
```

--------------------------------

### cPanel UAPI File Management

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Details API endpoints for managing files, FTP accounts, and web disk settings.

```APIDOC
File Management:
  Purpose: Handle file system operations and access methods.
  Modules:
    - FTP Accounts: Create, manage, and delete FTP accounts.
    - FTP Server Settings: Configure FTP server parameters.
    - Image Tools: Perform basic image manipulation tasks.
    - Manage Files: Browse, upload, download, and modify files.
    - WebDisk Settings: Configure WebDisk access and settings.
```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel UAPI Directory Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Covers API functions for managing directories, including index settings, privacy, and protection.

```APIDOC
Directory Management:
  Purpose: Control access and display settings for website directories.
  Modules:
    - Directory Indexes: Configure directory listing behavior.
    - Directory Privacy: Set password protection for directories.
    - Directory Protection: Implement security measures for directories.
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Batch Operations

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API endpoints for performing batch operations, allowing multiple actions to be executed in a single request.

```APIDOC
Batch Operations:
  Purpose: Execute multiple API calls efficiently in a single request.
  Functionality: Allows for sequential or parallel execution of API commands.
```

--------------------------------

### cPanel UAPI Account Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Covers API endpoints for managing cPanel accounts, including account enhancements, information retrieval, disk quotas, and user/team management.

```APIDOC
cPanel Account Management:
  Purpose: Manage various aspects of a cPanel hosting account.
  Modules:
    - Account Enhancements: Modify account features and settings.
    - Account Information: Retrieve detailed information about the hosting account.
    - Account Management: Core functions for account operations.
    - Contact Information: Manage account contact details.
    - cPanel Features: Control access to specific cPanel features.
    - Disk Quotas: Monitor and manage disk space usage.
    - Personalization: Customize account appearance and settings.
    - Resource Usage and Statistics: View resource consumption (CPU, memory, etc.).
    - Subaccount Management: Create and manage subaccounts.
    - Team Roles: Define and assign roles within a team.
    - Team Users: Manage users associated with a team.
```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel UAPI Account Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Covers API endpoints for managing cPanel accounts, including account enhancements, information retrieval, disk quotas, and user/team management.

```APIDOC
cPanel Account Management:
  Purpose: Manage various aspects of a cPanel hosting account.
  Modules:
    - Account Enhancements: Modify account features and settings.
    - Account Information: Retrieve detailed information about the hosting account.
    - Account Management: Core functions for account operations.
    - Contact Information: Manage account contact details.
    - cPanel Features: Control access to specific cPanel features.
    - Disk Quotas: Monitor and manage disk space usage.
    - Personalization: Customize account appearance and settings.
    - Resource Usage and Statistics: View resource consumption (CPU, memory, etc.).
    - Subaccount Management: Create and manage subaccounts.
    - Team Roles: Define and assign roles within a team.
    - Team Users: Manage users associated with a team.
```

--------------------------------

### cPanel UAPI Batch Operations

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API endpoints for performing batch operations, allowing multiple actions to be executed in a single request.

```APIDOC
Batch Operations:
  Purpose: Execute multiple API calls efficiently in a single request.
  Functionality: Allows for sequential or parallel execution of API commands.
```

--------------------------------

### cPanel UAPI Account Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Covers API endpoints for managing cPanel accounts, including account enhancements, information retrieval, disk quotas, and user/team management.

```APIDOC
cPanel Account Management:
  Purpose: Manage various aspects of a cPanel hosting account.
  Modules:
    - Account Enhancements: Modify account features and settings.
    - Account Information: Retrieve detailed information about the hosting account.
    - Account Management: Core functions for account operations.
    - Contact Information: Manage account contact details.
    - cPanel Features: Control access to specific cPanel features.
    - Disk Quotas: Monitor and manage disk space usage.
    - Personalization: Customize account appearance and settings.
    - Resource Usage and Statistics: View resource consumption (CPU, memory, etc.).
    - Subaccount Management: Create and manage subaccounts.
    - Team Roles: Define and assign roles within a team.
    - Team Users: Manage users associated with a team.
```

--------------------------------

### cPanel UAPI SSE Task Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Provides API endpoints for managing Server-Sent Events (SSE) tasks, enabling real-time updates.

```APIDOC
SSE Task Management:
  Purpose: Manage tasks that utilize Server-Sent Events for real-time data streaming.
  Functionality: Monitor and control tasks that push updates from the server to the client.
```

--------------------------------

### cPanel UAPI Directory Management

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Covers API functions for managing directories, including index settings, privacy, and protection.

```APIDOC
Directory Management:
  Purpose: Control access and display settings for website directories.
  Modules:
    - Directory Indexes: Configure directory listing behavior.
    - Directory Privacy: Set password protection for directories.
    - Directory Protection: Implement security measures for directories.
```

--------------------------------

### cPanel UAPI DNS Management

Source: https://api.docs.cpanel.net/cpanel/introduction/paginate

Details API endpoints for managing DNS records, zones, and related security settings.

```APIDOC
DNS Management:
  Purpose: Configure and manage Domain Name System (DNS) records and settings.
  Modules:
    - DNS: General DNS zone management.
    - DNS Information: Retrieve DNS zone data.
    - DNS Security: Configure DNS security features (e.g., DNSSEC).
    - Dynamic DNS: Manage dynamic DNS updates.
    - Email DNS Settings: Configure DNS records specific to email services (e.g., MX, SPF, DKIM).
```

--------------------------------

### cPanel UAPI Commerce Integration

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Details API endpoints for integrating with commerce platforms and managing SSL certificates.

```APIDOC
Commerce Integration:
  Purpose: Facilitate integration with e-commerce services and manage security certificates.
  Modules:
    - Market Integration: Connect with marketplace services.
    - SSL Certificates: Manage SSL/TLS certificates for domains.
```

--------------------------------

### cPanel UAPI Directory Management

Source: https://api.docs.cpanel.net/cpanel/introduction/custom

Covers API functions for managing directories, including index settings, privacy, and protection.

```APIDOC
Directory Management:
  Purpose: Control access and display settings for website directories.
  Modules:
    - Directory Indexes: Configure directory listing behavior.
    - Directory Privacy: Set password protection for directories.
    - Directory Protection: Implement security measures for directories.
```

--------------------------------

### cPanel UAPI Database Management

Source: https://api.docs.cpanel.net/cpanel/introduction/filters

Covers API functions for managing MySQL and MariaDB databases, including information retrieval and administration.

```APIDOC
MySQL and MariaDB Management:
  Purpose: Administer MySQL and MariaDB databases.
  Modules:
    - Database Information: Retrieve details about existing databases.
    - Database Management: Create, modify, delete databases and users.
```

--------------------------------

### cPanel UAPI DNS Management

Source: https://api.docs.cpanel.net/cpanel/introduction/introduction

Details API endpoints for managing DNS records, zones, and related security settings.

```APIDOC
DNS Management:
  Purpose: Configure and manage Domain Name System (DNS) records and settings.
  Modules:
    - DNS: General DNS zone management.
    - DNS Information: Retrieve DNS zone data.
    - DNS Security: Configure DNS security features (e.g., DNSSEC).
    - Dynamic DNS: Manage dynamic DNS updates.
    - Email DNS Settings: Configure DNS records specific to email services (e.g., MX, SPF, DKIM).
```

--------------------------------

### cPanel UAPI Batch Operations

Source: https://api.docs.cpanel.net/cpanel/introduction/sorting

Details API endpoints for performing batch operations, allowing multiple actions to be executed in a single request.

```APIDOC
Batch Operations:
  Purpose: Execute multiple API calls efficiently in a single request.
  Functionality: Allows for sequential or parallel execution of API commands.
```

--------------------------------

### cPanel UAPI DNS Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API endpoints for managing DNS records, zones, and related security settings.

```APIDOC
DNS Management:
  Purpose: Configure and manage Domain Name System (DNS) records and settings.
  Modules:
    - DNS: General DNS zone management.
    - DNS Information: Retrieve DNS zone data.
    - DNS Security: Configure DNS security features (e.g., DNSSEC).
    - Dynamic DNS: Manage dynamic DNS updates.
    - Email DNS Settings: Configure DNS records specific to email services (e.g., MX, SPF, DKIM).
```

--------------------------------

### cPanel UAPI SSE Task Management

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Provides API endpoints for managing Server-Sent Events (SSE) tasks, enabling real-time updates.

```APIDOC
SSE Task Management:
  Purpose: Manage tasks that utilize Server-Sent Events for real-time data streaming.
  Functionality: Monitor and control tasks that push updates from the server to the client.
```

--------------------------------

### cPanel UAPI Batch Operations

Source: https://api.docs.cpanel.net/cpanel/introduction/tokens

Details API endpoints for performing batch operations, allowing multiple actions to be executed in a single request.

```APIDOC
Batch Operations:
  Purpose: Execute multiple API calls efficiently in a single request.
  Functionality: Allows for sequential or parallel execution of API commands.
```