Philter Profile Registry

The Philter Profile Registry is a free companion application for Philter that provides a centralized service for managing and storing filter profiles. A filter profile is a configuration that specifies the types of PII and PHI to find and how to manipulate it.


How Philter identifies and replaces sensitive protected health information (PHI) and personally identifiable information (PII) is defined by filter profiles. The Philter Profile Registry provides a centralized service for storing and managing filter profiles. Through its REST API, filter profiles can be listed, added, retrieved, and deleted. Filter profiles can be stored on the local disk or in an Amazon S3 bucket.

The Philter Profile Registry is useful when you have different types of documents for which you want to handle the PII and PHI differently in each type. By utilizing the Philter Profile Registry, you can store the filter profiles externally from Philter to enable their use across many instances of Philter.

See the Philter Profile Registry User’s Guide for examples on how to use the Philter Profile Registry.

Launch Philter Profile Registry

View on DockerHub or pull and run the Philter Profile Registry using the commands below.

docker pull mtnfog/philter-profile-registry
docker run --name fpr -p 8080:8080 mtnfog/philter-profile-registry

Quick Usage Reference

  • List filter profiles: curl -k -s https://localhost:8080/api/profiles
  • Upload a filter profile: curl -k https://localhost:8080/api/profiles -d @profile.json -H "Content-Type: application/json"
  • Get a filter profile by name: curl -k -s https://localhost:8080/api/profiles/{profilename}
  • Delete a filter profile: curl -k -s -X DELETE https://localhost:8080/api/profiles/{profilename}
  • Get status: curl -k -s https://localhost:8080/api/status

A filter profile JSON schema is available to assist with creating and editing filter profiles.