Proxmox widget API error

[viral-bug]

Description

I have Homepage installed within a docker container which is hosted on a Proxmox VM. I have a separate Proxmox VM where a Caddy reverse proxy is set up, through which I access my services. All my other widgets work fine, but for some reason I can't get Proxmox widget to work. Browser shows error "API Error: JSON.parse: unexpected character at line 1 column 1 of the JSON data"

homepage version

v0.8.10

Installation method

Docker

Configuration

- Proxmox:
        href: https://<ip>:8006
        icon: proxmox.png
        widget:
            type: proxmox
            url: https://<ip>:8006
            username: <username>
            password: <secret>

Container Logs

Browser Logs

No response

Troubleshooting

I have run below curl command from within Homepage docker container and receive a correct response
curl -H 'Authorization: PVEAPIToken=<username>=<secret>' https://<ip>:8006/api2/json/cluster/resources

The same curl command works fine from my Docker host VM and Caddy host VM as well.

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

Based on the information provided, it seems that the Proxmox widget is not able to parse the JSON data correctly, which is resulting in the "API Error: JSON.parse: unexpected character at line 1 column 1 of the JSON data" error message. This could be due to a few reasons:

1. Incorrect API Endpoint: Ensure that the URL specified in the widget configuration is correct and that it points to the correct API endpoint for Proxmox. According to the documentation, the URL should not end with a slash or other API path as each widget will handle the path on its own.

2. Incorrect Authentication: Verify that the username and password fields in your configuration are correctly set up. The username should be in the format user@pam!tokenid and the password should be the secret associated with the API token.

3. Proxy Issues: Since you are using a reverse proxy, ensure that the reverse proxy is correctly passing the requests to the Proxmox API and that it is not modifying the response in any way that could cause the JSON parsing to fail.

4. Content-Type Header: Check if the response from the Proxmox API has the correct Content-Type header set to application/json. If the Content-Type is not set correctly, it could cause the JSON parsing to fail.

5. CORS Issues: If the Homepage installation is on a different domain than the Proxmox API, ensure that CORS (Cross-Origin Resource Sharing) is properly configured to allow requests from the Homepage domain.

To further troubleshoot the issue, you can:

• Check the network tab in your browser's developer tools to see the actual response returned from the Proxmox API when the widget tries to load.
• Verify that the response is indeed a valid JSON and that there are no leading characters before the JSON object starts.
• Check the Homepage logs for any additional error messages that might provide more insight into the issue.

If you continue to experience issues, you may want to consult the Homepage documentation, the troubleshooting guide, or seek assistance from the Homepage community on GitHub or Discord.

This comment was generated by Glime.

[viral-bug]

I have confirmed address and authentication credentials are correct.
I eliminated any proxy issues as I'm using the IP address directly for now.
Response received is "Internal Server Error"

[AjSpyda]

I was only able to get mine working with node: {node} on the end after the password:

[viral-bug]

I've tried that. Nothing changed.

[AjSpyda]

Did you get confused with the username? I didn't understand what was required for api_token_id and had setup with api@pam to start with.

I did get working with this widget settings following the proxmox widget settings on gethomepage.dev:

widget: type: proxmox url: https://IP:8006 username: api@pam!homepage password: {pass}

[oester]

Wondering if you solved this issue, because I have the same problem.

[viral-bug]

Did you get confused with the username? I didn't understand what was required for api_token_id and had setup with api@pam to start with.

I did get working with this widget settings following the proxmox widget settings on gethomepage.dev:

widget: type: proxmox url: https://IP:8006 username: api@pam!homepage password: {pass}

Yeah I followed that correctly.

Wondering if you solved this issue, because I have the same problem.

Sadly no. I’ve had this issue for a while now. I didn’t bother with it much since I don’t have a real need of the widget. But it would be great to have it working.

[oester]

