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

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

Чтобы вызвать Lists API (операция), добавьте конечную точку к базовому URL Cloudflare API:

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

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

Справку по выполнению вызовов 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, и вы не можете обновлять элементы списка. Чтобы обновить элемент списка, используйте Обновление всех элементов списка (операция API).

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

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

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

Если вы отправляете запросы к списку, пока над ним выполняется массовая операция, запросы ставятся в очередь и обрабатываются последовательно (первым пришёл — первым обработан). Запросы успешных асинхронных операций возвращают 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}
• Примечания: получает элемент списка по идентификатору

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

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

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