---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Scrubbing policies"
description: "The `scrubbing_policies` collection of Sylphx Observability: The Scrubbing Policy of a project environment: what is removed from every captured error before it is stored."
type: reference
product: monitoring
summary: "The Scrubbing Policy of a project environment: what is removed from every captured error before it is stored."
updated: 2026-09-28
order: 900
---

The Scrubbing Policy of a project environment: what is removed from every captured error before it is stored. The default rules always apply: fields named like a password, secret, token, key, cookie, session, authorization, or card are replaced with `[Filtered]`, and card numbers, bearer tokens, JWTs, and Sylphx secret keys are replaced wherever they appear. Email addresses are replaced unless `keep_emails` is set. The environment's policy adds to the defaults; it cannot remove them.

**Service** Sylphx Observability · **Resource type** `observability.sylphx.com/ScrubbingPolicy` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/scrubbing_policies/{scrubbing_policy}` · **Shape** `singleton`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/scrubbing_policies/default`. |
| `uid` | `string` | `scp_<env>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata; `meta.etag` fences updates. |
| `denied_fields` | `string[]` | More field names to replace with `[Filtered]` wherever they appear in tags, extra data, request data, or breadcrumb data (case-insensitive, matched as a substring), at most 64. |
| `keep_emails` | `bool` | Keep email addresses instead of replacing them with `[email]`. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/scrubbing_policies#get) | Gets the environment's scrubbing policy (`scrubbing_policies/default`). |
| `PATCH` | [`update`](/docs/api/scrubbing_policies#update) | Updates the environment's scrubbing policy. |

## get

Gets the environment's scrubbing policy (`scrubbing_policies/default`).

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/scrubbing_policies/scrubbing-policy` · scope `observability:read` · effect `read` · [Request, response and examples](/docs/api/scrubbing_policies/get)

## update

Updates the environment's scrubbing policy.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/scrubbing_policies/scrubbing-policy` · scope `observability:write` · effect `write` · [Request, response and examples](/docs/api/scrubbing_policies/update)