1. Home
  2. Docs
  3. Philter
  4. Getting Started

Getting Started

Launch Filter

Launch Filter via the AWS Marketplace or the Microsoft Azure Marketplace. Note that EC2 instances and Azure VMs launched from the marketplaces are not immediately usable in a HIPAA-controlled environment. For example, when launched from one of the marketplaces, the underlying VM is not configured for full-disk encryption. Refer to your compliance officer for your organization’s requirements to satisfy all relevant regulations.

Interact with Filter

To begin, you can access Philter’s REST 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.

Ports

Philter’s REST API, by default, listens on port 8080. This port can be changed in Philter’s Configuration.

Removing PHI

We can send text to filter to Philter 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 JSON response containing the filtered text. (You can switch between JSON and plain text responses in Philter’s configuration.) Replace localhost with the IP address or hostname of Philter if needed.

You can also send the text directly in the request:

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

Detecting PHI

If you just want to detect PHI and not modify the text, the command is:

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

Like the previous command, this command sends the contents of the file file.txt to Philter. However, with this command Philter only analyzes the text for PHI and returns a numeric response. The numeric response will have a minimum value of zero. The higher the value the more likely the text contains PHI. Replace localhost with the IP address or hostname of Philter if needed.

You can also send the text directly in the request:

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

API Clients

The following Philter API clients are available:

Was this article helpful to you? Yes No

How can we help?