Sign in
Branch

Update masking rules

Updates the masking rules for the specified anonymized branch. Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer.

Note: This endpoint is currently in Beta.

patch/projects/{project_id}/branches/{branch_id}/masking_rules

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/masking_rules
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

Example request

{
  "masking_rules": [
    {
      "database_name": "neondb",
      "schema_name": "public",
      "table_name": "users",
      "column_name": "email",
      "masking_function": "anon.fake_email()"
    }
  ]
}

Response

Masking rules updated successfully

Example response

{
  "masking_rules": [
    {
      "database_name": "neondb",
      "schema_name": "public",
      "table_name": "users",
      "column_name": "email",
      "masking_function": "anon.fake_email()"
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.