PHPackages                             fintech-systems/virtualmin-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. fintech-systems/virtualmin-api

ActiveLibrary[API Development](/categories/api)

fintech-systems/virtualmin-api
==============================

A Virtualmin API designed to run standalone or as part of a Laravel Application

1.0.0(4y ago)6521[1 issues](https://github.com/fintech-systems/virtualmin-api/issues)MITPHP

Since Sep 1Pushed 4y ago2 watchersCompare

[ Source](https://github.com/fintech-systems/virtualmin-api)[ Packagist](https://packagist.org/packages/fintech-systems/virtualmin-api)[ RSS](/packages/fintech-systems-virtualmin-api/feed)WikiDiscussions main Synced today

READMEChangelog (7)Dependencies (1)Versions (9)Used By (0)

Virtualmin API
==============

[](#virtualmin-api)

[![GitHub release (latest by date)](https://camo.githubusercontent.com/d0bede691ef19bd915c0d5ccd5bc5dbd54dc90fb510288ac502f2240e7ed9baa/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f66696e746563682d73797374656d732f7669727475616c6d696e2d617069)](https://camo.githubusercontent.com/d0bede691ef19bd915c0d5ccd5bc5dbd54dc90fb510288ac502f2240e7ed9baa/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f66696e746563682d73797374656d732f7669727475616c6d696e2d617069) [![Build Status](https://camo.githubusercontent.com/522c50d9ec655dfd67f974808c7320db619a024df61c0dc581d63b6f9531abc7/68747470733a2f2f6170702e7472617669732d63692e636f6d2f66696e746563682d73797374656d732f7669727475616c6d696e2d6170692e7376673f6272616e63683d6d61696e)](https://app.travis-ci.com/fintech-systems/virtualmin-api) [![GitHub](https://camo.githubusercontent.com/d3e25e98d485842d290589c6fd2c36d5e22506f29361057c5f684872768d6b4a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f66696e746563682d73797374656d732f7669727475616c6d696e2d617069)](https://camo.githubusercontent.com/d3e25e98d485842d290589c6fd2c36d5e22506f29361057c5f684872768d6b4a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f66696e746563682d73797374656d732f7669727475616c6d696e2d617069)

A Virtualmin API designed to run standalone or as part of a Laravel Application

Requirements:

- PHP 8.0
- A running Virtualmin server, using the [Remote API](https://www.virtualmin.com/documentation/developer/http/)

Features:

- List Domains (Virtualmin output)
- Get Domains (User-Friendly Output)
- Change Plan
- List Plans (Virtualmin output)
- Get Plans (User-Friendly Output)
- Create Domain

Get Domains
-----------

[](#get-domains)

Framework Agnostic PHP:

```
use \FintechSystems\VirtualminApi\VirtualminApi;
$api = new VirtualminApi(
        'hostname' => 'virtualmin.test',
        'username' => 'root',
        'password' => '********'
    );
$api->getDomains();
```

Laravel App:

```
VirtualminApi::getDomains();
```

Output:

Array of all domains on a Virtualmin server.

Change Plan
-----------

[](#change-plan)

Framework Agnostic PHP:

```
use \FintechSystems\VirtualminApi\VirtualminApi;
$api = new VirtualminApi;
$api->changePlan('example.com', 'New Plan Name');
```

Laravel App:

```
VirtualminApi::changePlan('example.com', 'New Plan Name');
```

Create Domain
-------------

[](#create-domain)

Example:

```
$api->createDomain([
    // New virtual server details
    'domain'                 => 'demo.example.com',
    'desc'                   => 'My demo website',
    'pass'                   => '***************',
    'template'               => 'WikiSuite 1',
    'plan'                   => 'WikiSuite 1',

    // Advanced options
    'email'                  => 'contact@example.com',
    'db'                     => 'demo_example_com',

    // Enabled features
    'features-from-plan'     => '',
    'virtualmin-tikimanager' => ''
]))
```

Testing
-------

[](#testing)

We have tests! Use the command below to run the tests.

Live API calls will be made otherwise causing your tests to fail.

`vendor/bin/phpunit --exclude-group=live`

### Coverage reports

[](#coverage-reports)

To regenerate coverage reports:

`XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html=tests/coverage-report`

See also `.travis.yml`

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Version Control
---------------

[](#version-control)

This application uses Semantic Versioning

Local Editing
-------------

[](#local-editing)

For local editing, add this to `composer.json`:

```
"repositories" : [
        {
            "type": "path",
            "url": "../virtualmin-api"
        }
    ]
```

Credits
-------

[](#credits)

- [Eugene van der Merwe](https://github.com/eugenevdm)
- [Fabio Montefuscolo](https://github.com/fabiomontefuscolo)
- [Marc Laporte](https://github.com/marclaporte)
- [Domeshow](https://github.com/Domeshow)

Inspiration
-----------

[](#inspiration)

This standalone package was inspired by video course by Marcel Pociot of BeyondCode:
[PHP Package Development](https://beyondco.de/video-courses/php-package-development)

Before doing the video course I had developed many versions of the same thing but it was never standalone and as a consequence over the years it was difficult to maintain and quickly use in new projects.

How to contribute
-----------------

[](#how-to-contribute)

Please add issues and merge requests via GitHub.

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

27

—

LowBetter than 51% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90% 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 ~27 days

Total

7

Last Release

1499d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/932743c076390240ecdefe58dc5f81b60cb5fe9ed38b3bead0541f640a7bb2a8?d=identicon)[eugenevdm](/maintainers/eugenevdm)

---

Top Contributors

[![eugenefvdm](https://avatars.githubusercontent.com/u/1836436?v=4)](https://github.com/eugenefvdm "eugenefvdm (63 commits)")[![fabiomontefuscolo](https://avatars.githubusercontent.com/u/162023?v=4)](https://github.com/fabiomontefuscolo "fabiomontefuscolo (5 commits)")[![Domeshow](https://avatars.githubusercontent.com/u/60592554?v=4)](https://github.com/Domeshow "Domeshow (1 commits)")[![marclaporte](https://avatars.githubusercontent.com/u/1004261?v=4)](https://github.com/marclaporte "marclaporte (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fintech-systems-virtualmin-api/health.svg)

```
[![Health](https://phpackages.com/badges/fintech-systems-virtualmin-api/health.svg)](https://phpackages.com/packages/fintech-systems-virtualmin-api)
```

###  Alternatives

[google/apiclient

Client library for Google APIs

9.8k186.9M901](/packages/google-apiclient)[stripe/stripe-php

Stripe PHP Library

4.0k139.3M419](/packages/stripe-stripe-php)[webonyx/graphql-php

A PHP port of GraphQL reference implementation

4.7k75.4M279](/packages/webonyx-graphql-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k90.6M252](/packages/twilio-sdk)[friendsofsymfony/jsrouting-bundle

A pretty nice way to expose your Symfony routing to client applications.

1.5k52.7M208](/packages/friendsofsymfony-jsrouting-bundle)[knplabs/github-api

GitHub API v3 client

2.2k15.3M171](/packages/knplabs-github-api)

PHPackages © 2026

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