https://github.com/client-api/pbs-python
https://github.com/client-api/pbs-python
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/client-api/pbs-python
- Owner: client-api
- License: apache-2.0
- Created: 2026-05-23T13:28:34.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-23T14:57:22.000Z (about 1 month ago)
- Last Synced: 2026-05-23T16:22:44.650Z (about 1 month ago)
- Language: Python
- Size: 363 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clientapi_pbs
Python 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 Python ≥ 3.9.
## Install
```bash
pip install clientapi-pbs
```
Or for development:
```bash
pip install -r requirements.txt
```
## Usage
```python
from clientapi_pbs import Configuration, Pve
cfg = Configuration(
host='https://pbs1.example.com:8007/api2/json',
api_key={'Authorization': 'PBSAPIToken=user@realm!tokenid:uuid-secret'},
)
pbs = Pbs(configuration=cfg)
# Per-tag properties are lazily instantiated and share the same ApiClient.
# `removeOperationIdPrefix=true` strips the tag prefix from method names,
# so the call is `pbs.qemu.vm_status(...)`, not `pbs.qemu.qemu_vm_status(...)` —
# you're already inside the `qemu` namespace.
status = pbs.qemu.vm_status(node='pbs1', vmid=100)
nodes = pbs.nodes.get_nodes()
```
### Discovering available methods
Each per-tag API class lives at `clientapi_pbs.api._api.Api`.
List its methods to see what's callable:
```python
print([m for m in dir(pbs.qemu) if not m.startswith('_')])
```
Generated method-level docstrings explain parameters; the upstream
endpoint reference is the upstream API viewer.
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:
```python
from clientapi_pbs.models import PveQemuNetConfig
cfg = PveQemuNetConfig(model='virtio', bridge='vmbr0', firewall=1)
shorthand = cfg.to_shorthand() # → 'virtio,bridge=vmbr0,firewall=1'
parsed = PveQemuNetConfig.from_shorthand(shorthand)
```
## Indexed families
Numbered properties (`net0..net31`, `mp0..mp255`, …) are exposed on
every model as a single collapsed `nets` / `mps` / … field:
```python
req = QemuCreateVmRequest(
nets={
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
[upstream-docs]: https://pbs.proxmox.com/