Get lists

Fetches all lists in the account.

application/json

Body

result

required

Any of

allOf {2}

array[object (list) {8}]

allOf {2}

One of

array[object (list) {8}]

object

created_on

string

components-schemas-created_on

optional

The RFC 3339 timestamp of when the list was created.

Example:

2020-01-01T08:00:00Z

description

string

lists_components-schemas-description

optional

An informative summary of the list.

<= 500 characters

Example:

This is a note.

string

list_id

read-onlyoptional

The unique ID of the list.

>= 32 characters<= 32 characters

Example:

2c0fc9fa937b11eaa1b71c4d701ab86e

kind

enum<string>

kind

optional

The type of the list. Each type supports specific list items (IP addresses or redirects).

Allowed values:

ipredirect

Example:

modified_on

string

lists_components-schemas-modified_on

optional

The RFC 3339 timestamp of when the list was last modified.

Example:

2020-01-10T14:00:00Z

name

string

lists_components-schemas-name

optional

An informative name for the list. Use this name in filter and rule expressions.

<= 50 characters

Example:

list1

Match pattern:

^[a-zA-Z0-9_]+$

num_items

number

num_items

optional

The number of items in the list.

Example:

num_referencing_filters

number

num_referencing_filters

optional

The number of filters referencing the list.

Example:

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created_on": "2020-01-01T08:00:00Z",
            "description": "This is a note.",
            "id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
            "kind": "ip",
            "modified_on": "2020-01-10T14:00:00Z",
            "name": "list1",
            "num_items": 10,
            "num_referencing_filters": 2
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses