Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliashaeussler/cpanel-requests
Small PHP library enabling requests to cPanel instances
https://github.com/eliashaeussler/cpanel-requests
api cpanel request uapi
Last synced: 15 days ago
JSON representation
Small PHP library enabling requests to cPanel instances
- Host: GitHub
- URL: https://github.com/eliashaeussler/cpanel-requests
- Owner: eliashaeussler
- License: gpl-3.0
- Created: 2022-03-06T20:56:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T08:12:12.000Z (8 months ago)
- Last Synced: 2024-05-01T16:20:50.862Z (8 months ago)
- Topics: api, cpanel, request, uapi
- Language: PHP
- Homepage:
- Size: 745 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cPanel Requests
[](https://coveralls.io/github/eliashaeussler/cpanel-requests)
[](https://codeclimate.com/github/eliashaeussler/cpanel-requests/maintainability)
[](https://github.com/eliashaeussler/cpanel-requests/actions/workflows/tests.yaml)
[](https://github.com/eliashaeussler/cpanel-requests/actions/workflows/cgl.yaml)
[](https://packagist.org/packages/eliashaeussler/cpanel-requests)
[](https://packagist.org/packages/eliashaeussler/cpanel-requests)
[](LICENSE)
:package: [Packagist](https://packagist.org/packages/eliashaeussler/cpanel-requests) |
:floppy_disk: [Repository](https://github.com/eliashaeussler/cpanel-requests) |
:bug: [Issue tracker](https://github.com/eliashaeussler/cpanel-requests/issues)
A simple PHP project to make API requests on your [cPanel](https://cpanel.com/) installation.
This allows you to call modules inside the installation and interact with them to add, show or
list data such as domains, e-mail accounts, databases and so on.
**The project makes use of [UAPI](https://documentation.cpanel.net/display/DD/Guide+to+UAPI).
Therefore, it is required to have a cPanel installation with at least version 42 running**.
## :fire: Installation
```bash
composer require eliashaeussler/cpanel-requests
```
:warning: If you want to use two-factor authentication together with
the HTTP session [authorization](#authorization) method, you must
**manually require the `spomky-labs/otphp` package (>= 11.1)**.
## :zap:Usage
### Authorization
The following authorization methods are currently available:
| Type | Implementation class |
|----------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| Authorization via [**API token**][1] (recommended) | [`Application\Authorization\TokenAuthorization`](src/Application/Authorization/TokenAuthorization.php) |
| Authorization via [**HTTP session**][2] | [`Application\Authorization\HttpAuthorization`](src/Application/Authorization/HttpAuthorization.php) |
:bulb: You can also provide your own implementation for authorization
at your cPanel instance. For this, you have to implement the interface
[`Application\Authorization\AuthorizationInterface`](src/Application/Authorization/AuthorizationInterface.php).
### Create a new [`CPanel`](src/Application/CPanel.php) instance
Once you have selected an authentication method, you can create a
new [`Application\CPanel`](src/Application/CPanel.php) instance:
```php
use EliasHaeussler\CpanelRequests\Application;
/** @var Application\Authorization\AuthorizationInterface $authorization */
$cPanel = new Application\CPanel($authorization, 'example.com', 2083);
```
### Perform API requests
Now you're able to make API requests:
```php
use EliasHaeussler\CpanelRequests\Application;
/** @var Application\CPanel $cPanel */
$response = $cPanel->api('', '', ['optional' => 'parameters']);
if ($response->isValid()) {
// Do anything...
// Response data can be fetched using $response->getData()
}
```
**Note that currently only GET requests are supported.**
Visit the [official documentation][3] to get an overview about
available API modules and functions.
## :bee: Example
```php
use EliasHaeussler\CpanelRequests\Application;
use EliasHaeussler\CpanelRequests\Http;
$authorization = new Application\Authorization\TokenAuthorization(
username: 'bob',
token: '9CKU401OH5WVDGSAVXN3UMLT8BJ5IY',
);
$cPanel = new Application\CPanel(
authorization: $authorization,
host: 'cpanel.bobs.site',
port: 2083,
protocol: Http\Protocol::Https,
);
// Fetch domains from cPanel API
$response = $cPanel->api(
module: 'DomainInfo',
function: 'list_domains',
);
if (!$response->isValid()) {
throw new \RuntimeException('Got invalid response from cPanel application.');
}
$domains = $response->getData()->data;
echo 'Bob\'s main domain is: ' . $domains->main_domain;
```
## :wastebasket: Cleanup
The project provides a console application that can be used to execute
several cleanup commands from the command line.
```bash
# General usage
vendor/bin/cpanel-requests
# Remove expired request cookie files (default lifetime: 1 hour)
vendor/bin/cpanel-requests cleanup:cookies
vendor/bin/cpanel-requests cleanup:cookies --lifetime 1800
# Remove log files
vendor/bin/cpanel-requests cleanup:logs
```
## :technologist: Contributing
Please have a look at [`CONTRIBUTING.md`](CONTRIBUTING.md).
## :star: License
This project is licensed under [GNU General Public License 3.0 (or later)](LICENSE).
[1]: https://api.docs.cpanel.net/cpanel/tokens/
[2]: https://api.docs.cpanel.net/cpanel/introduction/
[3]: https://documentation.cpanel.net/display/DD/Guide+to+UAPI