https://github.com/client-api/pbs-php
https://github.com/client-api/pbs-php
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/client-api/pbs-php
- Owner: client-api
- License: apache-2.0
- Created: 2026-05-23T13:28:25.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-24T10:06:20.000Z (about 1 month ago)
- Last Synced: 2026-05-24T11:29:40.684Z (about 1 month ago)
- Language: PHP
- Size: 724 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pbs-php
PHP SDK for the Proxmox Backup Server API. Generated from
the upstream `apidoc.js` from Proxmox Backup Server via [openapi-generator-cli][gen] with custom
Mustache template overrides.
> **Not an official Proxmox project.** Community SDK derived from the
> upstream `apidoc.js`. Always verify against the upstream API viewer.
> .
Requires PHP ≥ 7.4.
## Install
```bash
composer require client-api/pbs
```
## Usage
```php
setHost('https://pbs1.example.com:8007/api2/json')
->setApiKey('Authorization', 'PBSAPIToken=user@realm!tokenid:uuid-secret');
$pve = new Pbs($cfg);
// Per-tag accessors are lazily instantiated and share the same Configuration.
$status = $pbs->qemu()->qemuVmStatus(node: 'pbs1', vmid: 100);
$nodes = $pbs->nodes()->nodesGetNodes();
```
The unified `Pbs` class wraps each per-tag API class (`QemuApi`,
`LxcApi`, `ClusterApi`, `NodesApi`, …) so consumers don't need to
instantiate them individually.
## Compound configs
PVE encodes many fields as CLI-style shorthand strings
(`net0=virtio,bridge=vmbr0,firewall=1`). Round-trip helpers are
emitted for every compound config schema:
```php
use ClientApi\Pbs\Model\PveQemuNetConfig;
$cfg = new PveQemuNetConfig([
'model' => 'virtio',
'bridge' => 'vmbr0',
'firewall' => 1,
]);
$shorthand = $cfg->toShorthand();
// → 'virtio,bridge=vmbr0,firewall=1'
$parsed = PveQemuNetConfig::fromShorthand($shorthand);
```
## Indexed families
Numbered properties (`net0..net31`, `mp0..mp255`, …) are exposed on
every model as a single collapsed `getNets()` / `setNets()` accessor.
The per-index `getNet0`/`setNet0`/… methods are filtered out of the
class surface (the wire format is preserved internally via a `__call`
magic dispatcher):
```php
$req->setNets([
0 => 'virtio,bridge=vmbr0',
3 => 'e1000,bridge=vmbr1',
]);
// Wire format: { "net0": "virtio,bridge=vmbr0", "net3": "e1000,bridge=vmbr1" }
```
## License
Apache 2.0 — see [LICENSE](./LICENSE).
[gen]: https://openapi-generator.tech