corsinvest/cv4pve-api-php

Corsinvest Proxmox VE Client API PHP

8.4.1 2025-07-14 08:48 UTC

Requires

• php: >=5.5.0
• lib-curl: *

GPL-3.0-only

• Daniele Corsini

• api
• Virtualization
• cluster
• Proxmox
• KVM
• LXC
• client api
• Corsinvest
• Proxmox VE

README

🚀 Official PHP Client Library Suite for Proxmox VE API

⭐ We appreciate your star, it helps! ⭐

   ______                _                      __
  / ____/___  __________(_)___ _   _____  _____/ /_
 / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
\____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

Corsinvest for Proxmox VE Api Client  (Made in Italy 🇮🇹)

📖 About

cv4pve-api-php is a comprehensive PHP client library that provides seamless integration with Proxmox VE's REST API. Designed for developers who need to programmatically manage virtual machines, containers, storage, and cluster resources in Proxmox VE environments.

📦 Package Suite

Package	Description	Status
corsinvest/cv4pve-api-php	Core API Client Library	✅ Available

🚀 Quick Start

Installation

composer require corsinvest/cv4pve-api-php

Basic Usage

<?php
require_once 'vendor/autoload.php';

use Corsinvest\ProxmoxVE\Api\PveClient;

$client = new PveClient("your-proxmox-host.com");

if ($client->login('root', 'password', 'pam')) {
    // Get cluster status
    $status = $client->getNodes()->get("pve1")->getStatus()->current();
    echo "Node Status: " . $status->getResponse()->data->status . "\n";
    
    // List VMs
    foreach ($client->getNodes()->get("pve1")->getQemu()->vmlist()->getResponse()->data as $vm) {
        echo "VM {$vm->vmid}: {$vm->name} - Status: {$vm->status}\n";
    }
}

🌟 Key Features

Developer Experience

• 💡 Intuitive API Structure - Mirrors Proxmox VE API hierarchy for easy navigation
• 📝 Comprehensive Documentation - Detailed examples and API reference
• 🔧 Easy Integration - Simple composer installation and minimal setup required
• ⚡ Flexible Response Handling - Choose between object or array response formats

Core Functionality

• 🌐 Complete API Coverage - Full implementation of Proxmox VE REST API endpoints
• 🖥️ VM & Container Management - Create, configure, start, stop, and monitor VMs and containers
• 💾 Storage Operations - Manage storage pools, volumes, and backups
• 📊 Cluster Management - Monitor cluster status, resources, and performance

Enterprise Ready

• 🔐 Multiple Authentication Methods - Username/password, API tokens, and two-factor authentication
• 🛡️ Security First - Secure communication with SSL/TLS support
• 📈 Task Management - Built-in support for monitoring long-running operations
• ⏱️ Connection Management - Configurable timeouts and connection pooling

Technical Excellence

• 🚀 Zero Dependencies - Lightweight design using only native PHP cURL
• 🏗️ PHP 5.5+ Compatible - Wide compatibility with modern and legacy environments
• 🔄 Error Handling - Comprehensive error reporting and exception management
• 📱 Cross-Platform - Works on Windows, Linux, and macOS

📚 Documentation

• 🔗 API Reference - Complete method documentation
• 🛠️ Configuration Guide - Setup and customization options
• 🔐 Authentication - Login methods and API tokens
• 📋 Usage Examples - Practical code examples
• ⚙️ Task Management - Handle long-running operations
• 🚨 Error Handling - Exception management

🤝 Community & Support

🆘 Getting Help

• 📚 Documentation - Comprehensive guides and examples
• 🐛 GitHub Issues - Bug reports and feature requests
• 💼 Commercial Support - Professional consulting and support

🏢 About Corsinvest

Corsinvest Srl is an Italian software company specializing in virtualization solutions. We develop professional tools and libraries for Proxmox VE that help businesses automate and manage their virtual infrastructure efficiently.

🤝 Contributing

We welcome contributions from the community! Whether it's bug fixes, new features, or documentation improvements, your help makes this project better for everyone.

🎯 Use Cases

Perfect for:

• 🏢 Infrastructure Automation - Automate VM/CT deployment and configuration
• 📊 Monitoring & Analytics - Build custom dashboards and monitoring solutions
• 💾 Backup Management - Implement automated backup and disaster recovery workflows
• 🌐 Multi-tenant Environments - Manage multiple Proxmox VE clusters and tenants
• 🔄 DevOps Integration - Integrate with CI/CD pipelines and deployment automation

⚙️ Requirements

• PHP: 5.5.0 or higher
• Extension: php-curl (typically included with PHP)
• Composer: For dependency management

📄 License

Copyright © Corsinvest Srl

This software is part of the cv4pve-tools suite. For licensing details, please visit LICENSE.

_{Part of cv4pve-tools suite | Made with ❤️ in Italy by Corsinvest}