PHPackages                             coulterpeterson/cloudways-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. coulterpeterson/cloudways-api

ActiveLibrary[API Development](/categories/api)

coulterpeterson/cloudways-api
=============================

A Class which contains a collection of Cloudways API for ease of use. All the available API from the Cloudways Docs are included. Happy Coding.

v1.0.2(2y ago)0138MITPHP

Since Oct 30Pushed 2y agoCompare

[ Source](https://github.com/coulterpeterson/cloudways-api)[ Packagist](https://packagist.org/packages/coulterpeterson/cloudways-api)[ RSS](/packages/coulterpeterson-cloudways-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (4)Used By (0)

Cloudways API
=============

[](#cloudways-api)

**Forked from [mohamedshuaau/cloudways-api](https://github.com/mohamedshuaau/cloudways-api).**

This API is built to make your coding experience less stressful and help you get started without the hassle of extra codes. This package contains a class with all the functions which are available on the official API Documentation of Cloudways.

**Please bare in mind that some of these functions may not work as intended as Cloudways API is still on beta version. Some of the URL's does not output the expected results.**

Installation
============

[](#installation)

```
composer require coulterpeterson/cloudways-api

```

This package requires guzzlehttp to work but it will automatically be installed with this package. If you are still having trouble with guzzle, manually install with:

```
composer require guzzlehttp/guzzle

```

For normal use cases, or if you want to just include the class file separately, feel free for download the file and use it at your convenience.

Usage
=====

[](#usage)

As mentioned earlier, the class contains all the RESTAPI calls available in Cloudways. To see the available functions, please visit the cloudways official documentation at: Here you will find all the information, required parameters and types of values required.

**Basic Usage:**

```
// Use Composer's autoload (if using Laravel, the package will be loaded as a service automatically)
require_once 'vendor/autoload.php';

//Here is where you define the email address and your API key from Cloudways
$CW_API = new \CoulterPeterson\CloudwaysApi\CloudwaysAPIClient('example@gmail.com', 'API_KEY');

//Magic
$server_settings = $CW_API->get_server_settings('12345');   // (Server ID)

//object to json
$json = json_encode($server_settings);

//json to json array
$decode = json_decode($json, true);

return $decode;

```

**Expected Result:**

```
{"settings":{"apc.shm_size":"32","character_set_server":"ascii","date.timezone":"","display_errors":"Off","error_reporting":"E_ALL & ~E_DEPRECATED & ~E_STRICT","execution_limit":"60","innodb_buffer_pool_size":"","innodb_lock_wait_timeout":"","key_buffer_size":"","max_connections":"150","max_input_time":"60","max_input_vars":"2500","memory_limit":"128","mod_xdebug":"disable","nginx_http2":"enable","package_versions":{"fpm":"enable","mariadb":"","mysql":"5.7","php":"7.3","redis":""},"short_open_tag":"off","static_cache_expiry":"43200","upload_size":"10","wait_timeout":""}}

```

The result originally comes as an object and we are using the `json_encode` to change it to a json. And afterwards we use the `json_decode` with the second parameter `true` to change it to a json array. And the output is as shown on the above example.

There are approximately a 140 functions which are available from the Cloudways docs. The function names are respective to the names given in the Cloudways docs.

Please refer to the [Functions List](FunctionsList.md) for all the available functions and required parameters.

Feel free to open any suggestions or issues. Your suggestions and helps are always open. Happy Coding! :)

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 57.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

923d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/a71afc59d631e498e6e63913f54388049dccfc49ecb947795c67a403bff49e81?d=identicon)[coulterpeterson](/maintainers/coulterpeterson)

---

Top Contributors

[![armageddan](https://avatars.githubusercontent.com/u/31499401?v=4)](https://github.com/armageddan "armageddan (8 commits)")[![coulterpeterson](https://avatars.githubusercontent.com/u/29346967?v=4)](https://github.com/coulterpeterson "coulterpeterson (5 commits)")[![mohamedshuaau](https://avatars.githubusercontent.com/u/39324930?v=4)](https://github.com/mohamedshuaau "mohamedshuaau (1 commits)")

### Embed Badge

![Health badge](/badges/coulterpeterson-cloudways-api/health.svg)

```
[![Health](https://phpackages.com/badges/coulterpeterson-cloudways-api/health.svg)](https://phpackages.com/packages/coulterpeterson-cloudways-api)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)