Sign in
Branch

Retrieve anonymized branch status

Retrieves the current status of an anonymized branch, including its state and progress information. This endpoint allows you to monitor the anonymization process from initialization through completion. Only anonymized branches will have status information available.

Note: This endpoint is currently in Beta.

get/projects/{project_id}/branches/{branch_id}/anonymized_status

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/anonymized_status
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Anonymized branch status retrieved successfully

project_idstring required

The ID of the project this branch belongs to.

branch_idstring required

The ID of the anonymized branch.

statestring required

The current state of the anonymized branch. created: branch record exists but setup has not started. initialized: setup is complete and the branch is ready for anonymization. initialization_error: an error occurred during setup. anonymizing: the anonymization process is currently running. anonymized: anonymization completed successfully. error: an error occurred during anonymization.

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
  }
}

Changes

No recorded changes to this operation across all 15 revisions of this API.