Admin API docs

[Craig St George]

Hi i m looking at creating datastores or users through the API but I cant find the API docs anywhere for some reason
I can find docs for the backup protocol but not the admin side

if there is no docs i guess I can use the proxmox-backup-manager and look at what it does

Thanks

 

[t.lamprecht]

Hi!

An API viewer tool like we have for PVE or PMG is not yet available for Proxmox Backup Server, but is in planning - I'm missing it sometimes too, to be honest

The main reason is for the completely new rust based backend we developed for PBS, that was quite some work so some details like this was postponed. But the API is programmed quite schematically, so you may get most information from the code without too much rust experience. For example, here is the main api index:
https://git.proxmox.com/?p=proxmox-...3df63e1e1e983f81f4986ee3557c63ca084db;hb=HEAD

Here the api interface for datastore config:
https://git.proxmox.com/?p=proxmox-...dc17657e1d49ed212e1b4beb745d53c2b78a5;hb=HEAD

The API router definitions are normally at the bottom of those files, and all is split nicely into files according to path. Not as convenient as the API viewer tool, but may be enough until that one is available.

 

[Craig St George]

Thanks very much I checked that out and can understand enough to get what I want too do done

 

[t.lamprecht]

Hi, an api-viewer is now available, see: https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/gc

It should come also to local installations once the packages get available everywhere.

 

[Craig St George]

great thanks