list_list

This displays Local and Shared Lists.

See Also

Parameters:

Argument

Required

Type

Description

type

no

string

Enter local to view Local Lists

Enter shared to view Shared Lists.

No entry displays all Lists

detailed

no

boolean

This is a Boolean option that if set to true, yes, or 1 will display the detailed information.  Any other input will default to false.

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.

Example

servername/webadmin/api/list_list.php?

Output no detailed:

OK:

list=>System Deny List

list=>Filter Bypass List

locallist=>Allowlistonly:Allowlistonly_default

list=>Selective Decryption

list=>listname1

list=> listname2

 

Output with detail:

OK:

type=>shared

listid=>23

name=>System Deny List

edited=>0000-00-00 00:00:00

restrictions=>D

categories=>

type_restrictions=>

part_restrictions=>

comment=>Former System Deny List saved at upgrade

Netsweeper Version: 6.1.2