info.md

Cleanup Snapshots

Installation instructions

1. Install HACS for Home Assistant

2. Navigate to HACS Store

3. Under the Integrations tab, click the add button (the one with a plus sign)

4. Search for "Clean up snapshots service"

5. Click on the service, and then on Install this repository in HACS

6. Restart Home Assistant (Configuration > Server Controls > Restart)

7. Generate a Long Lived Token

   1. Navigate to your profile page.
   2. At the bottom of the page you will see a section called Long-Lived Access Tokens.
   3. Click Create token.
   4. In the pop up give your token a name.
   5. Copy the token from the following pop up This will not be saved anywhere so put it somewhere you can find it again

8. Copy resulting token input this in configuration.yaml:

   clean_up_snapshots_service:
     host: {{the url to access your homeassistant instance}}
     token: {{Long-Lived Access token}}
     number_of_snapshots_to_keep: 3

9. Restart Home Assistant (Configuration > Server Controls > Restart)

10. Look for the new clean_up_snapshots_service.clean_up service (Developer Tools > Services).

Consumption in automations

You can trigger this service in an automation similarly to the one below.

alias: Daily snapshot clean up
initial_state: 'on'
trigger:
  platform: time
  at: '03:00:00'
condition:
action:
  - service: clean_up_snapshots_service.clean_up
    # Data is optional if you have defined the number of snapshots to keep in the configuration.yaml.
    # data:
      # If this property is passed to the service it will be used regardless of what you have in the configuration.yaml
      # number_of_backups_to_keep: 7

---