Privacy Guard

Active
Total Scans
0
Total Findings
0
Blocked
0
Active Rules
0

Recent Scans

Timestamp Source Input Findings Blocked
No scans yet

Findings by Category

No data yet

Enable Privacy Guard

When enabled, all inputs will be scanned for PII

Category Controls

Scan Settings

Loading rules...

Global Style Override

Apply a single redaction style to all categories

Per-Category Redaction Styles

Category Style Custom Placeholder Keep First Keep Last Preview

Test Scanner

Drop a file here or

.txt, .md, .csv, .json, .docx, .xlsx, .pptx, .pdf

Original Text (highlighted findings)

Results will appear here...

Sanitized Output

Findings

Rule Category Severity Original Redacted Action
No findings yet
Timestamp Source Input Type Filename Findings Blocked Time (ms)
No audit entries yet

Agent API Reference

Agents can integrate with Privacy Guard via explicit API calls. All endpoints accept workspace_id as a query parameter.

Endpoints

Method Path Description
GET/healthHealth check
POST/api/agent/guardSanitize text input
POST/api/agent/guard/fileSanitize uploaded file
GET/api/agent/policiesGet workspace privacy policy
GET/api/agent/statusCheck if guard is active
GET/api/statsDashboard statistics
GET/api/scan-logScan audit history
GET/api/scan-log/{id}Detailed scan with findings

Sanitize Text

curl -X POST /api/agent/guard \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "YOUR_WORKSPACE_ID",
    "text": "My email is test@example.com and SSN is 123-45-6789"
  }'

Response

{
  "scan_id": "uuid",
  "original_length": 56,
  "sanitized_length": 48,
  "findings_count": 2,
  "blocked": false,
  "sanitized_text": "My email is [REDACTED] and SSN is [REDACTED]",
  "findings": [
    {
      "category": "contact_location",
      "rule_name": "Email Address",
      "severity": "high",
      "action_taken": "redact",
      "original_value": "test@example.com",
      "redacted_value": "[REDACTED]"
    }
  ]
}

Sanitize File Upload

curl -X POST /api/agent/guard/file \
  -F "file=@document.docx" \
  -F "workspace_id=YOUR_WORKSPACE_ID"

Authentication

The Agent API is currently open within the network. All requests require a workspace_id parameter to scope operations. Agent endpoints are designed for internal service-to-service communication on the same Docker network.