> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/backup-and-archive/settings/organization-settings/changing-retention-policy-settings.md).

# Changing Retention Policy Settings

{% hint style="success" %}

#### Required User Credentials

\[**Flosum User**] - **Backup & Archive** license with **App Settings** permissions
{% endhint %}

## ![](https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fgit-blob-3f6faa4230b72167926fbc0a31dd17dc7d74581d%2FSummary2-Small-Icon.svg?alt=media) Overview

The Retention Policy feature automates the removal of backed-up and archived data after a configured period. This helps control storage growth and aligns data lifecycles with internal governance and compliance requirements, without the risk of accidental data loss from manual cleanup. This article explains how Retention Policies work and how to add, edit, and remove them from an organization.

### How Retention Policy Works

Retention Policies are specific to each organization, and you can add as many as needed. A Retention Policy sets the retention period for one or more objects, up to all objects in the organization. You configure retention periods separately for backup and archive records, with values ranging from 1 month to 12 years.

If multiple Retention Policies apply to the same object, the policy with the longer retention period takes effect. For example, suppose you have two policies: one that retains all objects for 6 months, and one that retains only Account objects for 1 year. Account objects are retained for 1 year, while all other objects are retained for 6 months.

{% hint style="warning" %}

#### **Two Records Retained**

Regardless of the configured retention period, the system always retains the two most recent versions of any record. This helps prevent data loss from accidental deletions or data corruption.
{% endhint %}

{% hint style="info" %}

#### New Objects

New objects added to an organization are not included in any existing Retention Policies. To include a new object, first create a backup or archive that contains it, then add it to the desired Retention Policy.
{% endhint %}

#### Example Scenarios

In each of the following cases, for simplicity, a single Retention Policy applies to all objects. The cases illustrate different usage patterns and retention lengths, and they account only for backed-up versions.

**Case 1: Frequently Changed Objects**

<table><thead><tr><th width="200">Detail</th><th>Description</th></tr></thead><tbody><tr><td>Retention Period</td><td>12 months</td></tr><tr><td>Usage</td><td>Objects change daily.</td></tr><tr><td>Retention Behavior</td><td>All versions created within the past 12 months are retained; older versions are deleted.</td></tr><tr><td>Versions Retained</td><td>~365 versions</td></tr></tbody></table>

**Case 2: Infrequently Changed Objects**

<table><thead><tr><th width="199.99993896484375">Detail</th><th>Description</th></tr></thead><tbody><tr><td>Retention Period</td><td>12 months</td></tr><tr><td>Usage</td><td>Objects change every 6 months.</td></tr><tr><td>Retention Behavior</td><td>Two versions are created during the 12-month period, and all older versions are deleted.</td></tr><tr><td>Versions Retained</td><td>2 versions</td></tr></tbody></table>

**Case 3: All Versions Older Than Retention Period**

<table><thead><tr><th width="200">Detail</th><th>Description</th></tr></thead><tbody><tr><td>Retention Period</td><td>6 months</td></tr><tr><td>Usage</td><td>Objects have not changed for 2 years. Before that, 100 versions were backed up.</td></tr><tr><td>Retention Behavior</td><td>No new versions were created during the 6-month retention period. Because the system always retains at least 2 versions, the 2 most recent versions are kept and the rest are deleted.</td></tr><tr><td>Versions Retained</td><td>2 versions</td></tr></tbody></table>

## Retention Policy Settings

{% stepper %}
{% step %}

### Access Retention Policy Settings

Below are instructions for accessing the Retention Policies for the selected organization and for adding, editing, and removing a policy.

1. Click **Settings** from the sidebar menu.
2. Click the **Organization** to change a Retention Policy for.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FI09BTf7VvMEcmYJcl1oC%2FOverviewOfRetentionPolicySettings-S01-01.png?alt=media&amp;token=ecf7f5ae-c1eb-4606-8dd7-8781a42b24df" alt="" width="563"><figcaption></figcaption></figure></div>
3. Click the **Retention Policy** tab.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2F7u3K1iyDTzcACWcTI53q%2FOverviewOfRetentionPolicySettings-S01-02.png?alt=media&amp;token=d0416453-415b-45c8-abb6-2cdcd20939da" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Add Policy and Set Period

