Backup & Restore

Backup & Restore backs up a whole Uniform project every night and keeps the backups under a retention rule. When a project's content is wrong or gone, you restore one of those backups. It can go into a new project, a target project, or the project it came from.

Use Backup & Restore to:

  • Bring a project back after a bad import, a bad publish, or an accidental deletion.
  • Copy a project's content into a target project to try something out.
  • Rehearse a recovery, so your team knows the steps before an incident.

Every project the app knows has one of two roles:

  • Source project: backed up every night. You take backups and start restores from its page.
  • Target project: never backed up. It exists for a restore to write into.

Backup & Restore shows in two places in a project. Both need a team admin.

PlaceHow to open itWhat you do there
Project toolIn the project navigation, select Tools, then select Backup & Restore.Take a backup, read a backup's details, start a restore, and read the audit log.
Integration settingsOpen the project's integration settings, then select Backup & Restore.Read the project's Uniform key access, change the nightly backup, run a cleanup, manage restore targets and backup labels, and read the audit log.
The settings page. Cards read Uniform key access with Team access, Nightly backup with a Back up without assets each night switch, and Clean up old backups with a Clean up now button. A Source projects table lists the team's projects below them.
The Backup & Restore settings page, with the project's Uniform key access, the nightly backup switch and the cleanup card.

The tool's screens use your Uniform sign-in and permissions. The backups and restores themselves use the Uniform API key stored for the project, so what that key can read is what a backup saves.

To take a backup, see Back up a project. To bring one back, see Restore a project.

  1. Request activation for your team.
  2. As a team admin, open the project's Backup & Restore settings page.
  3. Add the project to backups, with a Uniform API key for the project.

If the tool or the settings page shows a notice instead of your backups, the notice says which of these it is. A failed load never affects stored backups.

NoticeWhat it meansWhat to do
This project isn't enabled for backupsYour team isn't set up for Backup & Restore.Request activation for your team.
This project isn't backed up yetYour team is set up, and nobody has added this project.A team admin adds it from the project's Backup & Restore settings page.
Signing in on your behalf isn't enabledIdentity delegation is off for the integration.Ask the Uniform team to turn it on for the integration.
Could not sign you inUniform didn't confirm your sign-in.Select Try again. If it keeps failing, reload the Uniform page.
Could not load this projectThe app couldn't load the project, or couldn't be reached.Select Try again in a moment.

A backup saves a project at one moment:

  • Content: compositions, composition patterns, component patterns, entries, and entry patterns, each as drafts and as published.
  • Content model: components, content types, data types, categories, labels, and locales.
  • Optimization: intents and audiences, signals, enrichments, quirks, and tests.
  • Configuration: project map definitions and nodes, redirects, preview URLs, preview viewports, custom views, prompts, workflows, and policy documents.
  • Releases and the items in them.
  • Webhooks, with their signing secrets where the project's key can read them.
  • Data sources, without their secrets.
  • Assets.

Only content has a draft state. Everything else is saved as published. The Contents section of a backup's details counts each type.

  • Release editions. Release editions aren't supported yet.
  • The secrets of a data source, such as its API keys.
  • Sensitive webhook headers, such as Authorization.
  • Release items that point to an edition, or that have a type the app can't read yet.

A backup with the Uniform CLI leaves out team integrations, project integration installations, data sources, and draft state, which Backup & Restore saves.

Backups of the same project don't all save the same things. Each backup says on its own row and in its details what it left out.

  • Uniform key access. A project's key has either Team access or Content access. With content access, a backup leaves out integration installations and their settings, data sources, team-level custom integrations, policy documents, and webhooks. The backup is marked Content only. A project's key access can't be changed yet.
  • A night without assets. With Back up without assets each night on, a nightly backup reuses the asset library from the last backup that included assets. The backup is marked Backed up without assets.
  • Webhooks that couldn't be read. A backup has no webhooks when the project has none, when the project's key can't read them, or when reading them failed. The backup's details say which.
The Activity tab listing restores and backups. One Scheduled backup row carries an amber Content only chip under its name, while the other rows carry none.
A backup taken with content access, marked with a Content only chip on the Activity tab.

A restore can't put back anything its backup didn't save.

  • A project runs one backup, restore, or cleanup at a time. While one runs, the controls that would start another are switched off.
  • Backup & Restore is built for projects of up to about 12 GB, counting the assets. Compare with a backup's Total size. A backup of a larger project can fail with "The assets don't fit on the disk." Back it up without assets, or ask Uniform support for more disk space.
  • The Backups and Activity tabs show at most the newest 100 backups and the newest 100 restores.
  • Run logs are kept for 90 days after a run.