Inquiry about the Proxmox Backup API

[admin_ready]

I have created a user API and tried giving it admin privileges, following the API documentation.However, I am unable to retrieve VM data that is in a backup group. An error message appears stating 'no data' (as shown in the picture).Has anyone encountered this before, and what is the method to fix it?

 

[fabian]

try using that user using proxmox-backup-client - if that works, your API requests are wrong. if it doesn't, then your ACLs are wrong. in any case, you'd need to provide more detail if you want help figuring it out..

 

[admin_ready]

I think the API's value/setting isn't wrong, but I'm not sure about the /path being used. Would you like us to send any additional information?

 

[fabian]

providing actual API requests (e.g., this full API path with this method and these parameters) would be a start (not as screenshots, but as actual formatted text).

 

[admin_ready]

I have sent the JSON data. If you need anything additional, please feel free to let me know.

 

[fabian]

your requests don't seem to include the right authentication headers.. you are also mixing token and user authentication, which makes no sense.

you might want to start off with a request that the UI makes and base yours on that..

 

[admin_ready]

cannot send the actual URL, username/password because it is internal organizational data. I apologize for this.May I ask, have you encountered this problem before?

 

[admin_ready]

In addition to this, I also tried writing code to check whether the token is usable or not.

 

[fabian]

encountered what? you still haven't provided any data that could help me help you

 

[admin_ready]

not sure what information you need. I would like to know if using the /path specified in the API docs returns any data.

 

[fabian]

the api docs contain that information - if the schema says an api endpoint returns data, then it returns data.

e.g., https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/groups says it returns an array

 

[admin_ready]

This is the API endpoint according to the docs; no response data was received. However, please be advised that I have off the URL and store informati.
But a status of 200 indicates that the API endpoint is correct.

 

[fabian]

that could also mean that you user/token doesn't see any groups. like I said, start with the UI, and then try to reproduce the requests (you can dump them using the browser console) using your API client.. if they don't work (using the same authorization), then something is wrong with how you are using the API. if they work, then you can start comparing with how you previously tried to find your mistake(s).

 

[admin_ready]

In the UI, have namespace and VM data is as shown in the picture. However, I want to do some automation, so I was thinking of using an API to help, but I can't find the necessary information

 

[Chris]

In the UI, have namespace and VM data is as shown in the picture. However, I want to do some automation, so I was thinking of using an API to help, but I can't find the necessary information

You have no groups in the root namespace, so that is why you get the empty array as response. You will have to provide the optional ns parameter to list groups contained within a namespace.

 

[admin_ready]

Which page in the docs do I have to follow? Should I use this page or not:
https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/namespace

 

[Chris]

Which page in the docs do I have to follow? Should I use this page or not:
https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/namespace

Depends on what your actual goal is. In order to get a list of namespaces, you can use that endpoint with a get request. To fetch the list of groups contained within that namespace, you will have to use the already mentioned

https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/groups

and pass the namespace via the additional ns parameter. Same if you want the snapshots contained within that group, but that requires get requests to the snapshots endpoint https://pbs.proxmox.com/docs/api-viewer/index.html#/admin/datastore/{store}/snapshots and optionally the backup type and id.

 

[admin_ready]

Okay, I've got it now. I needed to include 'ns' as well. At first, I saw it was 'Optional', so I didn't add it. Thanks a lot!