Retrieve anonymized branch status

GET/projects/{project_id}/branches/{branch_id}/anonymized_statusRetrieve 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.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The branch ID

pattern ^[a-z0-9-]{1,60}$

Responses

objectAnonymizedBranchStatusResponse

branch_idstringrequired

The ID of the anonymized branch.

pattern ^[a-z0-9-]{1,60}$

created_atstring · date-timerequired

A timestamp indicating when the anonymized branch was created

failed_atstring · date-time

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

last_runobject

Metadata about the most recent anonymization attempt for the branch.

Show child attributes

completed_atstring · date-time

Timestamp indicating when the latest anonymization attempt completed. Populated even if the attempt failed.

masked_columnsinteger

Number of columns that had masking rules applied during the attempt.

started_atstring · date-time

Timestamp indicating when the latest anonymization attempt started.

triggered_bystring · uuid

UUID of the user who triggered the latest anonymization attempt.

triggered_by_usernamestring

Username of the user who triggered the latest anonymization attempt.

project_idstringrequired

The ID of the project this branch belongs to.

pattern ^[a-z0-9-]{1,60}$

statestringrequired

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

updated_atstring · date-timerequired

A timestamp indicating when the anonymized branch status was last updated

Example response

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

defaultGeneral 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

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/branches/string/anonymized_status");
using var response = await client.SendAsync(request);

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

{
  "code": "",
  "message": "string",
  "request_id": "string"
}