Custom Lists API

The Custom Lists API provides endpoints for retrieving, creating, and deleting custom lists.

The curl example commands shown on this page are written assuming Philter has been enabled for SSL, and it is using a self-signed certificate. 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 List Names

Method	Endpoint	Description
GET	/api/lists	Get the names of all custom lists.

Example request:

curl -k -H "Authorization: Bearer <token>" https://localhost:8080/api/lists

Get a List

Method	Endpoint	Description
GET	/api/lists/{name}	Get the content of a list, where {name} is the name of the list to get.

Example request:

curl -k -H "Authorization: Bearer <token>" https://localhost:8080/api/lists/my-list

Example response:

{
  "items": [
    "item1",
    "item2"
  ]
}

Create or Update a List

Method	Endpoint	Description
POST	/api/lists/{name}	Create or update a custom list.

Query Parameters

• description (optional) - A description of the custom list.

Request Body

A JSON array of strings containing the items for the list.

Example request:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <token>" -k "https://localhost:8080/api/lists/my-list?description=My%20description" -d '["item1", "item2"]'

Delete a List

Method	Endpoint	Description
DELETE	/api/lists/{name}	Delete a custom list, where {name} is the name of the list to delete.

Example request:

curl -X DELETE -k -H "Authorization: Bearer <token>" https://localhost:8080/api/lists/my-list