← Документация WAF / tools / lists / lists-api

Объект списка в формате JSON

Структура и свойства объекта списка

JSON-ответ для Lists API имеет такую структуру:

{
	"id": "2c0fc9fa937b11eaa1b71c4d701ab86e",
	"name": "my_list_name",
	"description": "List description.",
	"kind": "(ip|hostname|asn|redirect)",
	"num_items": 10,
	"num_referencing_filters": 2,
	"created_on": "2021-01-01T08:00:00Z",
	"modified_on": "2021-01-10T14:00:00Z"
}

В этой таблице приведена сводка свойств объекта:

Свойство	Описание	Ограничения
`id` `String`	Идентификатор UUIDv4, сгенерированный Cloudflare.	Уникальное значение, только чтение. Длина: 32 символа.
`name` `String`	Информативное название списка.	Максимальная длина: 50 символов. Разрешены только буквы, цифры и символ подчёркивания (`_`) являются допустимыми символами. Допустимое имя соответствует следующему регулярному выражению: `^[a-zA-Z0-9_]+$`.
`description` `String`	Информативное описание списка.	Максимальная длина: 500 символов.
`kind` `String`	Тип данных в списке.	Допустимые значения: `ip`, `hostname`, `asn`, `redirect`.
`num_items` `Number`	Количество элементов в списке.	Только чтение.
`num_referencing_filters` `Number`	Количество фильтров, ссылающихся на этот список.	Только чтение.
`created_on` `String`	RFC 3339 временная метка создания списка.	Только чтение.
`modified_on` `String`	RFC 3339 временная метка последнего изменения списка.	Только чтение.

Структура и свойства объекта элемента списка

Списки каждого типа (IP-адрес, имя хоста, ASN, редиректы) могут содержать элементы только одного типа.

IP-адрес

Полностью заполненный JSON-объект для элемента списка IP-адресов имеет следующую структуру:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"ip": "10.0.0.1/32",
	"comment": "CF DNS server",
	"created_on": "2021-10-01T05:20:00.12345Z",
	"modified_on": "2021-10-01T05:20:00.12345Z"
}

Имя хоста

Полностью заполненный JSON-объект для элемента списка имён хостов имеет следующую структуру:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"hostname": {
		"url_hostname": "*.example.com"
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

ASN

Полностью заполненный JSON-объект для элемента списка ASN имеет следующую структуру:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"asn": 13335,
	"comment": "My provider's ASN",
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

URL redirect

Полностью заполненный JSON-объект для элемента Bulk Redirect List имеет следующую структуру:

{
	"id": "7c5dae5552338874e5053f2534d2767a",
	"redirect": {
		"source_url": "https://example.com/blog",
		"target_url": "https://example.com/blog/latest",
		"status_code": 301,
		"include_subdomains": false,
		"subpath_matching": false,
		"preserve_query_string": false,
		"preserve_path_suffix": true
	},
	"created_on": "2021-10-11T12:39:02Z",
	"modified_on": "2021-10-11T12:39:02Z"
}

Справочник свойств

Свойства JSON объекта для элемента списка определены следующим образом:

Свойство	Описание	Ограничения
`id` `String`	Идентификатор UUIDv4, сгенерированный Cloudflare.	Уникальное значение, только чтение. Длина: 32 символа.
`ip` `String`	IP-адрес или диапазон CIDR.	Применяется только к пользовательским спискам с IP-адресами (IP lists). Любой из этих форматов может присутствовать в одном пользовательском списке вместе с IP-адресами: Адрес IPv4 Адрес IPv6 Диапазоны IPv4 в виде `/8` через `/32` CIDR Диапазоны IPv6 в виде `/12` через `/128` CIDR
`comment` `String`	Информативное описание элемента.	Максимальная длина: 500 символов.
`redirect` `Object`	Объект, содержащий определение перенаправления URL. См. Параметры URL redirect для получения подробностей.	Применяется только к Bulk Redirect Lists.
`hostname` `Object`	Объект, содержащий `url_hostname` свойство со значением имени хоста. См. Списки с именами хостов подробнее о поддерживаемых значениях hostname.	Применяется только к пользовательским спискам с именами хостов.
`asn` `Integer`	Значение ASN.	Применяется только к пользовательским спискам с ASN.
`created_on` `String`	RFC 3339 временная метка создания списка.	Только чтение.
`modified_on` `String`	RFC 3339 временная метка последнего изменения элемента.	Только чтение.

Подробную спецификацию см. в Lists API документация.