Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Update a scrubbing policy
Updates the environment's scrubbing policy.
Updates the environment's scrubbing policy.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/scrubbing_policies/scrubbing-policy - Scope
observability:write - Effect
write— a successful call changes state. - Collection scrubbing_policies
- Query
update_mask
#Request
| Field | Type | What it is |
|---|---|---|
scrubbing_policy | ScrubbingPolicy | The scrubbing policy to update; name identifies it. Required. |
update_mask | field_mask | The fields to write; unset writes every populated field. |
#ScrubbingPolicy
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/scrubbing_policies/default. |
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]. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
#Response
| 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]. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/scrubbing_policies/scrubbing-policy" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/scrubbing_policies/scrubbing-policy"}'