---
title: "Homarr documentation"
source: "https://homarr.dev/docs/integrations/proxmox/"
author:
published:
created: 2026-04-19
description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers."
tags:
  - "clippings"
---
Version: 1.59.2 ![[d25b4691322e55b0017d67cee8d74ecf_MD5.svg]]

## Proxmox

System monitoring

Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers.

### Widgets & Capabilities

System Health MonitoringDisplays information showing the health and status of your system(s).

[Details](https://homarr.dev/docs/widgets/health-monitoring)

### Adding the integration

You can find how to add the integration on the [Integrations Management](https://homarr.dev/docs/management/integrations) documentation page.

### Secrets

- Username & Token ID & Realm & API Key

> [!-warning] -warning
> caution
> 
> The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the Proxmox VE authentication server realm when creating your API user.

| Name | Description |
| --- | --- |
| Username | Account username for authentication. |
| Token ID | Token ID used for authentication |
| Realm | The realm used for authentication, most of the time this is pve |
| API Key | API Key from the service for authentication. |

Sometimes you'll also find the `api@pve!homarr` format, within Homarr you'll have to split it up into:
- **Username:** api
- **Realm:** pve
- **Token ID:** homarr

### Steps to retrieve the credentials:

1. Navigate to the Proxmox portal, click on Datacenter
2. Expand Permissions, click on Groups
3. Click the Create button
4. Name the group something informative, like api-users
5. Click on the Permissions 'folder'
6. Click Add -> Group Permission
	- Path: /
		- Group: group from Step 4 above
		- Role: PVEAuditor
		- Propagate: Checked
7. Expand Permissions, click on Users
8. Click the Add button
9. Expand Permissions, click on API Tokens
10. Click the Add button
	- User: user from Step 8 above
		- Token ID: something informative like the application or purpose like homarr
		- Privilege Separation: unchecked
11. Copy the Secret that is shown in Step 10 because it is only shown once
12. Go back to the 'Permissions' menu
13. Click Add -> API Token Permission
	- Path: /
		- API Token: select the API token created in Step 10
		- Role: PVE Auditor
		- Propagate: Checked