[SOLVED] API calls to Proxmox BS

[BabboDemonio]

Hi!
I wrote a small bash script in order to shutdown a Proxmox VE remotely by using an API call. The invocation is this one:

curl -X POST -H "Authorization: PVEAPIToken=root@pam!TOKEN=TOKEN_VALUE" -H "Content-Type: application/x-www-form-urlencoded" -d "command=shutdown" https://proxmoxve.DOMAIN.COM/api2/json/nodes/pve/status

This works and I am happy with it.

Now I am trying to do the same thing for a Proxmox Backup server. I created a token and the first thing that I noticed is that there is a mismatch between the docs and what I find in the UI. According to the docs there should be a path like nodes/{node}/status, while on the UI I only see this

Assuming that the right permission path is /system/status, I created a token and I am trying to use it like I did for Proxmox VE, for example:

curl -X POST -H "Authorization: PVEAPIToken=root@pam!TOKEN=TOKEN_VALUE" -H "Content-Type: application/x-www-form-urlencoded" -d "command=shutdown" https://proxmoxbs.DOMAIN.COM/api2/json/nodes/pbs/status

but I keep getting authentication failed - no authentication credentials provided.. I am pretty sure the path is correct because if I manually open the respective path while logged in a browser I can see the correct response.

So am I missing something? Is the invocation to Proxmox Backup server different than the one for Proxmox VE?
Thanks

 

[Moayad]

Hi,

I guess the Authorization should PBSAPIToken not PVEAPIToken, since it's a PBS not a PVE i.e:

curl -X POST -H "Authorization: PBSAPIToken=root@pam!TOKEN=TOKEN_VALUE" -H "Content-Type: application/x-www-form-urlencoded" -d "command=shutdown" https://proxmoxbs.DOMAIN.COM/api2/json/nodes/pbs/status

 

[fabian]

what @Moayad said w.r.t. the token prefix is correct

to shed some light on the other confusion - when talking about the API you have to be careful not to mix up the two different kind of paths:
- API endpoint path (like /nodes/{node}/status), this tells the API server which code handles your request
- ACL path (like /datastore/foobar (where foobar is a datastore identifier), or /system/status), this encodes what your API token is allowed to access

e.g., in the api viewer when browsing to /nodes/{node}/status, you will see the following under "Required permissions":

Check: {"partial":false,"path":["system","status"],"privs":["Sys.Audit"]}

this means you need the "Sys.Audit" privilege on the (ACL!) path "/system/status" to access the API endpoint "/nodes/{node}/status"

 

[BabboDemonio]

Hi!,
thanks to both of you for you explanation! I tried to change the command like @Moayad suggested but I got this:

authentication failed - invalid token name

After reasearching a bit I found another post that seems to suggest that for PBS the separator needs to be : not =. I tried this and all worked fine:

curl -X POST -H "Authorization: PBSAPIToken=root@pam!TOKEN:TOKEN_VALUE" -H "Content-Type: application/x-www-form-urlencoded" -d "command=shutdown" https://proxmoxbs.DOMAIN.COM/api2/json/nodes/pbs/status

I think it would be useful to post these instructions somewhere because I couldn't find them easily and I had to ask here in the forum . Something like what was done for Proxmox VE

 

[fabian]

The API token is passed from the client to the server by setting the Authorization HTTP header with method PBSAPIToken to the value TOKENID:TOKENSECRET.

https://pbs.proxmox.com/docs/user-management.html#api-tokens

 

[BabboDemonio]

Thanks @fabian I missed that!