Restart app

Use this action to restart a running appApps are additional standalone third-party software packages that can be installed on Home Assistant OS. [Learn more]. A common use is to restart an app on a schedule, or to recover an app that has stopped responding, without restarting all of Home Assistant.

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 restart an app 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 Restart app.
6. Select the App to restart.
7. Select Save.

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

action: hassio.app_restart
data:
  app: core_ssh

Use the slug of the app, which you can find on the app’s page under Settings > Add-ons.

Options in YAML

Good to know

• Only administrators can run this action.
• This action is only available when you run Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. or the Supervised installation method. It is not available on Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI compatible runtime can be used, but the documentation focus is on Docker. [Learn more] or Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated..

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: restart an app every night

Restart an app once a day to keep it running smoothly.

• Trigger: Time, at 04:00
• Action: Restart app

alias: "Nightly app restart"
triggers:
  - trigger: time
    at: "04:00:00"
actions:
  - action: hassio.app_restart
    data:
      app: core_mosquitto

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:

• Start app: Starts a Home Assistant app.

• Stop app: Stops a Home Assistant app.

• Write data to app stdin: Writes data to the standard input of a Home Assistant app.