Patch Zero Trust List

PATCH

https://api.cloudflare.com/client/v4/accounts/{identifier}/gateway/lists/{uuid}

Last modified:2022-12-16 13:48:36

Append or remove an item from a configured Zero Trust List.

Request

Path Params

uuid

string

required

identifier

string

required

Body Params application/json

append

array [object {1}]

optional

The items in the List.

value

string

optional

The value of the item in a List.

Example:

8GE8721REF

remove

array[string]

optional

A list of the item values you want to remove.

Example

{
    "append": [
        {
            "value": "8GE8721REF"
        }
    ],
    "remove": [
        "8GE8721REF"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/accounts//gateway/lists/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "append": [
        {
            "value": "8GE8721REF"
        }
    ],
    "remove": [
        "8GE8721REF"
    ]
}'

Responses

🟢200Patch Zero Trust List response

application/json

Body

allOf {2}

optional

object (api-response-single)

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

object

optional

result

object (lists)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "count": 20,
        "created_at": "2014-01-01T05:20:00.12345Z",
        "description": "The serial numbers for administrators",
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        "name": "Admin Serial Numbers",
        "type": "SERIAL",
        "updated_at": "2014-01-01T05:20:00.12345Z"
    },
    "success": true
}

🟢200Patch Zero Trust List response failure

Modified at 2022-12-16 13:48:36

Zero Trust List Details

Update Zero Trust List