-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add docs for Backblaze B2 integration #39169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
c0ffeeca7
merged 19 commits into
home-assistant:next
from
hugo-vrijswijk:backblaze-docs
Oct 30, 2025
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
873ca99
Add docs for Backblaze B2 integration
hugo-vrijswijk a4ffc9b
Update source/_integrations/backblaze_b2.markdown
hugo-vrijswijk 7021ec1
Remove duplicate heading added by AI suggestion
hugo-vrijswijk 252a280
Minor language changes
hugo-vrijswijk fcd94c9
Merge branch 'next' into backblaze-docs
hugo-vrijswijk 2f73c96
Rename backblaze_b2 to backblaze
hugo-vrijswijk 4185e44
Update ha_release to 2025.7
hugo-vrijswijk 5da25f8
Apply suggestion from @c0ffeeca7
hugo-vrijswijk b6bfbe4
Apply suggestion from @c0ffeeca7
hugo-vrijswijk 5b877fe
Apply suggestion from @c0ffeeca7
hugo-vrijswijk d028fba
Apply suggestion from @c0ffeeca7
hugo-vrijswijk 08ada36
Apply suggestion from @c0ffeeca7
hugo-vrijswijk 23f9163
Apply suggestion from @c0ffeeca7
hugo-vrijswijk 2dbbfbc
Apply suggestion from @c0ffeeca7
hugo-vrijswijk 3c89742
Rename to backblaze_b2
hugo-vrijswijk 1177be0
Merge remote-tracking branch 'upstream/next' into backblaze-docs
hugo-vrijswijk 6351ad5
Remove single item bullet list
hugo-vrijswijk 4b90373
Merge branch 'next' into backblaze-docs
hugo-vrijswijk 1349865
fix indent in an attempt to fix build
c0ffeeca7 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ | |
| "autodiscovery", | ||
| "autoheal", | ||
| "automations", | ||
| "Backblaze", | ||
| "balloob", | ||
| "bloomsky", | ||
| "Bluesound", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| title: Backblaze B2 | ||
| description: Instructions on how to setup a Backblaze B2 bucket to be used as a backup location. | ||
| ha_release: 2025.10 | ||
| ha_category: | ||
| - Backup | ||
| ha_iot_class: Cloud Push | ||
| ha_config_flow: true | ||
| ha_domain: backblaze_b2 | ||
| ha_codeowners: | ||
| - 'ElCruncharino' | ||
| - '@hugo-vrijswijk' | ||
| ha_integration_type: service | ||
| ha_quality_scale: bronze | ||
| --- | ||
|
|
||
| The **Backblaze** {% term integration %} enables you to use a [Backblaze B2](https://www.backblaze.com/cloud-storage) bucket as a backup location in Home Assistant. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| This integration requires an existing B2 bucket and an application key that has access to that bucket. It is recommended to create a key that only has access to the required bucket and prefix (if desired). | ||
|
|
||
| {% details "Create a new B2 bucket" %} | ||
|
|
||
| 1. Log in to the [Backblaze Console](https://secure.backblaze.com/b2_buckets.htm). | ||
| 2. [Create a bucket](https://www.backblaze.com/docs/cloud-storage-create-and-manage-buckets). | ||
| - Choose a unique **bucket name** (such as, `home-assistant-backups-123456`). | ||
| - Make a note of the bucket name — you’ll need it later. | ||
| 3. Adjust the settings: | ||
| - **Set bucket to private**: Enabled by default, recommended. | ||
| - **Encryption**: This enables Backblaze's server-side encryption. This is separate from the Home Assistant backup encryption. This is optional. If Home Assistant backups are configured to use encryption, you can disable this. | ||
|
|
||
| {% enddetails %} | ||
|
|
||
| {% details "Create an application key" %} | ||
|
|
||
| To create an application key that can access the bucket: | ||
|
|
||
| 1. Go to [**Application Keys**](https://secure.backblaze.com/app_keys.htm) in the sidebar. | ||
| 2. [Create a new application key](https://www.backblaze.com/docs/cloud-storage-create-and-manage-app-keys). | ||
| - Use a name like `home-assistant-backup`. | ||
| - Limit access to the bucket by selecting it from the **Choose a bucket** dropdown. | ||
| - The type of access should be **Read and Write**. | ||
| - **Allow List All Bucket Names** can be left unchecked. | ||
| - Optionally, you can limit the key to a specific prefix (such as `home-assistant-backups`) if you want to save backups in a specific folder within the bucket. | ||
| 3. Save the **Key ID** and **Application Key**. You'll need these when setting up the Backblaze integration in Home Assistant. | ||
|
|
||
| {% enddetails %} | ||
|
|
||
| {% note %} | ||
|
|
||
| By limiting credentials to a specific bucket, you reduce risk and help keep your Backblaze account secure. | ||
|
|
||
| {% endnote %} | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| {% configuration_basic %} | ||
| Key ID: | ||
| description: "The access key ID for your Backblaze account." | ||
| Application Key: | ||
| description: "The application key for your Backblaze account." | ||
| Bucket Name: | ||
| description: "Bucket name to store the backups. Bucket must already exist and be writable by the provided credentials." | ||
| Prefix: | ||
| description: "Optional prefix for the backups. This is useful if you want to store backups in a specific folder within the bucket." | ||
| {% endconfiguration_basic %} | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Expired keys | ||
|
|
||
| If the application key expires, you will need to create a new one and update the integration in Home Assistant. | ||
|
|
||
| ### Files are being overwritten due to non-unique bucket prefix | ||
|
|
||
| If you set a prefix, all backups will be stored under that prefix in the bucket. Ensure that the prefix is unique to avoid overwriting other files. Changing the prefix will not move existing backups. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. No extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.