--- title: "Proxmox" description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers." hide_title: true --- import { IntegrationHeader } from "@site/src/components/integrations/header"; import { IntegrationCapabilites } from "@site/src/components/integrations/widgets"; import { AddingIntegration } from "@site/src/components/integrations/adding"; import { IntegrationSecrets } from "@site/src/components/integrations/secrets"; import { IconHeartRateMonitor } from "@tabler/icons-react"; import { proxmoxIntegration } from "."; import Alert from "@theme/Admonition"; import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring"; import { systemResourcesWidget } from "@site/docs/widgets/system-resources"; ### Widgets & Capabilities ### Adding the integration ### Secrets 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. ), credentials: ["username", "tokenId", "realm", "apiKey"], steps: [ "Navigate to the Proxmox portal, click on Datacenter", "Expand Permissions, click on Groups", "Click the Create button", "Name the group something informative, like api-users", "Click on the Permissions 'folder'", <> Click Add {"->"} Group Permission
  • Path: /
  • Group: group from Step 4 above
  • Role: PVEAuditor
  • Propagate: Checked
, "Expand Permissions, click on Users", <> Click the Add button
  • User name: something informative like api
  • Realm: Proxmox VE authentication server
  • Password: create a secure password for the user
  • Confirm Password: re-enter the password
  • Group: group from Step 4 above
, "Expand Permissions, click on API Tokens", <> Click the Add button
  • User: user from Step 8 above
  • Token ID: something informative like the application or purpose like homarr
  • Privilege Separation: unchecked
, "Copy the Secret that is shown in Step 10 because it is only shown once", "Go back to the 'Permissions' menu", <> Click Add {"->"} API Token Permission
  • Path: /
  • API Token: select the API token created in Step 10
  • Role: PVE Auditor
  • Propagate: Checked
, ], body: ( <> 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
), }, ]} />