Use Resource Snapshots to Simplify Coveo Backups and Deployments

Learn how to simplify Coveo backups and deployments with resource snapshots.

What Are Resource Snapshots?

When new users enter the wide world of the Platform Admin Console of Coveo, it can initially seem daunting when thinking about moving an entire organization’s configuration from the sandbox non-production environment to production. Or, for that matter, how to back up an existing organization before making significant changes.

Enter, Resource Snapshots.

Resource Snapshots are a way of literally taking a snapshot of everything from the source to the AI models of a Coveo organization. If you’re an Admin in your organization, you can find them all the way at the bottom of the left-hand navigation.

Simplify Coveo Backups And Deployments With Resource Snapshots

Creating a Snapshot

Clicking Create snapshot in the top right and selecting Of your organization, you’ll be presented with a list of options on what to include in said snapshot. You can be as broad or as specific as you may need.

Simplify Coveo Backups And Deployments With Resource Snapshots

With each resource, you can select either all or specific ones. Regarding backups, I always recommend including all of a particular resource.

Simplify Coveo Backups And Deployments With Resource Snapshots

One thing to notice is the Include dependencies automatically checkbox at the top. This setting, while defaulted to true, will override any selection below as if a Query Pipeline, for example, uses a particular Machine learning model; even if you don’t select the Machine learning models, it will include those that it references.

Once created, it will take a few seconds to generate. You will see it listed like so.

Simplify Coveo Backups And Deployments With Resource Snapshots

Clicking on said snapshot and selecting Export will allow you to send that snapshot to another organization.

Simplify Coveo Backups And Deployments With Resource Snapshots

Applying a Snapshot

If you were to then switch organizations and then proceed to Resource Snapshots, you should then see the snapshot listed. At that time, you can select the snapshot and select Apply. You will be able to review the snapshot, validate its changes and if all is well, apply those changes to your organization. It should be noted there is no way to back out such snapshot so I often suggest taking a snapshot of the organization before applying the new snapshot.

Simplify Coveo Backups And Deployments With Resource Snapshots

The three steps you will be walked through are Check prerequisites, Validate snapshot and Apply your snapshot. The entire process will take less than 5 minutes.

Simplify Coveo Backups And Deployments With Resource Snapshots

Once all three steps are complete, you will receive a confirmation and a listing of all the changes that were made. If you’ve only, say, migrated an extension, then only that section will show.

Simplify Coveo Backups And Deployments With Resource Snapshots

If an error occurs at that time, you can either make the necessary changes or contact Coveo Support for additional help.


There are a couple of common issues you might come across. Most are typically due to things like fields, query pipelines or conditions that have been manually created separately in both non-production and production organizations with the same name.

Another error you might encounter is related to machine learning models. For example, you might see this show up in your results.

Simplify Coveo Backups And Deployments With Resource Snapshots

If you are taking a snapshot, say from production to non-production, and you’ve had MLMs running in non-production, then it might fail to copy over them. The easiest solution is to just delete the non-production models and have them replaced fully with the production ones. After all, the ones in non-production won’t be relevant anymore anyways.

👋 Hey Sitecore Enthusiasts!

Sign up to our bi-weekly newsletter for a bite-sized curation of valuable insight from the Sitecore community.

What’s in it for you?

  • Stay up-to-date with the latest Sitecore news
  • New to Sitecore? Learn tips and tricks to help you navigate this powerful tool
  • Sitecore pro? Expand your skill set and discover troubleshooting tips
  • Browse open careers and opportunities
  • Get a chance to be featured in upcoming editions
  • Learn our secret handshake
  • And more!
Sitecore Snack a newsletter by Fishtank Consulting

Meet David Austin

Development Team Lead | Sitecore Technology MVP x 3


David is a decorated Development Team Lead with Sitecore Technology MVP and Coveo MVP awards, as well as Sitecore CDP & Personalize Certified. He's worked in IT for 25 years; everything ranging from Developer to Business Analyst to Group Lead helping manage everything from Intranet and Internet sites to facility management and application support. David is a dedicated family man who loves to spend time with his girls. He's also an avid photographer and loves to explore new places.

Connect with David