Manage Resource Snapshots

Your Coveo deployment probably includes more than one organization. Typically, Coveo customers have a production organization and at least one non-production organization. Since most of the changes you make in Coveo are effective immediately, a good practice is to test them in a non-production organization before applying them to your production organization.

To this end, the resource snapshot feature allows you to copy resource (e.g., source, field, and query pipeline) configurations from one organization to the other, rather than reproducing them manually in a second organization. This feature is especially useful when you manage a large number of resources and want to make bulk changes.

Overall, the resource snapshot feature allows you to:

  • Copy multiple resource configurations from one organization to the other.

  • Review a diff of the changes you import in an organization.

  • Save snapshots as backups.

  • Revert your changes by importing a previous configuration.

  • Download and import snapshots into a version control tool.

The snapshot feature is still at its beta stage, and not all resource types can be included in a snapshot yet. Coveo will progressively release updates to ultimately allow you to include all resources in your organization.

Documentation Subdivision

The resource snapshot management documentation is divided as follows. Readers are advised to browse these articles in order, and then to review the Resource Snapshot Management section when ready to start working with snapshots.

Resource Snapshot Management

Create a Snapshot of Your Organization

To create a new resource snapshot in an organization, you can either import a snapshot file saved on your computer or generate a snapshot of your organization in its current state.

To generate a snapshot:

  1. On the Resource Snapshots page, click Create Snapshot, and then select Of your organization.

  2. In the Create Snapshot of Your Organization panel that appears, you can choose to clear the Include dependencies automatically box. When the box is checked, your snapshot includes not only the desired resources, but all other resources that depend on them. For example, a snapshot of a query pipeline would also include the rules of this pipeline and the machine learning models associated with it. The Include dependencies automatically box is checked by default, as we recommend including dependencies in your snapshot to ensure that the resources you copy to a different organization work identically to those in the original organization.

  3. Select the resources to include in your snapshot. If you want to index only some resources, specify the desired resources.

  4. Enter a descriptive name for your snapshot. This description will appear on the Resource Snapshots page.

  5. Click Create snapshot or, alternatively, click Save for CLI to download your selection for usage in Coveo CLI.

Export a Snapshot

Once you have created a snapshot of your organization, you should want to export it to a different organization where you’ll apply it.

  1. On the Resource Snapshots page, select the desired snapshot, and then, in the Action bar, click Export.

  2. In the Export Snapshot panel that opens, select a destination organization.

  3. Enter a descriptive name for your snapshot. This description will appear on the Resource Snapshots page of the destination organization.

  4. Click Export.

Apply a Snapshot to an Organization

Applying a snapshot to an organization imports the resource configurations contained in the snapshot. If the destination organization contains a different version of a resource included in the snapshot, the snapshot version replaces this version.

  1. On the Resource Snapshots page, select the desired snapshot, and then, in the Action bar, click Open.

  2. On the snapshot subpage, you can review the resources in the snapshot in the Content tab.

  3. In the Overview tab, under Step 1 - Check prerequisites, click Check prerequisites. If Coveo finds missing vault values, click Import vault parameters to import them from the origin organization. Vault key-value pairs are crucial, secret pieces of information used to migrate sensitive data leveraged by your resources, such as credentials used to index content. If the Import vault parameters button doesn’t show up, the vault key-value pairs are impossible to import. For instance, they could have been deleted from the origin organization. Click Create vault entries via API to add them manually instead.

  4. Under Step 2 - Validate snapshot, click Validate snapshot to generate a report of the changes to apply, and then check that the resources will be added and updated as expected. Should you notice errors, under Synchronization, click Update to fix the resource associations. We then recommend to generate and check a new report. Some errors may also be due to a limit that has been reached.

  5. Once your snapshot has been validated, it’s ready to be applied. Under Step 3 - Apply changes, click Apply changes to apply the snapshot to your organization.

Save a Snapshot on Your Machine

Since the number of snapshots you can have in your organization is limited, you can save the content of a snapshot on your machine for future use.

On the Resource Snapshots page, select the desired snapshot, and then, in the Action bar, click Open. In the Content tab, click Copy to Clipboard to copy the JSON code representing the snapshot content. You can then paste this code in the desired software and save it on your machine.

To import the snapshot in an organization, on the Resource Snapshots page, click Create snapshot, and then From a JSON or ZIP file.


An organization can contain up to 20 snapshots. Should you create or import more, the oldest will be deleted.

Snapshots are automatically deleted 6 months after their creation.

What’s Next?

See the Basic Resource Snapshot Workflow to understand how resource snapshots are created, and then imported and applied to a different organization.

What's Next for Me?