I found another reference to this issue, and they suggested Changing the "Privilege Separation" setting under Datacenter ->Permission->API Token (the one used for the widget) to "no" .

That solved the issue for me.

[viral-bug]

Yeah I found that suggestion as well but didn't work for me.

[SuperBenji99]

I too had this issue and kept trying different things.
In my case, it was a trailing / url: https://proxmox.local:8006/
Removing the / fixed my issue

[hrdejong]

None of the above work, was working fine before upgrading Proxmox to 8.2.4 so my guess it's related to an API change on Proxmox side. No solution yet.

[tarocjsu]

Not working with Proxmox VE cluster right ?

[tarocjsu]

[timrwhite87]

I too am still struggling with this and cannot for the life of me figure it out.

One thing i noted was the test with CURL gave me an SSL warning (using the default self-signed cert on proxmox). On a whim figured i'd try importing the two certs (private and ca) for proxmox to the server which is running homepage. No longer get a warning in CURL at least, but still get the API error in homepage!

[derpuma]

Same Problem here (8.2.2):

[balgerion]

is there any solution for that or we wait ? i had same error as you but after changing url (removing / at the end) have now similar problem as gent above :)

[oester]

You know, I actually did get this to work, but now I'm having some difficulty remembering what I did on the Proxmox side. On the homepage side, I have this:

siteMonitor: https://192.168.15.2:8006
        widget:
          type: proxmox
          url: https://192.168.10.6:8006
          username: api@pam!homepage
          password: <generated API token>

As I recall, the instructions on the Homepage site aren't entirely accurate. Let me see if I can recall what I did and if I do I'll update it here.

[balgerion]

5 mins after posting this message figured out what's wrong - misspelled node name in my case

[molekylspektroskopi]

Also same issue, proxmox 8.2.8
Gave api user full admin just to check it out. I have Proxmox VE cluster with 3 nodes.

fujitsu and groupie is online, proxmox is offline as planned

running:
fujitsu: 11 lxc, 17 vm
groupie: 2 vm

When node name is correctly spelled i get 0/0 and NaN%, when it is missepelled i get 0/0 and blank in memory and cpu

Edit:

Solved the issue:

Created a new user
Api Token without Privilege Separation
Permission for User: PVE Auditor

It fails when setting permission for Group or API Token but works when setting for user directly

[Marcbacca]

Not sure if this helps, but I have 2 server entries in a row, both with the same name. I do the homepage widget with one, and glances widget charts with the other. The first (top entry) always works, and the 2nd always fails. The order doesn't matter. It seems like you cannot have more than 1 Server: name the same ... cannot be duplicated. Just throwing it out there. I tried making more than one widget per entry, but that doesn't seem to be supported, not sure though, I ain't the best yaml/homepage person around.

[viral-bug]

OMG I didn't think this would work, but after trying a lot of things, this simple trick worked!
When I started configuring my dashboard, I had just created a simple service for Proxmox. I added the Proxmox widget for the same server later, but it never worked for me . I never thought of removing the older service as I didn't think that would have any effect. Thank you so much for sharing your experience as this fixed my problem.

[Marcbacca]

Oh nice, a shot in the dark worked lol

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered. See our contributing guidelines for more details.

[placebeyondtheclouds]

I faced the same error message API Error: JSON.parse: unexpected end of data at line 1 column 1 of the JSON data and it turns out that I forgot to enclose the variables in double quotes in services.yaml file. The working config is like this:

- HOMELAB:
    - Proxmox:
        icon: proxmox.png
        href: https://ip:8006
        description: Proxmox
        widget:
          type: proxmox
          url: https://ip:8006
          username: "{{HOMEPAGE_VAR_PROXMOX_API_TOKEN_ID}}"
          password: "{{HOMEPAGE_VAR_PROXMOX_API_TOKEN_SECRET}}"
          node: pve

The Proxmox API key is configured following the widget manual https://gethomepage.dev/widgets/services/proxmox/

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.