The nextcloud integration pulls summary Nextcloud information into Home Assistant.

The integration provides sensors and binary sensors for most of the data points that the built-in Nextcloud serverinfo app provides.

To see which datapoints your nextcloud instance exposes, browse to this url: https://<your_nextcloud_url>/ocs/v2.php/apps/serverinfo/api/v1/info?format=json.

Nextcloud Example Sensor


This integration has the following Nextcloud Server prerequisites:

  • The user must be in the Nextcloud admin group (Nextcloud > Users)
  • The Nextcloud ‘Monitoring’ app must be installed (Nextcloud > Apps > 🔍(Search Icon) > Monitoring > Enable)
  • (Recommended) A Nextcloud App password should be generated for use in Home Assistant (Nextcloud > Settings > Personal > Security > Devices & sessions > Create new app password)

To enable the Nextcloud integration, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
  url: https://YOUR_NEXTCLOUD_URL
  username: YOUR_USERNAME

Configuration Variables

url string Required

The full URL to your Nextcloud instance.

username string Required

The username of a Nextcloud user that has access to the Nextcloud monitor API.

password string Required

The app password generated from the Nextcloud security settings page.