Download the PHP package keensoen/cpanel-api without Composer
On this page you can find all versions of the php package keensoen/cpanel-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download keensoen/cpanel-api
More information about keensoen/cpanel-api
Files in keensoen/cpanel-api
Package cpanel-api
Short Description cPanel API which enables you to connect and carry out several common task in the cpanel
License MIT
Homepage https://github.com/keensoen/cpanel-api
Informations about the package cpanel-api
Laravel CPanel API
Laravel Package for CPanel UAPI
Please consider starring the project to show your :heart: and support.
This laravel package allows you to connect and manage you CPanel based hosting using CPanel UAPI.
Some practical usages are:
- Create database, sub domains, emails accounts etc
- Create database users
- Set privileges on database of any user
- List all email account of the specified domain
- Check email account size
- Increase email quota when need arises
- Delete email account when necessary
Learn more about at CPanel UAPI
Installation
Step 1) Install the Package
Use following composer command to install the package
or
Add keensoen/cpanel-api
as a requirement to composer.json
:
Update composer:
Step 2) Publish Configurations
Run following command:
Step 3) Set CPanel details in .env
or
To generate CPANEL_API_TOKEN
, login to the CPanel >> SECURITY >> Manage API Tokens >> Create
.
Usages & available methods
Make sure you import:
To Get List of All Email Account in the CPanel
Create Email Account
Your password must be eight character above and should contain alphanumeric and symbols. For example
To Delete Email Account
You will have to pass a full email address to be able to delete the account.
To Get Email Account Disk Usage
You will have to pass a full email address of which you want to get disk usage.
To Increase Email Account Quota
You will have to pass a full email address of which you want to get disk usage.
To Create Database
Database name should be prefixed with cpanel username cpanelusername_databasename
If your CPanel username is surf
then your database name
| should be surf_website
.
Find More Details at CPanel UAPI - Mysql::create_database
To Delete Database
CPanel UAPI - Mysql::delete_database
To Get List of All Databases in the CPanel
To Create Database User
To Delete Database User
To Give All Privileges to a Database User On a Database
Using CPanel UAPI Methods
You can also call all the method available at CPanel UAPI using following method:
for example if you want to add new ftp
account, documetation is available at CPanel UAPI - Ftp::add_ftp then use the method as represented below:
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Agbadu Daniel S.
- All Contributors
License
The MIT License (MIT). Please see License File for more information.