What are Snapshots?

Snapshots in KB Explorer are point-in-time copies of your knowledge base. They allow you to capture the exact state of your content at a specific moment, enabling you to revert to previous versions, compare changes, or create backup archives.

Why Use Snapshots?

  • Version Control: Track the evolution of your knowledge base.
  • Disaster Recovery: Quickly restore your KB if data is accidentally deleted or corrupted.
  • Auditing: Maintain a record of content changes for compliance or review.
  • Experimentation: Safely make significant changes or test new structures without risking your live data.

Creating a Snapshot

Creating a snapshot is a straightforward process. Navigate to the 'Snapshots' section in your user dashboard.

  1. Click the "Create New Snapshot" button.
  2. Provide a descriptive name for your snapshot (e.g., "Pre-Major-Update-2023-10-27").
  3. Optionally, add a brief description.
  4. Click "Confirm" to initiate the snapshot creation.

The process may take a few moments depending on the size of your knowledge base. You will receive a notification once the snapshot is complete.

Tip: Regularly scheduled snapshots can be configured in the 'Settings' > 'Automation' section to ensure continuous protection.

Managing Snapshots

Once created, your snapshots will appear in a list. For each snapshot, you can:

  • View Details: See the snapshot name, description, creation date, and size.
  • Download: Obtain a downloadable archive of the snapshot.
  • Restore: Revert your entire knowledge base to the state of this snapshot. Caution: Restoring will overwrite current data.
  • Delete: Remove a snapshot to free up storage space.

Restoring from a Snapshot

To restore your knowledge base:

  1. Locate the desired snapshot in the list.
  2. Click the "Restore" button associated with that snapshot.
  3. A confirmation dialog will appear, warning you about overwriting current data.
  4. Type "CONFIRM" into the provided field and click "Begin Restore".

The restoration process can take some time. You will be alerted when it is complete.

Example Snapshot Command (API)

If you are using the KB Explorer API, you can create a snapshot programmatically:

POST /api/v1/snapshots Content-Type: application/json { "name": "API_Backup_2023-10-27", "description": "Snapshot created via API for backup purposes." }

For more advanced API operations, please refer to our API Usage guide.