Skip to content

Get Obfuscation

Retrieve a specific obfuscation by ID.

Endpoint

GET /api/obfuscations/:id

Retrieves a single obfuscation with its complete configuration including data types and filters.

Authentication

Requires any valid API Key. All keys have read access.

Path Parameters

Parameter Type Description
id UUID Obfuscation ID

Response

Returns the complete obfuscation object:

Response Format 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Mask PII",
  "description": "Obfuscate all PII data types",
  "datatypes": [
    {
      "type": "US_SSN",
      "maskFormatId": "FULLY_OBFUSCATED",
      "storeOriginalValue": true,
      "whitelist": ["000-00-0000"]
    }
  ],
  "filters": [
    {
      "type": "amount",
      "filterType": 1,
      "filterParentLevel": 0,
      "isWhitelist": false,
      "condition": {
        "numberCondition": {
          "operator": "greaterThan",
          "value": 10000.00
        }
      }
    }
  ],
  "createdAt": 1704067200,
  "updatedAt": 1704153600
}

Examples

Get Obfuscation by ID

Retrieve a specific obfuscation to view its configuration.

OBFUSCATION_ID="550e8400-e29b-41d4-a716-446655440000"

curl -X GET "https://your-shield-host:8080/api/obfuscations/$OBFUSCATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

BASE_URL = "https://your-shield-host:8080"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

obfuscation_id = "550e8400-e29b-41d4-a716-446655440000"

response = requests.get(f"{BASE_URL}/api/obfuscations/{obfuscation_id}", headers=HEADERS)
obf = response.json()

print(f"Obfuscation: {obf['name']}")
print(f"Data Types: {len(obf['datatypes'])}")
print(f"Filters: {len(obf['filters'])}")

const axios = require('axios');

const BASE_URL = 'https://your-shield-host:8080';
const HEADERS = { 'Authorization': 'Bearer YOUR_API_KEY' };

const obfuscationId = '550e8400-e29b-41d4-a716-446655440000';

const response = await axios.get(`${BASE_URL}/api/obfuscations/${obfuscationId}`, { headers: HEADERS });
const obf = response.data;

console.log(`Obfuscation: ${obf.name}`);
console.log(`Data Types: ${obf.datatypes.length}`);
console.log(`Filters: ${obf.filters.length}`);

Error Responses

Status Code Description
401 Invalid or expired API key
404 Obfuscation not found