> For the complete documentation index, see [llms.txt](https://docs.nuvolos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nuvolos.com/how-to-guides/common-workflows/snapshots/create-a-snapshot.md).

# Create a snapshot

<mark style="color:$primary;">**Outcome**</mark>\
You preserve the complete Current state of an instance - files, tables, and application configurations - as an immutable, time-stamped record.

<mark style="color:$primary;">**Before you start**</mark>

* You are in the Current state of the instance you want to snapshot.
* You hold the **Instance Editor** role or higher in the instance.
* All work you want to preserve has been saved (snapshots capture what is on disk, not what is in memory).

A snapshot captures the complete Current state of an instance as an immutable, time-stamped record. There are two ways to create one:

* **Quick snapshot** - captures the Current state with the timestamp as the snapshot name. Use this when you want a safety net before a risky operation and don't need to find the snapshot by name later.
* **Detailed snapshot** - captures the Current state with a user-provided name and description. Use this when you want a named record of a meaningful state ("end of term", "v1.0 final analysis", "before final submission") that you can find later by name.

### **Create a quick snapshot**

{% stepper %}
{% step %}
Navigate to the space containing the instance.
{% endstep %}

{% step %}
Make sure you are viewing the Current State of an instance.
{% endstep %}

{% step %}
From the left sidebar, hover on the camera icon and click on **QUICK SNAPSHOT**.
{% endstep %}
{% endstepper %}

### Create a detailed snapshot

{% stepper %}
{% step %}
Navigate to the space containing the instance.
{% endstep %}

{% step %}
Make sure you are viewing the current state of an instance.
{% endstep %}

{% step %}
From the left sidebar, hover on the camera icon and click on **TAKE SNAPSHOT AND DESCRIBE**.
{% endstep %}

{% step %}
Fill in the snapshot name and description form. Snapshot names need to be unique in an instance.
{% endstep %}

{% step %}
Click **+ ADD SNAPSHOT**.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Snapshots are created almost instantaneously. Refresh the page before creating another snapshot - the UI may otherwise prevent the second creation.
{% endhint %}

### Role-specific notes

{% tabs %}
{% tab title="🎓 For instructors" %}
Date- or term-based names work well for course archives ("2025-spring-final", "end-of-term-stats101"). Detailed snapshots are worth the extra effort here because you'll be looking for them next term when reusing the course.
{% endtab %}

{% tab title="📖 For students" %}
Quick snapshots are usually sufficient. Take one before starting an assignment session and another before submitting. If you take a detailed snapshot, descriptive task-based names ("before final submission", "after Tuesday's lab") are easier to identify than dates.
{% endtab %}

{% tab title="🔬 For researchers" %}
Detailed snapshots representing stable, citable states of the data or analysis are often called vintages - convention from the Nuvolos team. Names like "v1.0 - final analysis 2026-05" make snapshots easy to reference in handovers and papers.
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.nuvolos.com/how-to-guides/common-workflows/snapshots/create-a-snapshot.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.