API

The API is how filter profiles can be added, retrieved, and deleted. Additionally, the API provides a status endpoint for monitoring the service’s health.

Listing the Available Filter Profiles

This endpoint will return a list of available filter profiles.

Endpoint HTTP Method Parameters Example
/api/profiles GET None curl -k https://localhost:8080/api/profiles

Get a Filter Profile

This endpoint will retrieve and return the JSON content of the filter profile.

Endpoint HTTP Method Parameters Example
/api/profiles/{filterProfileName} GET None curl -k https://localhost:8080/api/profiles/exprofile

Upload a Filter Profile

This endpoint will save or overwrite an existing filter profile with the given name. The body of the request should be the JSON filter profile. Note that the name of the JSON file must match the value of the name property inside the profile. The endpoint will respond with HTTP OK upon success.

Endpoint HTTP Method Parameters Example
/api/profiles PUT None curl -k https://localhost:8080/api/profiles -d @profile.json

Delete a Filter Profile

This endpoint will delete a filter profile. The endpoint will respond with HTTP OK upon success.

Endpoint HTTP Method Parameters Example
/api/profiles/{filterProfileName} DELETE None curl -k https://localhost:8080/api/profiles/exprofile

Get the Status

This endpoint is ideal for monitoring the status of the Filter Profile Registry. The response will either be HTTP 200 OK for healthy or or HTTP 503 Service Unavailable for unhealthy. Included in the JSON response will be a count of currently stored filter profiles.

Endpoint HTTP Method Parameters Example
/api/status GET None curl -k https://localhost:8080/api/status
Was this article helpful to you? Yes No

How can we help?