[SOLVED] API Documentation

[Cookiefamily]

Hello,
looking through the forum and the included documentation I wasn't able to find any references to the API documentation.
For PVE this page exists: https://pve.proxmox.com/pve-docs/api-viewer is there something similar for PBS?

 

[fabian]

not yet (we haven't gotten around yet to write the dump). the basic API works almost identical to PVE (the ticket cookie prefix and API token header name are different, but the basic mechanisms and many API endpoints are the same).

for the time being, some combination of looking at the requests that the GUI makes (via the developer tools of your browser) and browsing the source code should get you up to speed. if you have specific questions, just ask them here in the forum. I guess you are mostly interested in querying status information/monitoring, if you want to look at the actual backup/restore API that works a bit differently (you need to do an HTTP2 upgrade on backup/reader, then you can do the documented 'commands' via that connection)

 

[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.

 

[Cookiefamily]

That's awesome! Thank you very much