TrapDefense Docs
Lifecycle

API Lifecycle

Current versioning and known limits for the API as it exists today.

API Reference Preset Catalog PII Profiles
Current versioning and known limits for the API as it exists today.

Current Version

ItemValue
API versionv1
Service version0.1.0
Base URLhttps://trapdefense.com/api/v1

Versioning Policy

  • The API version is part of the URL path: /v1/scan, /v1/decide, /v1/redact
  • Breaking changes ship in a new version such as /v2/
  • Non-breaking additions such as new fields, new patterns, new presets, or new PII profiles may land within the current version

Non-breaking examples

  • New detection patterns
  • New policy presets
  • New PII profiles
  • Additional response fields

Breaking examples

  • Removing an existing field
  • Changing a field type
  • Renaming pattern IDs
  • Changing the response structure
  • Replacing the authentication scheme

Changelog

v1 / 0.1.0 (2026-04-06)

Initial API release:

  • 3 endpoints: /v1/scan, /v1/decide, /v1/redact
  • 32 detection patterns
  • 17 policy presets
  • 17 PII profiles
  • Bearer token authentication
  • shadow, warn, and enforce modes

Current Limits

ItemValue
Request size256 KB (nginx limit)

Known Limitations

AreaNotes
Pattern detectionRegex-based and strongest on known, explicit patterns
PII detectionFormat-based; broad numeric formats can still collide with non-PII values
Policy evaluationStateless; each request is evaluated independently
File and binary contentText-only
Language coverageStrongest for English and Korean patterns today
Overlapping PII formatsSome numeric formats can overlap; explicit pii_profiles reduce noise

Health Check

curl https://trapdefense.com/api/health

A healthy service returns {"ok": true}.

Support