v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB

Branch

Start anonymization

Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state. This will apply all defined masking rules to anonymize sensitive data in the branch databases. The branch must be an anonymized branch to start anonymization.

Note: This endpoint is currently in Beta.

post/projects/{project_id}/branches/{branch_id}/anonymize

Response

Anonymization started successfully

project_idstring required

The ID of the project

branch_idstring required

The ID of the anonymized branch

statestring required

The current state of the anonymized branch. Possible values: created, initialized, initialization_error, anonymizing, anonymized, error

status_messagestring

A descriptive message about the current status or any errors

created_atstring date-time required

A timestamp indicating when the anonymized branch was created

updated_atstring date-time required

A timestamp indicating when the anonymized branch status was last updated

failed_atstring date-time

A timestamp indicating when the anonymized branch operation failed (if applicable)

Example response

{
  "branch_id": "br-aged-salad-637688",
  "project_id": "simple-truth-637688",
  "state": "anonymizing",
  "status_message": "Anonymizing table mydb.public.users (3/5)",
  "created_at": "2022-11-30T18:25:15Z",
  "updated_at": "2022-11-30T18:30:22Z",
  "last_run": {
    "started_at": "2022-11-30T18:25:15Z",
    "completed_at": "2022-11-30T18:30:22Z",
    "triggered_by": "df6c5f70-6cbf-4c8c-9e7a-74c3ddbd8f9f",
    "masked_columns": 12
  }
}