---
updatedAt: 2026-09-28T14:52:08.000Z
agentTools:
  projectIndex: https://developer.searchblox.com/llms.txt
---

# Collection Encryption

Collection Encryption allows SearchBlox to encrypt indexed content and metadata fields, ensuring sensitive information remains secure while still being searchable. Encrypted content cannot be viewed directly in search results or Elasticsearch — only users with Sensitive access can view and decrypt it.

* SearchBlox can encrypt content and specific meta fields.
* To enable encryption, a **special license** from SearchBlox is required, available only to **Platinum Support** customers.
* Please contact **<support@searchblox.com>** for the license key.

## **Content Encryption**

* Content Encryption is supported for all collection types **except Amazon S3 Collection**.
* The **content field** indexed from a webpage or file in HTTP/File Collection will be encrypted.
* Content from **PST files** is also encrypted in Email Collection.
* For sensitive information (e.g., credit card info, account details) that should remain secure but searchable, enable the **encryption option** while creating the collection.
* Encrypted content **cannot be viewed** in search results or directly in Elasticsearch.
* Searching for a term in encrypted content will still display the **URL or document** in results.
* **To encrypt content:**

  * Enable the **encrypt** option while creating a collection
  * **Index** the collection

  ![](https://files.readme.io/2da885bcba9d1dfe2f04f9475ecb9dfa4b2082b88c3a18adf6ab9d7f55a82903-web1.jpeg)

  ## **Metadata Field Encryption**
* Metadata fields can be encrypted in **CSV, Custom, and Database Collections**.
* Any sensitive information can be secured by encrypting it in these collections.
* **To encrypt a field:**

  * Enable the **encrypt** option while creating the collection
  * Prefix field names with **deid\_** (e.g., `deid_ccnumber`) in SQL, CSV, or REST API
  * **Index** the collection

[block:image]
{
  "images": [
    {
      "image": [
        "https://files.readme.io/adcbd40-enc.png",
        "enc.png",
        883
      ],
      "align": "center",
      "caption": "_deid field in REST API request for Custom Collection_"
    }
  ]
}
[/block]

[block:image]
{
  "images": [
    {
      "image": [
        "https://files.readme.io/e549f53-encrypt6.png",
        "encrypt6.png",
        481
      ],
      "align": "center",
      "caption": "_deid field in table for Database Collection_"
    }
  ]
}
[/block]

## Steps to Enable Encryption for Content

1. Upload the special encryption license in Administration > License.
2. Enable the Encryption option while creating a collection.

   ![](https://files.readme.io/4ffea4093817e69c7beb31e4a6894efb440b1dadc73be0c041404b916cb6b1c1-web1.jpeg)

   <br />
3. Index the collection.
4. For HTTP, File System, and Email Collections, the content and context will be encrypted and viewable in Elasticsearch.

[block:image]
{
  "images": [
    {
      "image": [
        "https://files.readme.io/ed445835c4632f1457c8365ee720a111bbdbb4c105e231b69356e7cf59f0b2e3-image_30.png",
        "encrypt4.png",
        ""
      ],
      "align": "center"
    }
  ]
}
[/block]

5. For Custom, CSV, and Database Collections, the meta fields with prefix deid\_ will be encrypted.

![](https://files.readme.io/413f7dc-deid.png "deid.png")

6. Encrypted content and meta fields are visible only to Sensitive users in SearchBlox Realm or LDAP Realm if secure search is enabled.

## **Encrypted Meta Field for Custom Collection**

* Encrypted metadata fields in a Custom Collection must start with **deid\_** and be sent via **updatemetadata** or **add** API requests.
* Please refer to a sample request updatemetadata as shown.

```json updatemetadata
{
         "apikey" : "31372006F71D0A874BBE0F02894C7E0A",
         "document" : {
         "colname" : "test",
         "url" : "http://www.searchblox.com",
         "meta":{
           "deid_location":"San Francisco",
           "deid_temp":"23",
           "deid_weather":"sunny
         }
     }
 }
```

## **Sensitive Users**

* In **SearchBlox 10.8**, you can enable or disable **sensitive data access** while creating users in **SearchBlox Realm** or **LDAP Realm**.

### SearchBlox Realm

* In **SearchBlox Realm**, you can enable **sensitive search** for a **Manager** user by selecting the **Sensitive** option while creating the useras shown in the screenshot:

***

![](https://files.readme.io/3a0bf355677d41f3532874a16b9a696d943938ea06c99e30e45ec0e70b72fc33-manager1.jpeg)

### LDAP Realm

* In **LDAP Realm**, you can enable **sensitive search** for a user in a group by assigning the **Sensitive** role while adding the security group as shown in the screenshot:

  ![](https://files.readme.io/8edfc026ac64816b091c74669398ce49cccb6ecdc9970491857a6ebd772e0d6a-Screenshot_4205.png)

> 👍 Best Practices
>
> * To encrypt the entire content, use HTTP, File Collection, or Email Collection.
> * To encrypt specific fields, use Custom Collection, CSV Collection, or Database Collection by adding the prefix deid\_ to the field name.
> * Only Sensitive users can view and decrypt the encrypted content, so create Sensitive users when creating encrypted collections if you need access to content or metadata.