Create anonymized branch

POST /projects/{project_id}/branch_anonymized

Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking. This allows developers to work with masked production data. Optionally, provide masking_rules to set initial masking rules for the branch and start_anonymization to automatically start anonymization after creation. This combines functionality of updating masking rules and starting anonymization into the branch creation request.

Note: This endpoint is currently in Beta.

Markdown for AI context

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branch_anonymized" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createProjectBranchAnonymized({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID
  }
});

Project ID

project_id

string

The Neon project ID

No field is required.

Branch create

branch_create

object

Masking rules

masking_rules

array

List of masking rules to apply to the branch.

Start anonymization

start_anonymization

booleandefault: false

If true, automatically start anonymization after the branch is created. Defaults to false.

Annotation value

annotation_value

object

A free-form map of string key-value pairs for attaching metadata to a resource (for example, a git commit reference). Maximum 50 entries.

201

Created a branch. An endpoint is only created if it was specified in the request.

default

General error

This endpoint can return the standard Neon API error response.

Response fields

• message Required. Human-readable error message.
• code Required. Machine-readable error code.
• request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.