Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Gateway
Lists

List Zero Trust lists

GET/accounts/{account_id}/gateway/lists

Fetch all Zero Trust lists for an account.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Path ParametersExpand Collapse
account_id: string

Specify the Cloudflare account identifier.

Query ParametersExpand Collapse
direction: optional "asc" or "desc"

Sort direction. Applies to the field named in order_by; when order_by is omitted it applies to the default created_at ordering. When direction is omitted the default is field-specific: explicitly choosing created_at or updated_at defaults to descending (newest first); name and item_count default to ascending; and the default created_at ordering used when order_by is omitted is ascending (for backwards compatibility).

  • asc — ascending.
  • desc — descending.
One of the following:
"asc"
"desc"
filter: optional array of string

Filter the returned lists by one or more field:value pairs. Repeat the parameter to apply multiple filters; they are combined with logical AND (a list must satisfy every filter to be returned).

Supported fields and their matching behaviour:

  • name — case-insensitive substring match on the list name.
  • id — substring match on the list ID (UUID), with or without dashes.
  • type — exact match on the list type. Supersedes the legacy type query parameter when both are supplied. Must be one of the valid type values.
  • item_count — exact integer match on the number of items in the list.

Each entry must match one of the per-field patterns below: the field must be one of name, id, type, or item_count; name/id accept any value, type is restricted to the valid list type values, and item_count must be a non-negative integer.

order_by: optional "name" or "created_at" or "updated_at" or "item_count"

Field to sort the returned lists by. When omitted, results are ordered by created_at in ascending order (i.e. creation order) for backwards compatibility. Supported values:

  • name — sort alphabetically by list name.
  • created_at — sort by creation time; defaults to descending unless direction is set.
  • updated_at — sort by last-modified time; defaults to descending unless direction is set.
  • item_count — sort by number of items in the list.
One of the following:
"name"
"created_at"
"updated_at"
"item_count"
type: optional "SERIAL" or "URL" or "DOMAIN" or 6 more

Specify the list type.

One of the following:
"SERIAL"
"URL"
"DOMAIN"
"EMAIL"
"IP"
"CATEGORY"
"LOCATION"
"DEVICE"
"AAGUID"
ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of ResponseInfo { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Indicate whether the API call was successful.

result: optional array of GatewayList { id, count, created_at, 5 more }
id: optional string

Identify the API resource with a UUID.

maxLength36
count: optional number

Indicate the number of items in the list.

created_at: optional string
formatdate-time
description: optional string

Provide the list description.

items: optional array of GatewayItem { created_at, description, value }

Provide the list items.

created_at: optional string
formatdate-time
description: optional string

Provide the list item description (optional).

minimum0
value: optional string

Specify the item value.

name: optional string

Specify the list name.

type: optional "SERIAL" or "URL" or "DOMAIN" or 6 more

Specify the list type.

One of the following:
"SERIAL"
"URL"
"DOMAIN"
"EMAIL"
"IP"
"CATEGORY"
"LOCATION"
"DEVICE"
"AAGUID"
updated_at: optional string
formatdate-time
result_info: optional object { count, page, per_page, total_count }
count: optional number

Indicate the total number of results for the requested service.

page: optional number

Indicate the current page within a paginated list of results.

per_page: optional number

Indicate the number of results per page.

total_count: optional number

Indicate the total results available without any search parameters.

List Zero Trust lists

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/gateway/lists \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "count": 20,
      "created_at": "2014-01-01T05:20:00.12345Z",
      "description": "The serial numbers for administrators",
      "items": [
        {
          "created_at": "2014-01-01T05:20:00.12345Z",
          "description": "Austin office IP",
          "value": "8GE8721REF"
        }
      ],
      "name": "Admin Serial Numbers",
      "type": "SERIAL",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "count": 20,
      "created_at": "2014-01-01T05:20:00.12345Z",
      "description": "The serial numbers for administrators",
      "items": [
        {
          "created_at": "2014-01-01T05:20:00.12345Z",
          "description": "Austin office IP",
          "value": "8GE8721REF"
        }
      ],
      "name": "Admin Serial Numbers",
      "type": "SERIAL",
      "updated_at": "2014-01-01T05:20:00.12345Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}