1. Click **Add more** at the bottom of the **Retention Policy Templates** section.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FcRHGb4uFRSNpKNj0aQJs%2FOverviewOfRetentionPolicySettings-S02-01.png?alt=media&amp;token=c70935f3-88a9-48fb-9e37-7e26801aacb6" alt="" width="563"><figcaption></figcaption></figure></div>
2. Enter a **Name** for the policy template.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FVKwkUAtJa1Ptx3MOB7Ak%2FOverviewOfRetentionPolicySettings-S02-02.png?alt=media&amp;token=26aa98c2-0d78-41ff-9297-86cc46e21870" alt="" width="563"><figcaption></figcaption></figure></div>
3. Set the retention period for Backup Records.
   1. In the **Backup Keep For** text box, enter the number of months or years to retain backup records for this policy.
   2. Click the **Month/Year** dropdown menu.
   3. Select the time interval to use for backup records for this policy.

      <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FhDdmeibWR3K7WeCm38co%2FOverviewOfRetentionPolicySettings-S02-03.png?alt=media&amp;token=94fb4737-b536-4397-854c-0e9273e485bd" alt="" width="563"><figcaption></figcaption></figure></div>
4. Set the retention period for Archive Records.
   1. In the **Archive Keep For** text box, enter the number of months or years to retain archive records for this policy.
   2. Click the **Month/Year** dropdown menu.
   3. Select the time interval to use for archive records for this policy.
      {% endstep %}

{% step %}

### Add Objects

**Add All Objects**

1. Click **Select All** to include all objects in this retention policy.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FhQhbwHzS0IBxlz0CZSdP%2FOverviewOfRetentionPolicySettings-S03-01.png?alt=media&amp;token=87afdde6-8083-432c-b546-cbafb04bb97c" alt="" width="563"><figcaption></figcaption></figure></div>
2. The **Added** tab will now include all objects.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FPyeqkTpeoCm8TAq5ZnIf%2FOverviewOfRetentionPolicySettings-S03-02.png?alt=media&amp;token=b1764716-8576-4c4c-bb99-bc0a999a3136" alt="" width="563"><figcaption></figcaption></figure></div>

**Add Individual Objects**

1. Enter the object you want to add in the **Search Bar**.
2. Click **Add** for the object you want to include in this retention policy.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FqZDQZrQb2i84G00AM169%2FOverviewOfRetentionPolicySettings-S03-03.png?alt=media&amp;token=3a2bac4d-6daa-442b-9554-cf6474f119ad" alt="" width="563"><figcaption></figcaption></figure></div>
3. The **Added** tab will now include the object you added.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FoDf6XwFzo7FuorgzYwFY%2FOverviewOfRetentionPolicySettings-S03-04.png?alt=media&amp;token=e8c5a16d-1aba-4d81-99a0-73dce9ee4e0c" alt="" width="563"><figcaption></figcaption></figure></div>

{% hint style="info" %}

#### Remove Objects

1. Click the **Added** tab.
2. Click the **Added** button to the right of each object to remove.
3.

{% endhint %}
{% endstep %}

{% step %}

### Finish Adding Policy

1. Click the **Add** button at the bottom of the retention policy template.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FafcYRGiSTsxrRo1l96Hl%2FOverviewOfRetentionPolicySettings-S04-01.png?alt=media&amp;token=2bb71ea0-6a4a-4e67-898f-a679ef6eb194" alt="" width="563"><figcaption></figcaption></figure></div>
2. Once added, the new retention policy will be listed in the **Retention Policy Templates** section.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2F19vC6erErKpXDwBwS724%2FOverviewOfRetentionPolicySettings-S04-02.png?alt=media&amp;token=6a8102d4-14ef-42b4-9cd0-561d38e2e969" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Edit Retention Policy

The process of editing a retention policy is the same as adding a new one. See the sections above for more details.

1. Click **Edit** for the retention policy you want to edit.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FtzBiPuOOPnFrAjUD4xL1%2FOverviewOfRetentionPolicySettings-S05-01.png?alt=media&amp;token=25bba5da-e875-4dc0-824d-26b94c8d1a23" alt="" width="563"><figcaption></figcaption></figure></div>
2. Make the desired changes to the retention policy.
3. Click **Save** to save the changes.
   {% endstep %}

{% step %}

### Deleting a Retention Policy

1. Click the **Trash Can** button for the retention policy you want to delete.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2F1PvWIa0gR3nVBVeWBSzb%2FOverviewOfRetentionPolicySettings-S06-01.png?alt=media&amp;token=2c493492-6068-47bb-b4dc-62849be32d90" alt="" width="563"><figcaption></figcaption></figure></div>
2. Click **Confirm** in the **Delete retention policy template** confirmation dialog.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FnmUgVNfPdS7ymrv8bzIn%2FOverviewOfRetentionPolicySettings-S06-02.png?alt=media&amp;token=84a3ccd2-30c3-4697-a3cd-6e7d181ac9fd" alt="" width="375"><figcaption></figcaption></figure></div>
3. The retention policy has now been deleted.
   {% endstep %}
   {% endstepper %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/backup-and-archive/settings/organization-settings/changing-retention-policy-settings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
