> 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-data-hold-settings.md).

# Changing Data Hold 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 Data Hold feature lets administrators define rules that prevent specific backed-up and archived records from being permanently deleted, whether by an automated Retention Policy or a manual Purge operation. You apply Data Holds at the object level and can use filters to narrow which records are held. Once an object is under a Data Hold, all current and future backup and archive records that match the hold are protected. This article explains how to add and remove Data Holds.

{% hint style="info" %}

#### Data Hold Scope

Data Holds are configured per organization. A hold applies only to objects within the organization you are configuring; it does not protect objects in any other organization.
{% endhint %}

## Data Hold Settings

{% stepper %}
{% step %}

### Access Data Hold Settings

Below are instructions for accessing the Data Hold settings for the selected organization and for adding and removing a data hold.

1. Click **Settings** from the sidebar menu.
2. Click the **Organization** to change the Data Hold for.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FNSqajx8zcEd6Gxnd96sy%2FChangingDataHoldSettings-S01-01.png?alt=media&amp;token=cc888798-8294-4a13-9f46-8e0fbb7147bd" alt="" width="563"><figcaption></figcaption></figure></div>
3. Click the **Data Hold** tab.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fv3mahK6b78h77Q1bKIhv%2FChangingDataHoldSettings-S01-02.png?alt=media&amp;token=6a6ae64c-936f-4fca-ad12-96d9a0604e2a" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Add Objects to Data Hold

You can add any backed-up or archived object to a Data Hold, and you can add as many as needed.

1. Click **Add object**.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FGP4dclrOVXgaw0oiq6nQ%2FChangingDataHoldSettings-S02-01.png?alt=media&amp;token=4164c726-61a1-4887-b188-d513783a3204" alt="" width="563"><figcaption></figcaption></figure></div>
2. A list of all objects backed up for this organization is displayed.
3. **Search** or scroll to find an object.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fdfd0RWTFO86khlWFCgYr%2FChangingDataHoldSettings-S02-02.png?alt=media&amp;token=6eee0db6-8482-48f1-9f77-555946c9da20" alt="" width="563"><figcaption></figcaption></figure></div>
4. Click **Add** for each object you want to add a Data Hold for.
5. Add as many objects as needed.
6. Click **Apply**.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fgx3Y76szhcHrrADWctXq%2FChangingDataHoldSettings-S02-03.png?alt=media&amp;token=57950e61-4d1b-4890-96df-9e1534dd12a0" alt="" width="563"><figcaption></figcaption></figure></div>
7. The selected objects will now be displayed in the **Data Hold Objects** list.
8. Add more objects by clicking **Add object** and repeating this process.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fv9TSuvPBZer7rW4svKce%2FChangingDataHoldSettings-S02-04.png?alt=media&amp;token=727bcbfd-95fb-48a1-9abe-8ee479c3098e" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Add Filters to Objects

You can add filters to objects to limit the Data Hold to only records that match the filter criteria.

1. Click the **Filter** button for the object you want to filter.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FxvdxxKGCveiWLF6trdhE%2FChangingDataHoldSettings-S03-01.png?alt=media&amp;token=78d7c735-2d19-47b3-8aaf-60b6cf298347" alt="" width="563"><figcaption></figcaption></figure></div>
2. Click **Add filter**.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FXZt0oigFamPVZPrqTVyg%2FChangingDataHoldSettings-S03-02.png?alt=media&amp;token=9a769399-326d-4d93-9c52-04ed81047042" alt="" width="563"><figcaption></figcaption></figure></div>
3. Click the **Select field** dropdown menu.
4. Select the object's field to use in this filter.
5. Click the **Select an option** dropdown menu.
6. Select the operation to perform with this filter.
7. Enter the value to filter with in the textbox.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2F7Arysk5qJ5LfOCX0YnyU%2FChangingDataHoldSettings-S03-03.png?alt=media&amp;token=ee77d786-e77d-47bc-9763-be53f368e840" alt="" width="563"><figcaption></figcaption></figure></div>

**Multiple Filters**

1. To add another filter, click **Add filter**.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2F70QRJ63pYkyffj6lyW7Y%2FChangingDataHoldSettings-S03-04.png?alt=media&amp;token=a382f9f4-fc40-4355-9f67-2f6163adfa43" alt="" width="563"><figcaption></figcaption></figure></div>
2. Complete the filter using the same process as above.
3. By default, multiple filters are combined with a logical AND. This means all filters must match for the record to pass.
4. To combine filters using **AND**, **OR**, and **()** operations:
   1. Click the **Logic Selection** dropdown menu.

      <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FLHBgQyf1Dm2awPcrGElg%2FChangingDataHoldSettings-S03-05.png?alt=media&amp;token=b76c63c4-20e6-4eac-8267-f22f930253d2" alt="" width="563"><figcaption></figcaption></figure></div>
   2. Select **Custom logic**.
   3. Enter your custom logic in the textbox to the right of the dropdown menu.

**Apply Filter**

1. Click **Apply** to save the filter.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FIDrFCZS687FHkfPBpTgc%2FChangingDataHoldSettings-S03-06.png?alt=media&amp;token=d9292f1a-ab33-4313-a7cb-e530185017b6" alt="" width="563"><figcaption></figcaption></figure></div>

{% endstep %}

{% step %}

### Save Data Hold

A Data Hold takes effect as soon as you add an object to the **Data Hold Objects** list. No save button or other action is required, and any filters you apply to objects also take effect immediately. In the screenshot below, both the **Contact** and **Account** objects are protected by the Data Hold. The **Account** object has one filter applied, indicated by the circle showing the number of filters.

<div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fa6mnefmfj6CijthzBg4z%2FChangingDataHoldSettings-S04-01.png?alt=media&amp;token=c7b09ad7-1768-4577-9f8e-acd4ee9a3901" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Remove Data Hold

You can remove a Data Hold from an object. Once the hold is removed, it no longer applies to that object's backed-up and archived data. That data can then be deleted by a manual purge or by a Retention Policy.

1. Click the **Trash Can** icon for the object to remove the data hold from.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2Fs1pqzhd3kDcdlp5ycrZ8%2FChangingDataHoldSettings-S05-01.png?alt=media&amp;token=85096aff-ff0f-44ed-a6e3-e157953f594f" alt="" width="563"><figcaption></figcaption></figure></div>
2. Click **Confirm** in the **Delete object from data hold** confirmation dialog box.

   <div align="left"><figure><img src="https://646917531-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Focom3JROuDKOidclKbQx%2Fuploads%2FqAHvGQ8xhQFIyyHkKDHc%2FChangingDataHoldSettings-S05-02.png?alt=media&amp;token=062faaa3-78fa-4d7d-ae83-1ebf2c174439" alt="" width="375"><figcaption></figcaption></figure></div>
3. Once the Data Hold is removed, it will no longer apply to the object.
   {% 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-data-hold-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.
