PHPackages                             alexisducastel/pve2api - 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. alexisducastel/pve2api

ActiveLibrary

alexisducastel/pve2api
======================

This is a simple PHP client for Proxmox API

1.0.1(11y ago)1781PHP

Since May 29Pushed 11y ago1 watchersCompare

[ Source](https://github.com/AlexisDucastel/pve2api)[ Packagist](https://packagist.org/packages/alexisducastel/pve2api)[ RSS](/packages/alexisducastel-pve2api/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (4)Used By (1)

This class implements a simple PHP client for Proxmox API (version 2 or later).

See [http://pve.proxmox.com/wiki/Proxmox\_VE\_API](http://pve.proxmox.com/wiki/Proxmox_VE_API) for information about how this API works. API spec available at

Requirements:
-------------

[](#requirements)

PHP 5 with cURL (including SSL) support.

Usage:
------

[](#usage)

Example - Return status array for each Proxmox Host in this cluster.

```
# use composer autoloader
require_once __DIR__."/vendor/autoload.php";

$api=new PVE\Api\Client('hostname');

# realm can be pve, pam or any other realm available.
$api->login('login','realm','password');

foreach ($api->get_node_list() as $node_name) {
    print_r($api->get("/nodes/".$node_name."/status"));
}

```

Example - Create a new OpenVZ Container on the first host in the cluster.

```
# use composer autoloader
require_once __DIR__."/vendor/autoload.php";

$api=new PVE\Api\Client('hostname');

# realm can be pve, pam or any other realm available.
$api->login('login','realm','password');

# Get first node name.
$nodes = $api->get_node_list();

# Create a VZ container on the first node in the cluster.
$new_container_settings = array();
$new_container_settings['ostemplate'] = "local:vztmpl/debian-6.0-standard_6.0-4_amd64.tar.gz";
$new_container_settings['vmid'] = "1234";
$new_container_settings['cpus'] = "2";
$new_container_settings['description'] = "Test VM using Proxmox 2.0 API";
$new_container_settings['disk'] = "8";
$new_container_settings['hostname'] = "testapi.domain.tld";
$new_container_settings['memory'] = "1024";
$new_container_settings['nameserver'] = "8.8.8.8";

print_r($api->post("/nodes/".$nodes[0]."/openvz", $new_container_settings));

```

Example - Modify DNS settings on an existing container on the first host.

```
# use composer autoloader
require_once __DIR__."/vendor/autoload.php";

$api=new PVE\Api\Client('hostname');

# realm can be pve, pam or any other realm available.
$api->login('login','realm','password');

# Get first node name.
$nodes = $api->get_node_list();
$openvzId = "100";

# Update container settings.
$container_settings = array();
$container_settings['nameserver'] = "4.2.2.2";

var_dump($api->put("/nodes/".$first_node."/openvz/".$openvzId."/config", $container_settings));

```

Example - Delete an existing container.

```
# use composer autoloader
require_once __DIR__."/vendor/autoload.php";

$api=new PVE\Api\Client('hostname');

# realm can be pve, pam or any other realm available.
$api->login('login','realm','password');

# Get first node name.
$nodes = $api->get_node_list();
$openvzId = "100";

var_dump($api->delete("/nodes/".$nodes[0]."/openvz/".$openvzId));

```

Licensed under the MIT License. See LICENSE file.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 73.7% 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 ~1 days

Total

2

Last Release

4365d ago

### Community

Maintainers

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

---

Top Contributors

[![CpuID](https://avatars.githubusercontent.com/u/916201?v=4)](https://github.com/CpuID "CpuID (14 commits)")[![AlexisDucastel](https://avatars.githubusercontent.com/u/1911945?v=4)](https://github.com/AlexisDucastel "AlexisDucastel (4 commits)")[![ypilpre](https://avatars.githubusercontent.com/u/5433576?v=4)](https://github.com/ypilpre "ypilpre (1 commits)")

### Embed Badge

![Health badge](/badges/alexisducastel-pve2api/health.svg)

```
[![Health](https://phpackages.com/badges/alexisducastel-pve2api/health.svg)](https://phpackages.com/packages/alexisducastel-pve2api)
```

PHPackages © 2026

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