Download the PHP package triopsi/proxmoxve without Composer
On this page you can find all versions of the php package triopsi/proxmoxve. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download triopsi/proxmoxve
More information about triopsi/proxmoxve
Files in triopsi/proxmoxve
Package proxmoxve
Short Description A simple PHP 8+ Proxmox API client.
License MIT
Homepage https://github.com/triopsi/ProxmoxVE
Informations about the package proxmoxve
ProxmoxVE API Client
This PHP 8+ library allows you to interact with your Proxmox server via API.
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
file:
Then perform the installation:
Usage for login:
Usage with api token:
Sample output:
Using the MailGateway API
This library can be used to communicate with the Proxmox MailGateway API as well, by simply changing the system
entry in the credentials array.
Want to know more nifty tricks?
Checkout our wiki.
Docs
On your proxmox client object you can use get()
, create()
, set()
and delete()
functions for all resources specified at [PVE2 API Documentation], params are passed as the second parameter in an associative array.
What resources or paths can I interact with and how?
In your proxmox server you can use the pvesh CLI Tool to manage all the pve resources, you can use this library in the exact same way you would use the pvesh tool. For instance you could run pvesh
then, as the screen message should say, you can type help [path] [--verbose]
to see how you could use a path and what params you should pass to it. Be sure to read about the pvesh CLI Tool at the [Proxmox wiki].
How does the Proxmox API works?
Consult the [ProxmoxVE API] article at the [Proxmox wiki].
I feel you're hiding some cool tricks! I need more docs!
See the project's wiki for a more detailed documentation, it's all in there I swear it... I think.
License
This project is released under the MIT License. See the bundled [LICENSE] file for details.