← Cloudflare Ruleset Engine / ruleset-engine / rulesets-api

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

Для некоторых операций можно использовать специальные конечные точки Rulesets API, предназначенные для управления наборами правил точек входа фаз. Такие конечные точки включают в путь имя фазы вместо идентификатора набора правил.

Например, вместо использования следующей конечной точки:

PUT /zones/{zone_id}/rulesets/{ruleset_id}

Вы можете использовать следующую конечную точку:

PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint

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

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

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

Сведения о конечных точках и пагинации см. в Начало работы: конечные точки.

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

Список и просмотр наборов правил

Операция	Метод	Примечания
Список существующих наборов правил	`GET`	Возвращает список существующих наборов правил на уровне аккаунта или на уровне зоны.
Просмотреть конкретный набор правил	`GET`	Возвращает свойства последней версии указанного набора правил.
Получить список всех версий набора правил	`GET`	Возвращает список всех версий набора правил.
Просмотр определённой версии набора правил	`GET`	Возвращает конфигурацию указанной версии набора правил, включая её правила.
Получить список правил управляемого набора правил с определённым тегом	`GET`	Возвращает список всех правил управляемого набора правил с указанным тегом.

Создание наборов правил

Операция	Метод	Примечания
Создание набора правил	`POST`	Создает новый набор правил или новую точку входа фазы.

Обновление и развертывание наборов правил

Операция	Метод	Примечания
Обновление или развертывание набора правил	`PUT`	Обновляет основные свойства набора правил и список правил в нем. Позволяет настроить выполнение управляемых наборов правил.
Добавление правила в набор правил	`POST`	Добавляет одно правило в существующий набор правил. Позволяет добавить одно правило, не указывая в запросе все остальные правила набора.
Обновление правила в наборе правил	`PATCH`	Обновляет определение одного правила в наборе правил. Позволяет изменить порядок правила в наборе правил.
Удалите правило в наборе правил	`DELETE`	Удаляет одно правило в наборе правил.

Удалить наборы правил

Операция	Метод	Примечания
Удаление набора правил	`DELETE`	Удаляет все версии набора правил.
Удаление версии набора правил	`DELETE`	Удаляет определённую версию набора правил.