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

Конечные точки Lists API

Чтобы вызвать Lists API операцию и добавьте эндпойнт к базовому URL-адресу API Cloudflare:

https://api.cloudflare.com/client/v4/

Инструкции по аутентификации см. в Начало работы страницу.

Справку по выполнению вызовов API и постраничному выводу результатов см. в Выполняйте вызовы API.

Lists API поддерживает операции, перечисленные ниже. Примеры см. по соответствующим ссылкам.

• Операция: Создайте список
• Метод и конечная точка: POST accounts/{account_id}/rules/lists
• Примечания: Создаёт пустой список.

• Операция: Получить списки
• Метод и конечная точка: GET accounts/{account_id}/rules/lists
• Примечания:
  • Получает все списки для аккаунта.
  • Этот запрос не получает элементы списков.

• Операция: Получить список
• Метод и конечная точка: GET accounts/{account_id}/rules/lists/{list_id}
• Примечания:
  • Получает список по его ID.
  • Этот запрос не отображает элементы списка.

• Операция: Обновление списка
• Метод и конечная точка: PUT accounts/{account_id}/rules/lists/{list_id}
• Примечания:
  • Обновляет description списка.
  • Нельзя изменить name или kind, и вы не можете обновлять элементы в списке. Чтобы обновить элемент в списке, используйте Обновление всех элементов списка операцию.

• Операция: Удаление списка
• Метод и конечная точка: DELETE accounts/{account_id}/rules/lists/{list_id}
• Примечания: Удаляет список, но только если ни одно фильтры ссылаться на него.

Почти все операции управления элементами списка выполняются асинхронно. При добавлении или удалении большого количества элементов списка может возникнуть задержка перед завершением массовой операции.

Асинхронные операции со списками возвращают operation_id, который можно использовать для отслеживания статуса операции API. Для отслеживания статуса асинхронной операции используйте Получение статуса массовой операции конечную точку и укажите ID операции, которую нужно отслеживать.

Если вы отправляете запросы к списку, пока над ним выполняется массовая операция, эти запросы ставятся в очередь и обрабатываются последовательно (в порядке поступления). Запросы для успешных асинхронных операций возвращают HTTP 201 код состояния.

• Операция: Получить элементы списка
• Метод и конечная точка: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
• Примечания:
  • Получает элементы списка (по умолчанию, все элементы).
  • Элементы отсортированы по возрастанию.
  • В списках IP-адресов записи CIDR сортируются сначала по IP-адресу, а затем по маске подсети.
  • Чтобы отфильтровать возвращаемые элементы, используйте необязательный search параметр строки запроса. Дополнительную информацию см. в разделе Получить элементы списка операция API.

• Операция: Получить элемент списка
• Метод и конечная точка: GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
• Примечания: Получает элемент из списка по ID

• Операция: Создание элементов списка
• Метод и конечная точка: POST accounts/{account_id}/rules/lists/{list_id}/items
• Примечания:
  • Добавляет новый элемент или элементы в список.
  • Заменяет записи, которые уже существуют в списке, и не удаляет никакие элементы.
  • Перезаписывает comment исходного элемента.
  • Ответ включает operation_id.

• Операция: Обновление всех элементов списка
• Метод и конечная точка: PUT accounts/{account_id}/rules/lists/{list_id}/items
• Примечания:
  • Удаляет все текущие элементы списка и заменяет их items.
  • Когда items пусто, удаляет all элементов в списке.
  • Ответ включает operation_id.

• Операция: Удаление элементов списка
• Метод и конечная точка: DELETE accounts/{account_id}/rules/lists/{list_id}/items
• Примечания:
  • Удаляет указанные элементы списка.
  • Ответ включает operation_id.