T
testing
Backups & Restorations Automating Backups and Restorations

Protecting your documentation is critical. GitDocAI allows you to automatically back up your documentation state to a designated repository and easily restore it whenever needed, ensuring you never lose your hard work.

By configuring a backup repository, you can take manual snapshots, set up automated backup schedules, and roll back to previous versions of your documentation with just a few clicks.

flowchart LR
    A["Active Documentation"] -->|"Configure Repo"| B["Backup Repository"]
    A -->|"Trigger Backup"| B
    B -->|"List Backups"| C["Backup History"]
    B -->|"Restore State"| A

Configuring a backup repository

Before you can back up or restore your documentation, you need to tell GitDocAI where to store your backup files.

  1. 1

    Navigate to Backup Settings

    Open your project dashboard and go to Settings > Backups & Restorations.

  2. 2

    Define the Repository

    Enter the connection details for your target backup repository. This is where GitDocAI will push your documentation state.

  3. 3

    Set an Automated Schedule

    Choose how often you want GitDocAI to automatically back up your documentation (e.g., Daily, Weekly, or on every publish).

  4. 4

    Save Configuration

    Click Save to apply your changes. GitDocAI will verify the connection to your repository.

We recommend setting up a daily automated schedule. This guarantees that you always have a recent snapshot of your documentation without having to remember to trigger it manually.

Managing backups

Once your repository is configured, GitDocAI handles scheduled backups automatically in the background. However, you can also manage backups manually.

Creating a manual backup

If you are about to make major changes to your documentation structure or run a large import, it is a good idea to trigger a manual backup first. You can do this by clicking the Create Backup button in your Backups dashboard.

Restoring from a backup

If you ever need to revert your documentation to a previous state, you can restore it from any successful backup.

Restoring a backup will overwrite your current active documentation state. Any changes made after the selected backup was created will be lost.

  1. Go to the Backups tab in your documentation settings.

  2. Browse your Backup History to find the snapshot you want to revert to.

  3. Click Restore next to the desired backup.

  4. Confirm the action when prompted. Your documentation will be rolled back to the exact state it was in when the backup was taken.

API Reference for Automation

If you prefer to integrate GitDocAI backups into your own CI/CD pipelines or custom internal tools, you can use our Backup API endpoints.

ActionMethodEndpointDescription
List BackupsGET/v1/documentation/{organization_id}/{documentation_id}/backupRetrieves a history of all successful backups.
Create BackupPOST/v1/documentation/{organization_id}/{documentation_id}/backupTriggers a new backup immediately.
Get ConfigGET/v1/documentation/{organization_id}/{documentation_id}/backup/repositoryReturns the currently configured backup repository.
Set ConfigPUT/v1/documentation/{organization_id}/{documentation_id}/backup/repositoryUpdates the backup repository destination.
RestorePOST/v1/documentation/{organization_id}/{documentation_id}/backup/restoreRestores the documentation to a specific backup state.
Can I back up documentation initialized from different sources?

Yes! Whether you initialized your documentation from a blank scaffold, an AI prompt, a GitHub repository, an OpenAPI spec, or an imported website, the backup system captures the current working state of your GitDocAI project perfectly.

Where do I find my Organization and Documentation IDs?

Your organization_id and documentation_id can be found in the URL of your GitDocAI dashboard, or under the General Settings tab of your project.