# 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. Base URL: `https://console.neon.tech/api/v2` Tags: `Branch` ## Authorization Any ONE of the following options authorizes this operation; every scheme listed within an option is required together. | Option | Scheme | Type | Sent as | Scopes | | --- | --- | --- | --- | --- | | Option 1 | `BearerAuth` | `http` | `Authorization: Bearer ` | — | | Option 2 | `CookieAuth` | `apiKey` | cookie `zenith` | — | | Option 3 | `TokenCookieAuth` | `apiKey` | cookie `keycloak_token` | — | ## Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `project_id` | `string` | Yes | The Neon project ID | ## Request body Required. Media type: `application/json` ### Example request body ```json { "annotation_value": { "github-commit-ref": "github-branch-name" }, "branch_create": { "branch": { "archived": true, "expires_at": "2025-06-09T18:02:16Z", "init_source": "parent-data", "name": "string", "parent_id": "string", "parent_lsn": "string", "parent_timestamp": "2024-02-26T12:00:00Z", "protected": false }, "endpoints": [ { "autoscaling_limit_max_cu": 0, "autoscaling_limit_min_cu": 0, "provisioner": "k8s-neonvm", "settings": { "pg_settings": { "additionalProp1": "string" }, "pgbouncer_settings": { "additionalProp1": "string" }, "preload_libraries": { "enabled_libraries": [ "string" ], "use_defaults": true } }, "suspend_timeout_seconds": 0, "type": "read_only" } ] }, "masking_rules": [ { "column_name": "email", "database_name": "neondb", "masking_function": "anon.fake_email()", "schema_name": "public", "table_name": "users" } ], "start_anonymization": false } ``` ## Responses | Status | Description | Media type | | --- | --- | --- | | `201` | Created a branch. An endpoint is only created if it was specified in the request. | `application/json` | | `default` | General 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` | ### Example response: 201 — Created a branch. An endpoint is only created if it was specified in the request. ```json { "branch": { "active_time_seconds": 922200, "compute_time_seconds": 823880990, "cpu_used_sec": 461100, "created_at": "2022-11-30T19:09:48Z", "creation_source": "console", "current_state": "ready", "data_transfer_bytes": 72911987, "default": true, "id": "br-wispy-meadow-118737", "init_source": "parent-data", "name": "dev2", "parent_id": "br-aged-salad-637688", "parent_lsn": "0/1DE2850", "project_id": "spring-example-302709", "protected": false, "state_changed_at": "2022-11-30T20:09:48Z", "updated_at": "2022-12-01T19:53:05Z", "written_data_bytes": 542998300 }, "connection_uris": [ { "connection_parameters": { "database": "string", "host": "string", "password": "", "pooler_host": "string", "role": "string" }, "connection_uri": "string" } ], "databases": [ { "branch_id": "br-wispy-meadow-118737", "created_at": "2022-11-30T18:25:15Z", "id": 834686, "name": "neondb", "owner_name": "casey", "updated_at": "2022-11-30T18:25:15Z" } ], "endpoints": [ { "autoscaling_limit_max_cu": 1, "autoscaling_limit_min_cu": 1, "branch_id": "br-wispy-meadow-118737", "created_at": "2022-12-03T15:37:07Z", "creation_source": "console", "current_state": "init", "disabled": false, "host": "ep-silent-smoke-806639.us-east-2.aws.neon.tech", "id": "ep-silent-smoke-806639", "name": "My cool compute", "passwordless_access": true, "pending_state": "active", "pooler_enabled": false, "pooler_mode": "transaction", "project_id": "spring-example-302709", "provisioner": "k8s-neonvm", "proxy_host": "us-east-2.aws.neon.tech", "region_id": "aws-us-east-2", "settings": { "pg_settings": {} }, "suspend_timeout_seconds": 0, "type": "read_write", "updated_at": "2022-12-03T15:37:07Z" } ], "operations": [ { "action": "start_compute", "branch_id": "br-wispy-meadow-118737", "created_at": "2022-11-15T20:02:00Z", "endpoint_id": "ep-silent-smoke-806639", "failures_count": 0, "id": "d8ac46eb-a757-42b1-9907-f78322ee394e", "project_id": "spring-example-302709", "status": "finished", "total_duration_ms": 200, "updated_at": "2022-11-15T20:02:02Z" } ], "roles": [ { "branch_id": "br-wispy-meadow-118737", "created_at": "2022-11-23T17:42:25Z", "name": "casey", "protected": false, "updated_at": "2022-11-23T17:42:25Z" } ] } ``` ### Example response: default — General 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. ```json { "code": "", "message": "string", "request_id": "string" } ``` ## Related pages - [Accept a project transfer request](./acceptprojecttransferrequest.md) - [Add an OAuth provider](./addneonauthoauthprovider.md) - [Add an OAuth provider](./addbranchneonauthoauthprovider.md) - [Add domain to redirect_uri whitelist](./addbranchneonauthtrusteddomain.md) - [Add JWKS URL](./addprojectjwks.md) - [Add trusted redirect URI domain](./addneonauthdomaintoredirecturiwhitelist.md) - [AI Gateway](./tags/ai-gateway.md) - [API Key](./tags/api-key.md) - [Assign or update VPC endpoint](./assignorganizationvpcendpoint.md) - [Auth](./tags/auth.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.