Quick Start

Launch Filter

Launch Filter via the AWS Marketplace, Microsoft Azure Marketplace, or other cloud marketplace.

Cloud virtual machines launched from the cloud marketplaces may not be suitable for a HIPAA environment. Refer to your compliance officer for your organization’s requirements to ensure compliance with all relevant regulations.

Interact with Filter

Once Philter is running, you can interact with Philter’s API via the curl command. Philter, by default, will be configured with an HTTPS listener using a self-signed certificate. (It is recommended that prior to use in a production environment the self-signed certificate is replaced by a valid certificate owned by your organization.) See Philter’s full API for more details on the following commands.


Philter’s API, by default, listens on port 8080. (This port can be changed in Philter’s configuration.)

Identifying and Removing PHI from Text

The types of PHI that Philter identifies and removes is controlled by filter profiles. By default, Philter includes a filter profile that includes many of the types of PHI, such as names and social security numbers. We can send text to filter to Philter for PHI filtering using this default filter profile with the command:

curl -k -X POST https://localhost:8080/api/filter -d @file.txt -H Content-Type "plain/text"

This command sends the contents of the file file.txt to Philter. Philter will apply the enabled filters and return a plain-text response consisting of the filtered text. (Replace localhost with the IP address or hostname of Philter if you are not running the command on the Philter host.) You can also send text directly in the request instead of sending it as a file:

curl -k -X POST https://localhost:8080/api/filter --data "Your text goes here..." -H "Content-type: plain/text"

API Clients

Clients for some languages for Philter’s API are available on GitHub.

Was this article helpful to you? Yes No

How can we help?