Backup, restore, and clean environments

Backup and restore your environment

Backups are useful before major changes, like restructuring your content model or preparing for a migration. They’re also helpful when you want to use an environment as a reusable template in other environments.

What to know before you start

The data-ops’s backup command uses the Management API, which means it only includes data accessible through that API. The command creates a structured ZIP file export of selected entities.  Similarly, the restore process recreates entities from the backup file, functioning more like a re-import than a true rollback. Best suited for:

• Self-managed disaster recovery: Restore essential content, models, and assets into an empty environment to support manual recovery efforts and help rebuild the environment step by step.
• Templating: Recreate an environment for templating or development purposes for consistency.
• Archiving: Creating a structured export of content and models for long-term storage or compliance purposes.

Consider other alternatives for:

• Full environment rollback: The restore process re-imports entities rather than reverting the environment to a previous state.
• Regular backup cycles: These commands are designed for occasional use rather than ongoing, automated backups.
• One-click recovery: Restoring from a backup is a manual, complex process that typically requires hands-on involvement and planning.

At Kontent.ai, we understand that your data is critical to your business. That’s why we’ve implemented additional disaster recovery measures in place.

Backing up environments 

To run the backup command, you’ll need an Environment ID and a Management API key. You can also customize the backup by including optional parameters.  While the command is running, you’ll see a detailed output showing the progress of the export, including any errors that may have occurred.  Once the command executes successfully, it generates a ZIP file containing all the configuration files required to restore the environment. Each ZIP file also includes a metadata.json file, which is useful for tracking and troubleshooting. The metadata.json file captures key details such as:

• Environment ID
• Timestamp of the export
• Data-ops version

Backups typically cover all major data entities to restore the environment, but exclude the following:

• The environment itself (only its contents are exported)
• Roles and permissions
• Role limitations to specific workflow steps
• Asset types
• API keys
• Any entities you explicitly exclude using the exclude parameter

Restore to an empty environment

After backing up your environment, you can restore it to a clean environment using the restore command. This is perfect for starting new projects or reusing a template environment. You can also customize what gets restored using optional parameters. As the command runs, you’ll see a live summary that includes the import progress, entities being processed, and any errors that might come up along the way. It’s a great way to stay informed and quickly spot any issues. Once the restore is complete, you can discard the ZIP file or keep it for version control, historical tracking, auditing, or troubleshooting.

Get a fresh start with a clean environment