Get redaction config

Fetch Redaction Config

curl --request GET \
  --url https://api.operata.io/v1/config/REDACTION_CONFIG/json \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v1/config/REDACTION_CONFIG/json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/config/REDACTION_CONFIG/json"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/config/REDACTION_CONFIG/json"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

"{\n    \"key\": \"REDACTION_CONFIG\",\n    \"value\": {\n        \"type\": \"BLACKLIST\",\n        \"fields\": [\n            \"Agent.ARN\",\n            \"Agent.RoutingProfile\"\n        ]\n    }\n}"

"REDACTION_CONFIG not found"

GET

config

REDACTION_CONFIG

json

Fetch Redaction Config

curl --request GET \
  --url https://api.operata.io/v1/config/REDACTION_CONFIG/json \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v1/config/REDACTION_CONFIG/json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/config/REDACTION_CONFIG/json"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/config/REDACTION_CONFIG/json"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

"{\n    \"key\": \"REDACTION_CONFIG\",\n    \"value\": {\n        \"type\": \"BLACKLIST\",\n        \"fields\": [\n            \"Agent.ARN\",\n            \"Agent.RoutingProfile\"\n        ]\n    }\n}"

"REDACTION_CONFIG not found"

Fetches the redaction config currently in effect for your Operata account, as a single JSON document. Use it to confirm the active allow-list or deny-list before you replace or remove it. If no config exists, the endpoint returns 404 and the Cloud Collector falls back to the privacy-first default — it ships only the mandatory CTR fields.

Endpoint

GET https://api.operata.io/v1/config/REDACTION_CONFIG/json

Parameters

This endpoint takes no parameters. Credentials on the request determine the Operata account scope.

Response

200 OK with the active redaction config.

{
  "key": "REDACTION_CONFIG",
  "value": {
    "type": "BLACKLIST",
    "fields": [
      "Agent.ARN",
      "Agent.RoutingProfile"
    ]
  }
}

Field	Type	Description
`key`	string	Always `REDACTION_CONFIG`. Identifies the config record.
`value`	object	The redaction config body.
`value.type`	string	`WHITELIST` for an allow-list, `BLACKLIST` for a deny-list. One config per account; the two modes are mutually exclusive.
`value.fields`	array of string	The CTR field paths to include (allow-list) or exclude (deny-list). Dot notation matches the CTR data model — see Contact trace records.

Example

curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v1/config/REDACTION_CONFIG/json"

const groupId = process.env.OPERATA_GROUP_ID;
const apiToken = process.env.OPERATA_API_TOKEN;
const auth = Buffer.from(`${groupId}:${apiToken}`).toString("base64");

const response = await fetch(
  "https://api.operata.io/v1/config/REDACTION_CONFIG/json",
  { headers: { Authorization: `Basic ${auth}` } },
);
const config = await response.json();

import os, requests

response = requests.get(
    "https://api.operata.io/v1/config/REDACTION_CONFIG/json",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
)
response.raise_for_status()
config = response.json()

Errors

Status	Code	When	Recover
404	`not_found`	No redaction config exists for this Operata account. The Cloud Collector falls back to the privacy-first default.	Create a config with Update redaction config if you want to override the default.

See Errors for shared codes such as 401 unauthorized, 429 rate_limited, and the 5xx family.

Data redaction — what redaction does and how the three endpoints fit together.
Update redaction config — replace the active config.
Delete redaction config — remove the config and revert to the default.
Errors — shared status codes and recovery patterns.
Rate limits — per-token request budget.
Idempotency — GET is idempotent; retry without coordination.
Versioning — this endpoint lives under /v1.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200

key

string

Example:

"REDACTION_CONFIG"

value

object

Show child attributes

Data redaction

Update redaction config

Overview & quickstart

API essentials

Endpoints — Contacts

Endpoints — Logs

Endpoints — Users

Endpoints — Data redaction

Events & webhooks

Streaming & backends

AI & MCP

Endpoint

Parameters

Response

Example

Errors

Authorizations

Response

​Endpoint

​Parameters

​Response

​Example

​Errors

​Related

Authorizations

Response

Endpoint

Parameters

Response

Example

Errors

Related