PHP download

Download the PHP package corsinvest/cv4pve-api-php without Composer

On this page you can find all versions of the php package corsinvest/cv4pve-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download corsinvest/cv4pve-api-php
More information about corsinvest/cv4pve-api-php
Files in corsinvest/cv4pve-api-php

Vendor corsinvest
Package cv4pve-api-php
Short Description Corsinvest Proxmox VE Client API PHP
License GPL-3.0-only
Homepage https://github.com/Corsinvest/cv4pve-api-php

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

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of corsinvest/cv4pve-api-php

Informations about the package cv4pve-api-php

cv4pve-api-php

Packagist Downloads (custom server)

Proxmox VE Client API PHP

Proxmox VE Api

Copyright and License

Commercial Support

This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the site

General

The client is generated from a JSON Api on Proxmox VE.

This PHP 5.4+ library allows you to interact with your Proxmox server via API. The client is generated from a JSON Api on Proxmox VE.

Result

The result is class Result and contain methods:

getResponse() returned from Proxmox VE (data,errors,...) Object/Array
responseInError (bool) : Contains errors from Proxmox VE.
getStatusCode() (int) : Status code of the HTTP response.
getReasonPhrase() (string): The reason phrase which typically is sent by servers together with the status code.
isSuccessStatusCode() (bool) : Gets a value that indicates if the HTTP response was successful.
getError() (string) : Get error.
getResponseHeaders() (string) : Gets the raw HTTP headers associated with this response.

Main features

Easy to learn
No dependency external library only native curl
Implementation respect the Api structure of Proxmox VE
Method named
Set ResponseType json, png
Full method generated from documentation
Comment any method and parameters
Parameters indexed eg [n] is structured in array index and value
Tree structure
- $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->getResponse()->data
Return data proxmox
Return result
- Request
- Response
- Status
Wait task finish task
- waitForTaskToFinish
- taskIsRunning
- getExitStatusTask
Method direct access
- get
- set
- create
- delete
Login return bool if access
Return Result class more information
Return object/array data
- default object disable from client.setResultIsObject(false)
ClientBase lite function
Form Proxmox VE 6.2 support Api Token for user
Login with One-time password for Two-factor authentication.
Set Timeout for the Connection.

Api token

From version 6.2 of Proxmox VE is possible to use Api token. This feature permit execute Api without using user and password. If using Privilege Separation when create api token remember specify in permission. Format USER@REALM!TOKENID=TOKEN (Usage example below)

Installation

Recommended installation is using [Composer], if you do not have [Composer] what are you waiting?

In the root of your project execute the following:

Or add this to your composer.json

Usage

Sample output version request:

The parameter indexed end with '[n]' in documentation (method createVM in Qemu parameter ide) require array whit key and value

Usage with API-token instead username/password

All versions of cv4pve-api-php with dependencies

PHP Build Version

Package Version

Version 8.3.0 Release 19. Dec 2024
create-project require 1 people choosed require and
0 people choosed create-project.

Download

Download latest version of cv4pve-api-php from vendor corsinvest

Requires php Version >=5.5.0
lib-curl Version *

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package corsinvest/cv4pve-api-php contains the following files

Loading the files please wait ....