Update masking rules

PATCH/projects/{project_id}/branches/{branch_id}/masking_rulesUpdate 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.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The branch ID

pattern ^[a-z0-9-]{1,60}$

Request body

required

application/json

objectMaskingRulesUpdateRequest

masking_rulesarray of objectrequired

List of masking rules to apply to the branch. This will replace all existing masking rules for the branch.

Show child attributes

Show array items

column_namestringrequired

The name of the column to be masked

database_namestringrequired

The name of the database containing the table to be masked

masking_functionstring

The PostgreSQL Anonymizer masking function to apply. Can be a predefined function (e.g., 'anon.random_string(10)', 'anon.fake_email()') or a custom function definition (e.g., 'anon.hash(column_name)')

masking_valuestring

A literal value to set on the column when masking.

schema_namestringrequired

The name of the schema containing the table to be masked

table_namestringrequired

The name of the table containing the column to be masked

Example request

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

Responses

objectMaskingRulesResponse

masking_rulesarray of objectrequired

List of masking rules for the branch

Show child attributes

Items: MaskingRule ↑

Example response

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

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X PATCH 'https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules' \
  -H 'Content-Type: application/json' \
  -d '{"masking_rules":[{"column_name":"email","database_name":"neondb","masking_function":"anon.fake_email()","schema_name":"public","table_name":"users"}]}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"masking_rules":[{"column_name":"email","database_name":"neondb","masking_function":"anon.fake_email()","schema_name":"public","table_name":"users"}]}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"masking_rules\":[{\"column_name\":\"email\",\"database_name\":\"neondb\",\"masking_function\":\"anon.fake_email()\",\"schema_name\":\"public\",\"table_name\":\"users\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules",
    headers={"Content-Type": "application/json"},
    data='{"masking_rules":[{"column_name":"email","database_name":"neondb","masking_function":"anon.fake_email()","schema_name":"public","table_name":"users"}]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"masking_rules":[{"column_name":"email","database_name":"neondb","masking_function":"anon.fake_email()","schema_name":"public","table_name":"users"}]}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"masking_rules\":[{\"column_name\":\"email\",\"database_name\":\"neondb\",\"masking_function\":\"anon.fake_email()\",\"schema_name\":\"public\",\"table_name\":\"users\"}]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"masking_rules\":[{\"column_name\":\"email\",\"database_name\":\"neondb\",\"masking_function\":\"anon.fake_email()\",\"schema_name\":\"public\",\"table_name\":\"users\"}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"masking_rules\":[{\"column_name\":\"email\",\"database_name\":\"neondb\",\"masking_function\":\"anon.fake_email()\",\"schema_name\":\"public\",\"table_name\":\"users\"}]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://console.neon.tech/api/v2/projects/string/branches/string/masking_rules");
request.Content = new StringContent("{\"masking_rules\":[{\"column_name\":\"email\",\"database_name\":\"neondb\",\"masking_function\":\"anon.fake_email()\",\"schema_name\":\"public\",\"table_name\":\"users\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

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

{
  "code": "",
  "message": "string",
  "request_id": "string"
}