Backups

Backups ensure that your content is safely stored and can be restored. Safeguard your Storyblok data and components by configuring automatic backups to your AWS S3 bucket.

Depending on your pricing plan, you can configure daily or weekly backups.

Included data

Stories
Scheduled content
Releases
Translated stories
Translated slugs
Discussions
Branches
Components
Component groups
Assets (references only)
Asset folders
Roles
Collaborators
Workflows and workflow stages
Workflow stage changes
Datasources (including dimensions app data)
App provisions
Tasks

Backups in Storyblok do not include story versions, presets, space settings, or actual assets. Only asset references are stored. Use the Management API to back up story versions and space settings and the Storyblok CLI for presets. To back up assets, consider creating a script with the Management API or refer to the Storyblok Assets Backup tool for guidance. Restoring a backup will recover assets only if they still exist in Storyblok.

Setup

1
Prerequisites
Create an Amazon AWS account.
Choose a suitable plan from Storyblok's pricing options.
2
Install the app
Open the Storyblok Apps Directory.
Install the S3 Backups app.
3
Configure backups
In your space, go to Settings > Backup & Restore > Backup.
Enter your S3 bucket name and AWS Role ARN.
Enable automatic backups and schedule them as needed.
4
Create an AWS CloudFormation Stack
Log in to Amazon CloudFormation.
Create a stack and choose Amazon S3 URL under "Specify template."
Use this template URL: https://storyblok-tools.s3.eu-central-1.amazonaws.com/cloudformation/backup.yml.
Enter your stack name, bucket name, and Storyblok space ID.
Acknowledge IAM resource creation and create the stack.
Copy the Role ARN from the stack’s outputs.
5
Finalize the backup configuration
Paste the Role ARN and the S3 bucket name into the AWS ARN field in Storyblok.
Click Backup Now to test the setup.

Restore a backup

Go to the Restore tab.
Select a backup from Path to backup file and click Restore Now.
Choose to restore specific entries, create a new space, or overwrite the existing space.
To restore an older backup, manually browse your S3 bucket and paste the backup file path.

Restoring from a Specific Backup File

The restore dropdown only displays backups created within the current calendar month. If you need to restore an older backup, you must manually enter the full file path in the following format:

format

storyblok-backups/space-<space_id>/backup-<YYYYMMDD>-<id>.zip
//example
storyblok-backups/space-120582/backup-20240304-26-jeb2ka.zip

If you're using Storyblok’s Managed Backup Service, you can contact Support to request older versions. Otherwise, if you’ve set up your own S3 backup storage, you can retrieve the required file directly from there.

Managed Backups

If you have opted for the Managed Backup Service, please contact our support team by creating a ticket. Please provide your Space ID and preferred backup frequency, and we will configure the S3 Backups app for you. Once set up, you can seamlessly back up and restore your data without the need to configure your own AWS S3 bucket.

Other Backup Methods

While we recommend using the S3 Backups app for backing up your Storyblok space, you can also use the following tools and approaches to cover additional use cases or create custom backup strategies.

Use the Storyblok CLI

Install the Storyblok CLI and run the commands to export and sync any specific elements within your space:

Languages
Components
Presets
Stories and folders
Roles
Datasources
Fields

Use this method for granular control over backup and synchronization workflows.

Use the Management API

Create custom backup scripts with the Storyblok Management API. Use API endpoints to fetch and store any part of your space programmatically.

This option is ideal for advanced workflows or full-space automation strategies.

Use the Storyblok Assets Backup Script

Use the Assets Backup Script to export and back up all assets in your space efficiently.

This script is tailored for asset-specific backup workflows and can be integrated into your deployment pipeline or run periodically via cron jobs.

Use the Storyblok Schema Migration Tool

Use the Schema Migration Tool, built by Storyblok Ambassador Markus Oberlehner, to export and back up your component definitions.

This tool is especially useful for version-controlling schema changes and migrating components across spaces.