2026.6.3
Home ▸ Actions

Check Home Assistant configuration

Use this action to check your Home Assistant YAML configuration files for errors without applying them. It reads the files and validates them, but does not load them into Home Assistant. A common use is to confirm your configuration is valid before you restart.

If errors are found, Home Assistant creates a persistent notification and writes the details to the logs.

Only users with administrator rights can run this action.

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 check the 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. Search for and select Check Home Assistant configuration.
  6. Select Save.

Options in the UI

This action has no options.

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 homeassistant.check_config. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
action: homeassistant.check_config

Options in YAML

This action has no options.

Good to know

  • This action only checks the configuration. It does not load or apply any changes.
  • If errors are found, look in the [logs](Logs) for the details.

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: