Basic resource snapshot workflow

This is for:

System Administrator
In this article

This article describes the process of creating a resource snapshot in an organization to apply it to another organization.

The process takes place in two phases, each phase corresponding to one of the two organizations you’re working with. The origin organization is the organization from which you create and export the snapshot, while the destination organization is the one where you apply the snapshot. Typically, the origin organization is a non-production organization, and the destination organization is a production organization. However, you could also decide to apply a snapshot in the same organization it was created, for instance to revert to a backup snapshot.

Depending on who has access to each of the organizations, multiple individuals may be involved in the snapshot application process. Typically, very few people are allowed to make changes to a production organization, so you might need to ask your Coveo administrator to apply a snapshot if you can’t do it yourself.


If you have developer skills, you can import and apply snapshots with the Coveo CLI. The CLI greatly reduces manual intervention and lets you simplify your deployments with modern infrastructure-as-code.

Origin organization

  1. You make changes to your resources and test whether these changes have any unwanted impact.

  2. On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, you create a snapshot and select the resources you changed.

  3. You export your snapshot to the destination organization.

Destination organization

  1. On the Resource Snapshots (platform-ca | platform-eu | platform-au) page, you can review the content of your snapshot.

  2. When you launch the snapshot application process, Coveo first checks that it has all the information it needs to apply your snapshot properly and that your privilege set allows you to carry on with this operation.

  3. Coveo validates your snapshot and matches the resources in it with the resources in the destination organization. You can then review a summary and diff of the changes to apply.

  4. You apply the snapshot to the organization.

See Apply a snapshot to an organization for details on this process.


You made some changes to the code of your indexing pipeline extensions and tested them in your sandbox organization. Since you are satisfied with these changes, you now want to apply them to your production organization. You therefore create a resource snapshot that includes the extensions that you modified, and then export it to your production organization.

You contact the production organization administrator and ask them to review and apply the snapshot. Once they do, your changes apply to the production organization, that is, the new versions of your extension configurations are copied to this organization.

What’s next?

The Snapshot structure article details the JSON structure of a resource snapshot.