Create a list - Cloudflare

Creates a new list of the specified type.

Request

Path Params

account_identifier

string

required

Body Params application/json

description

string

optional

An informative summary of the list.

<= 500 characters

Example:

This is a note.

kind

enum<string>

required

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

Allowed values:

ipredirect

Example:

name

string

required

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

<= 50 characters

Example:

list1

Match pattern:

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

Example

{
    "description": "This is a note.",
    "kind": "ip",
    "name": "list1"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create a list response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

object (list)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "0": null,
        "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
    }
}

🟢200Create a list response failure