API Special Cases: List of endpoints for root and PAM users only

Maddes

New Member
Mar 26, 2020
3
1
3
The API viewer [1] cannot be searched for the necessary permissions of the API endpoints.
Wanted to know which API endpoints need a special user, so that only in these special cases those users are used (especially avoiding root).
So I checked all endpoints of the /nodes API path and their methods.
Just wanted to post the results for others as a reference. If you checked other API paths, then it would be nice to post them here.

[1] https://pve.proxmox.com/pve-docs/api-viewer/

Root only end points:
Code:
/nodes/{node}/ceph/osd/{osdid}
/nodes/{node}/certificates/acme/certificate
/nodes/{node}/certificates/custom
/nodes/{node}/storage/{storage}/content/{volume} POST
/nodes/{node}/vzdump  some parameters

PAM only end points:
Code:
/nodes/{node}/spiceshell
/nodes/{node}/termproxy
/nodes/{node}/vncshell
/nodes/{node}/vncwebsocket
 
Just wanted to post the results for others as a reference. If you checked other API paths, then it would be nice to post them here.
For people in the future, be aware that this can change, so check your actual usecase to the current versions.

So I checked all endpoints of the /nodes API path and their methods.

Further note that this provided list is incomplete, these are just the /node based ones, but not /cluster, /access, /storage.
And even there it may not be complete, we sometimes have cases where the privileges required cannot only depend on the API path but also on the parameters used, i.e., there we can only do run time checks (albeit we try to document that behavior in the API Endpoints privilege description).
 

About

The Proxmox community has been around for many years and offers help and support for Proxmox VE, Proxmox Backup Server, and Proxmox Mail Gateway.
We think our community is one of the best thanks to people like you!

Get your subscription!

The Proxmox team works very hard to make sure you are running the best software and getting stable updates and security enhancements, as well as quick enterprise support. Tens of thousands of happy customers have a Proxmox subscription. Get yours easily in our online shop.

Buy now!