list_entry_list

listname

yes

string

Enter the List name

type

no

string

Enter the type as a letter:

U = URL

S = Scheme

P = Path

Q = Query

K = Keyword

k = Multiple Keywords

W = Whole Word

w = Multiple Words

E = File Extension

R = Regular Expression

N = Default Action

T = Event Name

action

no

string

Enter the action as a letter:

A = Allow URL

D = Deny URL

C = Assign Category

T = Replace

Q = Edit URL Query

S = Search and Replace

R = Regular Expression

H = Add Request Header

L = Proceed to List

part

no

string

Enter the Part as a letter:

U = Request URL

P = Protocol and Server IP

S = Client IP

A = User Agent Header

R = Referrer Header

T = Policy Event Type

D = Policy Event Data

args

no

string

This is based on the Action used.

See List Action Argument Options

detailed

no

string

Use this to display additional details.

search

no

string

Use to search the listing for a specific string

page

no

string

The page to display if a per_page argument is provided

per_page

no

string

The number of listed entries to display per page

format

no

string

The format of the output for the API: text, json or xml. The default is text.

callback

no

string

This only works with Direct APIs. This is a JavaScript function that should be called after the API is completed. This function will be called with the response of the API.  Please note: It can only be used when requesting this API via AJAX request. More Information can be found here.