Filter Profiles API

The Filter Profiles API provides endpoints for retrieving, uploading, and deleting filter profiles.

The curl example commands shown on this page are written assuming Philter has been enabled for SSL. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the SSL/TLS settings for more information.

Get Filter Profile Names

GET http://philter:8080/api/profiles
This method retrieves the names of all available filter profiles. There are no request parameters.
Parameters None
Responses 200 – The response is a list of filter profile names.
Example Request: curl -k https://localhost:8080/api/profiles

Get the Content of a Filter Profile

GET http://philter:8080/api/profiles/{filterProfileName}
This method retrieves the names of all available filter profiles. There are no request parameters.
Parameters filterProfileName – string – The name of a filter profile.
Responses 200 – The response is the content of the filter profile.
404 – The filter profile does not exist.
Example Request: curl -k https://localhost:8080/api/profiles/my-profile

Upload a Filter Profile

PUT http://philter:8080/api/profiles
This method uploads a filter profile to Philter. The filter profile will be created on disk under Philter’s directory for storing filter profiles. If a filter profile with the given name already exists, its content will be overwritten by the uploaded filter profile.
Headers Content-Type – string – The value should be set to application/json.
Parameters None
Body The body of the request should be the content of the filter profile.
Responses 201 – The filter profile was uploaded successfully.
Example Request: curl -k https://localhost:8080/api/profiles -d @profile.json

Delete a Filter Profile

DELETE http://philter:8080/api/profiles/{filterProfileName}
This method retrieves the names of all available filter profiles. There are no request parameters.
Parameters filterProfileName – string – The name of a filter profile.
Responses 200 – The filter profile was deleted successfully.
404 – The filter profile does not exist.
500 – The filter profile could not be deleted. Check Philter’s log for more information.
Example Request: curl -k -X DELETE https://localhost:8080/api/profiles/my-profile