Dump HAP config

The Dump HAP config action writes the configuration of your Homematic IP access points to a file. This can be helpful when you need the raw configuration for troubleshooting or development.

This action is only available to Home Assistant administrators.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To dump the access point configuration from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select HomematicIP Cloud: Dump HAP config.
6. Optionally, set the Config output path, Config output file prefix, and whether to Anonymize the configuration.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as homematicip_cloud.dump_hap_config. A basic example looks like this:

action: homematicip_cloud.dump_hap_config
data:
  config_output_path: "/config"
  anonymize: true

This dumps an anonymized configuration to your Home Assistant configuration directory.

Options in YAML

Good to know

• If you want to share the configuration for troubleshooting, prefer the Download diagnostics option on the integration page, which anonymizes sensitive information for you.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Set active climate profile: Sets the active climate profile index.

• Set home cooling mode: Sets the heating or cooling mode for the entire home.