Snapshots

Snapshots are like checkpoints. They allow you to save your endpoint’s mock rules, responses, runtime settings, and active API contract as a single restorable configuration. Much like Git commits for your source code, snapshots are for Beeceptor endpoints and provide reliable restore points that you can return to at any time as your virtual mock servers evolve.

Instead of manually rebuilding complex mock server rules or re-uploading API contracts, snapshots let you save known-good states, switch between different test setups, or roll back instantly when new rule changes cause test regressions.

info

Snapshots are available on the Scale and Enterprise plans.

Manage Snapshots

You can access snapshots for any endpoint from it's Settings page. Once you are on the endpoint's dashboard, you can select three-dots menu icon (⋮) in the upper section and select Settings. On the left navigation menu, select Snapshots to manage.

Create a snapshot

To capture your endpoint's current state:

1. Open the endpoint's Settings.
2. In the left menu, select Snapshots.
3. Select + Create.
4. Enter a Name for the snapshot (e.g., Before v2 API rollout or QA-Error-Simulation).
5. Provide an optional Purpose (description) explaining why the snapshot was created or when it should be restored.
6. Select + Create to save the snapshot.

Restore a snapshot

To roll back your endpoint to a previously saved snapshot:

1. Open the endpoint's Settings.
2. In the left menu, select Snapshots.
3. Select Restore next to the snapshot details.
4. Confirm the restoration. Your endpoint's active Mock Rules, runtime settings, and active API contract will immediately restored to the snapshot's saved state.

Delete a snapshot

If a snapshot is no longer required, select Delete on the snapshot card to remove it from your endpoint's saved configurations.

Configuration Scope

Snapshots capture the endpoint configuration that controls mock behavior. Restoring a snapshot replaces only the included configuration; excluded settings, credentials, data, and endpoint identity remain unchanged.

Restoring a snapshot does not change the following:

Feature	Configuration Preserved
Proxy and authentication security	Forward Proxy credentials and settings, plus Endpoint Security header authentication, including its enabled state, header name, and secret value.
Domains and certificates	Custom-domain configuration and all mTLS state, certificates, and private keys.
Stateful data and history	CRUD records, State Store data, and request history. CRUD rules are included in the snapshot, but the records created through those rules are not.
Endpoint identity and access	Endpoint URL and name, API keys, permissions and invitations, and workspace, organization, or subscription/billing state.
External connections	API Connection records and their OAuth credentials. Rules that reference a connection are restored without copying or changing the connection itself.

Common Use Cases

Snapshots make your configuration management easy, and let's you switch test configs in a few seconds, or experiment risk-free. Here’s how other teams use:

• Before major changes: Save a known-good state before updating rules, contracts, or settings.
• Switch test scenarios: Jump between different QA, integration, or environment configurations.
• Recover from regressions: Restore a stable setup when new changes break existing tests.
• Demo configurations: Keep polished, reliable setups ready for customer demos and workshops.
• Restore points: Create reliable backups as your mock servers evolve.