Accidents happen, but losing your documentation shouldn't be a disaster. By configuring automated recovery protocols, you can ensure your hard work is safely backed up and easily restorable. This guide walks you through setting up a backup repository, creating backups, and restoring your documentation if data loss occurs.
flowchart LR
A["Live Documentation"] -->|Automated & Manual Backups| B[("Backup Repository")]
B -->|Point-in-time Restore| AConfiguring Your Backup Repository
Before you can save or restore backups, you need to tell the system where to store your recovery data.
- 1
Navigate to Backup Settings
Open your project dashboard and go to Settings > Backups & Restorations.
- 2
Set the Backup Repository
Provide the connection details for your preferred storage destination. This acts as the secure vault for your documentation history.
- 3
Save Configuration
Click Save Repository. The system will verify the connection and enable automated backup routines.
If you are automating your infrastructure, you can programmatically configure this destination using the PUT /v1/documentation/{organization_id}/{documentation_id}/backup/repository endpoint.
Managing Backups
Once your repository is configured, the system will handle routine backups automatically. However, you can also manage backups manually when making significant changes.
Creating a Manual Backup
We highly recommend triggering a manual backup before executing large structural changes, such as importing a new OpenAPI spec or bulk-deleting pages.
Go to the Backups & Restorations tab.
Click the Create Backup button.
Wait for the confirmation message indicating the backup was successfully stored in your repository.
Viewing Available Backups
You can view a complete history of your saved recovery points. The interface will list all available backups, including timestamps and the author who triggered them.
| Action | API Endpoint | Description |
|---|---|---|
| List Backups | GET /v1/documentation/{organization_id}/{documentation_id}/backup | Retrieves a chronological list of all available recovery points. |
| Create Backup | POST /v1/documentation/{organization_id}/{documentation_id}/backup | Immediately captures the current state of your documentation. |
| Get Repository | GET /v1/documentation/{organization_id}/{documentation_id}/backup/repository | Checks the currently configured storage destination. |
Restoring Documentation
If you experience data loss or unwanted changes, you can roll back your documentation to a previous state using a saved backup.
Data Overwrite Warning
Restoring a backup will completely overwrite your current live documentation. Any changes made after the selected backup was created will be permanently lost.
- 1
Select a Recovery Point
From the Backups list, locate the snapshot you want to revert to. Pay close attention to the timestamp.
- 2
Initiate Restore
Click Restore next to the desired backup.
- 3
Confirm Action
Type the name of your project to confirm the overwrite. The system will begin pulling the data from your backup repository and rebuilding your documentation.
You can also trigger a restore programmatically using the POST /v1/documentation/{organization_id}/{documentation_id}/backup/restore endpoint.
Frequently Asked Questions
Can I start a fresh project using an old backup?
While the standard restore process overwrites an existing project, you can initialize an entirely new documentation project using exported backup files. We support initialization from files, GitHub repositories, websites, OpenAPI specs, and even AI prompts.
What is included in a backup?
Backups include all Markdown files, configured templates, uploaded assets, and your project's navigation structure.
How do I delete old backups?
Currently, backup retention is managed directly within your configured backup repository. You can set lifecycle rules in your storage provider to automatically prune older backups.
Developer Resources
If you are building custom internal tooling, you can manage the entire recovery lifecycle via our API.