/projects/{project_id}/branch_anonymizedCreate anonymized branch
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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branch_anonymized" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.createProjectBranchAnonymized(process.env.PROJECT_ID);Parameters
project_idThe Neon project ID
Request body
No field is required.
branch_createmasking_rulesList of masking rules to apply to the branch.
start_anonymizationIf true, automatically start anonymization after the branch is created. Defaults to false.
annotation_valueAnnotation properties.
Response
201Created a branch. An endpoint is only created if it was specified in the request.
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.