Services and Automations

Services and Automations

All BackupCheckup actions are available under Developer Tools → Actions. Resource-intensive or state-changing actions require a Home Assistant administrator.

backup_checkup.refresh

Immediately reloads the lightweight backup inventory and evaluation. It does not download a backup.

action: backup_checkup.refresh

backup_checkup.simulate_restore

Runs Check backup protection for the newest regular backup. It downloads, decrypts, and completely reads the backup without restoring data. A connected runner adds isolated runtime verification.

action: backup_checkup.simulate_restore

Do not schedule this action at short intervals. Use the Automatic or Deep verification policy for new-backup checks.

backup_checkup.verify_latest_backup

Compatibility alias for older automations. It uses the same protected pipeline as simulate_restore.

action: backup_checkup.verify_latest_backup

backup_checkup.test_notification

Sends one localized test message to all configured Companion App targets.

action: backup_checkup.test_notification

Notifications must be enabled and at least one valid target selected.

backup_checkup.clear_activity_log

Clears both the memory buffer and, when enabled, the persisted live log.

action: backup_checkup.clear_activity_log

backup_checkup.set_recovery_preparedness

Updates exactly one fixed emergency-checklist or external-dependency item. Free text and secrets are not accepted.

Checklist example:

action: backup_checkup.set_recovery_preparedness
data:
  section: checklist
  item: backup_password_available
  status: confirmed

Checklist items:

• backup_password_available
• storage_access_documented
• restore_method_known
• replacement_hardware_available
• network_access_documented
• recovery_contacts_documented

Valid checklist states: unknown, confirmed, missing, not_required.

External dependency example:

action: backup_checkup.set_recovery_preparedness
data:
  section: dependencies
  item: external_database
  status: protected

Dependency items:

• external_database
• mqtt
• zigbee
• zwave
• thread
• esphome
• network_storage
• reverse_proxy
• certificates
• cloud_services

Valid dependency states: unknown, protected, unprotected, not_applicable.

backup_checkup.record_restore_test

Records a restore test performed outside the production system.

action: backup_checkup.record_restore_test
data:
  result: successful
  scope: full

result is successful or failed; scope is full or partial. BackupCheckup adds the current backup reference and timestamp.

Automation: report a persistent critical score

alias: BackupCheckup critical
triggers:
  - trigger: numeric_state
    entity_id: sensor.backup_checkup_health_score
    below: 50
    for: "01:00:00"
actions:
  - action: notify.mobile_app_my_phone
    data:
      title: BackupCheckup critical
      message: >-
        Status: {{ states('sensor.backup_checkup_status') }};
        recommendation: {{ states('sensor.backup_checkup_recommendation') }}
mode: single

Automation: refresh after storage recovery

alias: Refresh BackupCheckup after storage recovery
triggers:
  - trigger: state
    entity_id: binary_sensor.backup_checkup_storage_error
    from: "on"
    to: "off"
actions:
  - action: backup_checkup.refresh
mode: restart

Automation guidance

• Use stable raw enum states such as valid, corrupt, or ready; the UI translates them only for display.
• Check whether the manual-verification button is available. It is disabled during another run and during cooldown.
• BackupCheckup does not create backups. Continue using Home Assistant's native backup actions.
• Do not publish private attributes when Expose private backup metadata is enabled.