Документация API
Полный справочник REST API для автоматизации, интеграции и рабочих процессов инфраструктуры как кода. Программно управляйте всей вашей инфраструктурой доставки приложений.
Начните за минуты
Три простых шага для начала использования TR7 API
Аутентификация
Отправьте свои учётные данные на конечную точку входа, чтобы получить токен доступа
POST /api7/v0.1/loginВключите токен
Добавьте Bearer token в заголовок Authorization каждого запроса
Authorization: Bearer <token>Выполняйте запросы
Используйте стандартные HTTP-методы для управления вашей инфраструктурой
GET /api7/v0.1/lb/poolsОбзор по категориям
Просмотрите более 400 конечных точек, организованных в логические группы
Load Balancer
285 конечные точкиAccess Gateway
69 конечные точкиNetwork
32 конечные точкиGEO Traffic Manager
29 конечные точкиSettings
18 конечные точкиWeb Application Firewall
5 конечные точкиvDevice
3 конечные точкиUsers
3 конечные точкиИнтерактивный обозреватель API
Ищите, фильтруйте и находите правильные конечные точки для вашего случая использования
Выберите конечную точку для просмотра деталей
Создан для автоматизации
Интегрируйте TR7 в ваши существующие рабочие процессы и цепочки инструментов
Инфраструктура как код
Управляйте всей вашей конфигурацией как кодом. Экспортируйте, версионируйте и развёртывайте конфигурации программно.
Интеграция CI/CD
Автоматизируйте развёртывания в ваших конвейерах. Обновляйте конфигурации как часть вашего процесса выпуска.
Поддержка CLI
Каждая конечная точка API имеет соответствующую CLI-команду для управления через терминал и написания скриптов.
Совместимость с OpenAPI
Стандартный дизайн REST API следует соглашениям OpenAPI. Генерируйте клиентские библиотеки на любом языке.
Готовы к автоматизации?
Изучите полный справочник API или свяжитесь с нами для поддержки интеграции
Справочник конечных точек REST API TR7
Полный список из 444 конечных точек REST API для контроллера доставки приложений TR7.
Create one firewall rule instance
Описание: Creates a new firewall rule (a security policy that controls inbound and outbound network traffic based on source/destination IPs, ports, and protocols, providing granular access control and network segmentation within route tables) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/fwRules
CLI-команда: network fw-rule add ?
Категория: network / fwRules
Просмотреть документациюUpdate one firewall rule instance
Описание: Performs a complete replacement of a specific firewall rule (a security policy that controls inbound and outbound network traffic based on source/destination IPs, ports, and protocols, providing granular access control and network segmentation within route tables) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/fwRules/[id]
CLI-команда: network fw-rule set ?
Категория: network / fwRules
Просмотреть документациюPartial update one firewall rule instance
Описание: Performs a selective update of a specific firewall rule (a security policy that controls inbound and outbound network traffic based on source/destination IPs, ports, and protocols, providing granular access control and network segmentation within route tables) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/fwRules/[id]
CLI-команда: network fw-rule update ?
Категория: network / fwRules
Просмотреть документациюCreate one route table instance
Описание: Creates a new route table (a per-tenant routing domain that isolates interfaces, IPs, routes, and policies for clarity and operational safety) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/namespaces
CLI-команда: network namespace add ?
Категория: network / namespaces
Просмотреть документациюUpdate one route table instance
Описание: Performs a complete replacement of a specific route table (a per-tenant routing domain that isolates interfaces, IPs, routes, and policies for clarity and operational safety) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/namespaces/[id]
CLI-команда: network namespace set ?
Категория: network / namespaces
Просмотреть документациюPartial update one route table instance
Описание: Performs a selective update of a specific route table (a per-tenant routing domain that isolates interfaces, IPs, routes, and policies for clarity and operational safety) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/namespaces/[id]
CLI-команда: network namespace update ?
Категория: network / namespaces
Просмотреть документациюUpdate one physical ethernet interface instance
Описание: Performs a complete replacement of a specific physical ethernet interface (a physical ethernet network card interface on the server; allows configuration of IP address, netmask, gateway, MTU, flow control, and other L2/L3 parameters; includes link status, speed/duplex settings, promiscuous mode, and NIC statistics monitoring features; used for direct physical network connectivity) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one physical ethernet interface instance
Описание: Performs a selective update of a specific physical ethernet interface (a physical ethernet network card interface on the server; allows configuration of IP address, netmask, gateway, MTU, flow control, and other L2/L3 parameters; includes link status, speed/duplex settings, promiscuous mode, and NIC statistics monitoring features; used for direct physical network connectivity) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one vlan virtual interface instance
Описание: Creates a new VLAN virtual interface (a virtual network interface created via VLAN tagging on a physical ethernet interface according to IEEE 802.1Q standard; sends and receives tagged traffic with specified VLAN ID; used for network segmentation, traffic isolation, and multi-L3 network configuration; requires parent physical interface and VLAN ID specification) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one VLAN virtual interface instance
Описание: Performs a complete replacement of a specific VLAN virtual interface (a virtual network interface created via VLAN tagging on a physical ethernet interface according to IEEE 802.1Q standard; sends and receives tagged traffic with specified VLAN ID; used for network segmentation, traffic isolation, and multi-L3 network configuration; requires parent physical interface and VLAN ID specification) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one VLAN virtual interface instance
Описание: Performs a selective update of a specific VLAN virtual interface (a virtual network interface created via VLAN tagging on a physical ethernet interface according to IEEE 802.1Q standard; sends and receives tagged traffic with specified VLAN ID; used for network segmentation, traffic isolation, and multi-L3 network configuration; requires parent physical interface and VLAN ID specification) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one macvtap virtual interface instance
Описание: Creates a new macvtap virtual interface (a virtual interface that provides network connectivity using macvtap driver which creates MAC address-based virtual interfaces on physical interfaces; supports bridge/vepa/private/passthrough modes; provides high-performance direct MAC-level access for virtual machine and container network connectivity; requires parent physical interface and mode selection) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one macvtap virtual interface instance
Описание: Performs a complete replacement of a specific macvtap virtual interface (a virtual interface that provides network connectivity using macvtap driver which creates MAC address-based virtual interfaces on physical interfaces; supports bridge/vepa/private/passthrough modes; provides high-performance direct MAC-level access for virtual machine and container network connectivity; requires parent physical interface and mode selection) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one macvtap virtual interface instance
Описание: Performs a selective update of a specific macvtap virtual interface (a virtual interface that provides network connectivity using macvtap driver which creates MAC address-based virtual interfaces on physical interfaces; supports bridge/vepa/private/passthrough modes; provides high-performance direct MAC-level access for virtual machine and container network connectivity; requires parent physical interface and mode selection) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one veth peer virtual interface instance
Описание: Creates a new veth peer virtual interface (a veth (virtual ethernet) interface that works like a virtual ethernet cable pair with two ends connected to each other; packets sent from one end are received at the other end; used to establish point-to-point connections between network namespaces and containers, enabling traffic flow between bridges and routing tables; peer interface name must be specified) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one veth peer virtual interface instance
Описание: Performs a complete replacement of a specific veth peer virtual interface (a veth (virtual ethernet) interface that works like a virtual ethernet cable pair with two ends connected to each other; packets sent from one end are received at the other end; used to establish point-to-point connections between network namespaces and containers, enabling traffic flow between bridges and routing tables; peer interface name must be specified) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one veth peer virtual interface instance
Описание: Performs a selective update of a specific veth peer virtual interface (a veth (virtual ethernet) interface that works like a virtual ethernet cable pair with two ends connected to each other; packets sent from one end are received at the other end; used to establish point-to-point connections between network namespaces and containers, enabling traffic flow between bridges and routing tables; peer interface name must be specified) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one bond aggregate interface instance
Описание: Creates a new bond aggregate interface (an aggregate interface that combines multiple physical ethernet interfaces into a single logical interface; supports bonding modes like balance-rr, active-backup, balance-xor, broadcast, 802.3ad; provides network bandwidth increase, load balancing, and redundancy; slave interfaces, primary interface, and bonding options are configurable) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one bond aggregate interface instance
Описание: Performs a complete replacement of a specific bond aggregate interface (an aggregate interface that combines multiple physical ethernet interfaces into a single logical interface; supports bonding modes like balance-rr, active-backup, balance-xor, broadcast, 802.3ad; provides network bandwidth increase, load balancing, and redundancy; slave interfaces, primary interface, and bonding options are configurable) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one bond aggregate interface instance
Описание: Performs a selective update of a specific bond aggregate interface (an aggregate interface that combines multiple physical ethernet interfaces into a single logical interface; supports bonding modes like balance-rr, active-backup, balance-xor, broadcast, 802.3ad; provides network bandwidth increase, load balancing, and redundancy; slave interfaces, primary interface, and bonding options are configurable) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one lacp aggregate interface instance
Описание: Creates a new LACP aggregate interface (an advanced aggregate interface that dynamically combines multiple physical ethernet interfaces using IEEE 802.3ad Link Aggregation Control Protocol; automatically forms link aggregation group with peer device via LACP PDUs; provides high bandwidth, automatic failover, load balancing, and standards-compliant multi-link connectivity; LACP system priority, port priority, and aggregation key are configurable) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one LACP aggregate interface instance
Описание: Performs a complete replacement of a specific LACP aggregate interface (an advanced aggregate interface that dynamically combines multiple physical ethernet interfaces using IEEE 802.3ad Link Aggregation Control Protocol; automatically forms link aggregation group with peer device via LACP PDUs; provides high bandwidth, automatic failover, load balancing, and standards-compliant multi-link connectivity; LACP system priority, port priority, and aggregation key are configurable) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one LACP aggregate interface instance
Описание: Performs a selective update of a specific LACP aggregate interface (an advanced aggregate interface that dynamically combines multiple physical ethernet interfaces using IEEE 802.3ad Link Aggregation Control Protocol; automatically forms link aggregation group with peer device via LACP PDUs; provides high bandwidth, automatic failover, load balancing, and standards-compliant multi-link connectivity; LACP system priority, port priority, and aggregation key are configurable) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one bridge virtual interface instance
Описание: Creates a new bridge virtual interface (a software bridge interface that combines multiple network interfaces at L2 level to form a single broadcast domain; provides MAC address learning, forwarding table management, and STP (Spanning Tree Protocol) support; used for network switching for virtual machines and containers, VLAN-aware bridge configuration, and L2 communication between network segments) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/interfaces
CLI-команда: network interface add ?
Категория: network / interfaces
Просмотреть документациюUpdate one bridge virtual interface instance
Описание: Performs a complete replacement of a specific bridge virtual interface (a software bridge interface that combines multiple network interfaces at L2 level to form a single broadcast domain; provides MAC address learning, forwarding table management, and STP (Spanning Tree Protocol) support; used for network switching for virtual machines and containers, VLAN-aware bridge configuration, and L2 communication between network segments) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface set ?
Категория: network / interfaces
Просмотреть документациюPartial update one bridge virtual interface instance
Описание: Performs a selective update of a specific bridge virtual interface (a software bridge interface that combines multiple network interfaces at L2 level to form a single broadcast domain; provides MAC address learning, forwarding table management, and STP (Spanning Tree Protocol) support; used for network switching for virtual machines and containers, VLAN-aware bridge configuration, and L2 communication between network segments) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/interfaces/[id]
CLI-команда: network interface update ?
Категория: network / interfaces
Просмотреть документациюCreate one ip instance
Описание: Creates a new IP address (a unique network identifier assigned to an interface that enables the device to communicate on IP networks, supporting both IPv4 and IPv6 with CIDR notation for flexible subnetting) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/ips
CLI-команда: network ip add ?
Категория: network / ips
Просмотреть документациюUpdate one IP instance
Описание: Performs a complete replacement of a specific IP address (a unique network identifier assigned to an interface that enables the device to communicate on IP networks, supporting both IPv4 and IPv6 with CIDR notation for flexible subnetting) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/ips/[id]
CLI-команда: network ip set ?
Категория: network / ips
Просмотреть документациюPartial update one IP instance
Описание: Performs a selective update of a specific IP address (a unique network identifier assigned to an interface that enables the device to communicate on IP networks, supporting both IPv4 and IPv6 with CIDR notation for flexible subnetting) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/ips/[id]
CLI-команда: network ip update ?
Категория: network / ips
Просмотреть документациюCreate one route instance
Описание: Creates a new static route (a manually configured routing entry that directs network traffic to specific destinations through designated gateways, essential for multi-subnet environments and custom traffic steering) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /network/[zoneId]/routes
CLI-команда: network route add ?
Категория: network / routes
Просмотреть документациюUpdate one route instance
Описание: Performs a complete replacement of a specific static route (a manually configured routing entry that directs network traffic to specific destinations through designated gateways, essential for multi-subnet environments and custom traffic steering) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /network/[zoneId]/routes/[id]
CLI-команда: network route set ?
Категория: network / routes
Просмотреть документациюPartial update one route instance
Описание: Performs a selective update of a specific static route (a manually configured routing entry that directs network traffic to specific destinations through designated gateways, essential for multi-subnet environments and custom traffic steering) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /network/[zoneId]/routes/[id]
CLI-команда: network route update ?
Категория: network / routes
Просмотреть документациюShow WAF option
Описание: Retrieves the complete current configuration of WAF configuration (global Web Application Firewall settings managing OWASP protection levels, structure and argument validation, blacklist IP protection, custom blocking pages, body processing limits, behavioral collective learning from traffic patterns, trusted source teaching mode, and analysis capabilities with scheduled email reporting). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /waf/[poolId]/options
CLI-команда: waf options show ?
Категория: waf / options
Просмотреть документациюPartial update WAF option
Описание: Performs a selective update of WAF configuration (global Web Application Firewall settings managing OWASP protection levels, structure and argument validation, blacklist IP protection, custom blocking pages, body processing limits, behavioral collective learning from traffic patterns, trusted source teaching mode, and analysis capabilities with scheduled email reporting) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /waf/[poolId]/options
CLI-команда: waf options update ?
Категория: waf / options
Просмотреть документациюCreate one host group instance
Описание: Creates a new host group (a WAF grouping configuration that organizes domain names with configurable operation mode including blocking to prevent attacks, detection for monitoring only, or disabled, enabling flexible WAF policy application across different applications and environments) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /waf/[poolId]/hostGroups
CLI-команда: waf hostGroups add ?
Категория: waf / hostGroups
Просмотреть документациюUpdate one host group instance
Описание: Performs a complete replacement of a specific host group (a WAF grouping configuration that organizes domain names with configurable operation mode including blocking to prevent attacks, detection for monitoring only, or disabled, enabling flexible WAF policy application across different applications and environments) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /waf/[poolId]/hostGroups/[id]
CLI-команда: waf hostGroups set ?
Категория: waf / hostGroups
Просмотреть документациюPartial update one host group instance
Описание: Performs a selective update of a specific host group (a WAF grouping configuration that organizes domain names with configurable operation mode including blocking to prevent attacks, detection for monitoring only, or disabled, enabling flexible WAF policy application across different applications and environments) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /waf/[poolId]/hostGroups/[id]
CLI-команда: waf hostGroups update ?
Категория: waf / hostGroups
Просмотреть документациюCreate one dns service instance
Описание: Creates a new DNS service (a DNS service for Global Traffic Management listening on IP:port frontends with query forwarding to upstream DNS servers, DNS response caching with TTL and max entries, QoS management with CPU/memory limits, and logging) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmDns
CLI-команда: gtm service add ?
Категория: gtm / gtmDns
Просмотреть документациюUpdate one DNS service instance
Описание: Performs a complete replacement of a specific DNS service (a DNS service for Global Traffic Management listening on IP:port frontends with query forwarding to upstream DNS servers, DNS response caching with TTL and max entries, QoS management with CPU/memory limits, and logging) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmDns/[id]
CLI-команда: gtm service set ?
Категория: gtm / gtmDns
Просмотреть документациюPartial update one DNS service instance
Описание: Performs a selective update of a specific DNS service (a DNS service for Global Traffic Management listening on IP:port frontends with query forwarding to upstream DNS servers, DNS response caching with TTL and max entries, QoS management with CPU/memory limits, and logging) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmDns/[id]
CLI-команда: gtm service update ?
Категория: gtm / gtmDns
Просмотреть документациюCreate one dns record instance
Описание: Creates a new DNS record (a comprehensive DNS record configuration with multi-datacenter support including DNS record types like A, AAAA, CNAME, datacenter-specific records, health check-based routing, disaster recovery scenario, intelligent datacenter selection (host, service, client-based), balance algorithm, and fail-safe fallback records) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmDnsRecords/[dnsId]
CLI-команда: gtm dns-record add ?
Категория: gtm / gtmDnsRecords
Просмотреть документациюUpdate one DNS record instance
Описание: Performs a complete replacement of a specific DNS record (a comprehensive DNS record configuration with multi-datacenter support including DNS record types like A, AAAA, CNAME, datacenter-specific records, health check-based routing, disaster recovery scenario, intelligent datacenter selection (host, service, client-based), balance algorithm, and fail-safe fallback records) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmDnsRecords/[dnsId]/[id]
CLI-команда: gtm dns-record set ?
Категория: gtm / gtmDnsRecords
Просмотреть документациюPartial update one DNS record instance
Описание: Performs a selective update of a specific DNS record (a comprehensive DNS record configuration with multi-datacenter support including DNS record types like A, AAAA, CNAME, datacenter-specific records, health check-based routing, disaster recovery scenario, intelligent datacenter selection (host, service, client-based), balance algorithm, and fail-safe fallback records) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmDnsRecords/[dnsId]/[id]
CLI-команда: gtm dns-record update ?
Категория: gtm / gtmDnsRecords
Просмотреть документациюCreate one dns domain instance
Описание: Creates a new domain (a DNS domain/zone configuration with working mode support (standalone, disaster recovery, or datacenter mode), default datacenter configuration, zone transfer for slave servers, DNSSEC support, and SOA serial format selection) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmDnsDomains/[dnsId]
CLI-команда: gtm dns-domain add ?
Категория: gtm / gtmDnsDomains
Просмотреть документациюUpdate one DNS domain instance
Описание: Performs a complete replacement of a specific domain (a DNS domain/zone configuration with working mode support (standalone, disaster recovery, or datacenter mode), default datacenter configuration, zone transfer for slave servers, DNSSEC support, and SOA serial format selection) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmDnsDomains/[dnsId]/[id]
CLI-команда: gtm dns-domain set ?
Категория: gtm / gtmDnsDomains
Просмотреть документациюPartial update one DNS domain instance
Описание: Performs a selective update of a specific domain (a DNS domain/zone configuration with working mode support (standalone, disaster recovery, or datacenter mode), default datacenter configuration, zone transfer for slave servers, DNSSEC support, and SOA serial format selection) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmDnsDomains/[dnsId]/[id]
CLI-команда: gtm dns-domain update ?
Категория: gtm / gtmDnsDomains
Просмотреть документациюCreate one dns forwarder profile instance
Описание: Creates a new DNS forwarder profile (a DNS forwarding configuration forwarding DNS queries to upstream DNS servers with default forwarding addresses and custom forwarding rules for specific domains) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmForwarders
CLI-команда: gtm forwarder-profile add ?
Категория: gtm / gtmForwarders
Просмотреть документациюUpdate one DNS forwarder profile instance
Описание: Performs a complete replacement of a specific DNS forwarder profile (a DNS forwarding configuration forwarding DNS queries to upstream DNS servers with default forwarding addresses and custom forwarding rules for specific domains) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmForwarders/[id]
CLI-команда: gtm forwarder-profile set ?
Категория: gtm / gtmForwarders
Просмотреть документациюPartial update one DNS forwarder profile instance
Описание: Performs a selective update of a specific DNS forwarder profile (a DNS forwarding configuration forwarding DNS queries to upstream DNS servers with default forwarding addresses and custom forwarding rules for specific domains) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmForwarders/[id]
CLI-команда: gtm forwarder-profile update ?
Категория: gtm / gtmForwarders
Просмотреть документациюCreate one datacenter instance
Описание: Creates a new datacenter (other TR7 GTM applications/devices for geo-distributed DNS traffic management, defined with WAN and LAN access addresses for communication, access period, and successful/failed check thresholds for marking healthy/unhealthy) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmDataCenters
CLI-команда: gtm data-center-remote add ?
Категория: gtm / gtmDataCenters
Просмотреть документациюUpdate one datacenter instance
Описание: Performs a complete replacement of a specific datacenter (other TR7 GTM applications/devices for geo-distributed DNS traffic management, defined with WAN and LAN access addresses for communication, access period, and successful/failed check thresholds for marking healthy/unhealthy) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmDataCenters/[id]
CLI-команда: gtm data-center-remote set ?
Категория: gtm / gtmDataCenters
Просмотреть документациюPartial update one datacenter instance
Описание: Performs a selective update of a specific datacenter (other TR7 GTM applications/devices for geo-distributed DNS traffic management, defined with WAN and LAN access addresses for communication, access period, and successful/failed check thresholds for marking healthy/unhealthy) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmDataCenters/[id]
CLI-команда: gtm data-center-remote update ?
Категория: gtm / gtmDataCenters
Просмотреть документациюCreate one health check instance
Описание: Creates a new health check (a GTM health check profile extending ADC health check features with GTM-specific datacenter checking, supporting protocols including ping, TCP, HTTP, HTTPS, UDP, DNS, and datacenter check types like internet check and pool statistics check) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmHc
CLI-команда: gtm hc add ?
Категория: gtm / gtmHc
Просмотреть документациюUpdate one health check instance
Описание: Performs a complete replacement of a specific health check (a GTM health check profile extending ADC health check features with GTM-specific datacenter checking, supporting protocols including ping, TCP, HTTP, HTTPS, UDP, DNS, and datacenter check types like internet check and pool statistics check) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmHc/[id]
CLI-команда: gtm hc set ?
Категория: gtm / gtmHc
Просмотреть документациюPartial update one health check instance
Описание: Performs a selective update of a specific health check (a GTM health check profile extending ADC health check features with GTM-specific datacenter checking, supporting protocols including ping, TCP, HTTP, HTTPS, UDP, DNS, and datacenter check types like internet check and pool statistics check) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmHc/[id]
CLI-команда: gtm hc update ?
Категория: gtm / gtmHc
Просмотреть документациюCreate one health scenario instance
Описание: Creates a new health scenario (a health check scenario for dynamic GTM configuration changes with activation and deactivation triggers based on health check conditions, auto or manual activation modes, and activation/deactivation check conditions) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmHcScenarios
CLI-команда: gtm scenario add ?
Категория: gtm / gtmHcScenarios
Просмотреть документациюUpdate one health scenario instance
Описание: Performs a complete replacement of a specific health scenario (a health check scenario for dynamic GTM configuration changes with activation and deactivation triggers based on health check conditions, auto or manual activation modes, and activation/deactivation check conditions) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmHcScenarios/[id]
CLI-команда: gtm scenario set ?
Категория: gtm / gtmHcScenarios
Просмотреть документациюPartial update one health scenario instance
Описание: Performs a selective update of a specific health scenario (a health check scenario for dynamic GTM configuration changes with activation and deactivation triggers based on health check conditions, auto or manual activation modes, and activation/deactivation check conditions) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmHcScenarios/[id]
CLI-команда: gtm scenario update ?
Категория: gtm / gtmHcScenarios
Просмотреть документациюCreate one trigger action instance
Описание: Creates a new trigger action (a GTM event trigger profile that can be executed when health scenarios activate/deactivate, supporting HTTP/HTTPS webhooks, oracle scripts, and other trigger types with IP:port address configuration, HTTP method/headers/body, and expected status codes) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmTriggers
CLI-команда: gtm trigger add ?
Категория: gtm / gtmTriggers
Просмотреть документациюUpdate one trigger action instance
Описание: Performs a complete replacement of a specific trigger action (a GTM event trigger profile that can be executed when health scenarios activate/deactivate, supporting HTTP/HTTPS webhooks, oracle scripts, and other trigger types with IP:port address configuration, HTTP method/headers/body, and expected status codes) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmTriggers/[id]
CLI-команда: gtm trigger set ?
Категория: gtm / gtmTriggers
Просмотреть документациюPartial update one trigger action instance
Описание: Performs a selective update of a specific trigger action (a GTM event trigger profile that can be executed when health scenarios activate/deactivate, supporting HTTP/HTTPS webhooks, oracle scripts, and other trigger types with IP:port address configuration, HTTP method/headers/body, and expected status codes) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmTriggers/[id]
CLI-команда: gtm trigger update ?
Категория: gtm / gtmTriggers
Просмотреть документациюCreate one express profile instance
Описание: Creates a new express profile (an express configuration profile for master/slave DNS record synchronization with master IP:port addresses and identifier pattern) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /gtm/gtmRecordMgmt
CLI-команда: gtm express-profile add ?
Категория: gtm / gtmRecordMgmt
Просмотреть документациюUpdate one express profile instance
Описание: Performs a complete replacement of a specific express profile (an express configuration profile for master/slave DNS record synchronization with master IP:port addresses and identifier pattern) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /gtm/gtmRecordMgmt/[id]
CLI-команда: gtm express-profile set ?
Категория: gtm / gtmRecordMgmt
Просмотреть документациюPartial update one express profile instance
Описание: Performs a selective update of a specific express profile (an express configuration profile for master/slave DNS record synchronization with master IP:port addresses and identifier pattern) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /gtm/gtmRecordMgmt/[id]
CLI-команда: gtm express-profile update ?
Категория: gtm / gtmRecordMgmt
Просмотреть документациюShow local datacenter settings
Описание: Retrieves the complete current configuration of local datacenter settings (local GTM datacenter identity and reachability configuration with access addresses (namespace, IP, port) for remote datacenters to reach this device, health scenario for internet connectivity check, and maintenance mode). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /gtm/localDcSettings
CLI-команда: gtm data-center-local show ?
Категория: gtm / localDcSettings
Просмотреть документациюPartial update local datacenter settings
Описание: Performs a selective update of local datacenter settings (local GTM datacenter identity and reachability configuration with access addresses (namespace, IP, port) for remote datacenters to reach this device, health scenario for internet connectivity check, and maintenance mode) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /gtm/localDcSettings
CLI-команда: gtm data-center-local update ?
Категория: gtm / localDcSettings
Просмотреть документациюCreate one access service instance
Описание: Creates a new access service (an Application Access Manager instance that orchestrates authentication journeys with an action flowchart, multiple actions including authentication providers, MFA, forms, decision points, and user attribute assignment, capable of operating in web, API, or portal mode with customizable page templates, dictionaries, and security profiles) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsGateways
CLI-команда: ags gateway add ?
Категория: ags / agsGateways
Просмотреть документациюUpdate one access service instance
Описание: Performs a complete replacement of a specific access service (an Application Access Manager instance that orchestrates authentication journeys with an action flowchart, multiple actions including authentication providers, MFA, forms, decision points, and user attribute assignment, capable of operating in web, API, or portal mode with customizable page templates, dictionaries, and security profiles) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsGateways/[id]
CLI-команда: ags gateway set ?
Категория: ags / agsGateways
Просмотреть документациюPartial update one access service instance
Описание: Performs a selective update of a specific access service (an Application Access Manager instance that orchestrates authentication journeys with an action flowchart, multiple actions including authentication providers, MFA, forms, decision points, and user attribute assignment, capable of operating in web, API, or portal mode with customizable page templates, dictionaries, and security profiles) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsGateways/[id]
CLI-команда: ags gateway update ?
Категория: ags / agsGateways
Просмотреть документациюCreate one authentication server instance
Описание: Creates a new authentication server (a backend authentication server configuration referenced by authentication providers with protocols supporting LDAP, RADIUS, HTTP, OAuth2, OIDC, and SAML, load balancing for multi-host configurations, SSL/TLS security settings, connection pool management, and health checking) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationServers
CLI-команда: ags authentication-server add ?
Категория: ags / agsAuthenticationServers
Просмотреть документациюUpdate one authentication server instance
Описание: Performs a complete replacement of a specific authentication server (a backend authentication server configuration referenced by authentication providers with protocols supporting LDAP, RADIUS, HTTP, OAuth2, OIDC, and SAML, load balancing for multi-host configurations, SSL/TLS security settings, connection pool management, and health checking) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationServers/[id]
CLI-команда: ags authentication-server set ?
Категория: ags / agsAuthenticationServers
Просмотреть документациюPartial update one authentication server instance
Описание: Performs a selective update of a specific authentication server (a backend authentication server configuration referenced by authentication providers with protocols supporting LDAP, RADIUS, HTTP, OAuth2, OIDC, and SAML, load balancing for multi-host configurations, SSL/TLS security settings, connection pool management, and health checking) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationServers/[id]
CLI-команда: ags authentication-server update ?
Категория: ags / agsAuthenticationServers
Просмотреть документациюCreate one oauth2 provider instance
Описание: Creates a new OAuth2 provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one OAuth2 provider instance
Описание: Performs a complete replacement of a specific OAuth2 provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one OAuth2 provider instance
Описание: Performs a selective update of a specific OAuth2 provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one openid connect provider instance
Описание: Creates a new OpenID Connect provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one OpenID Connect provider instance
Описание: Performs a complete replacement of a specific OpenID Connect provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one OpenID Connect provider instance
Описание: Performs a selective update of a specific OpenID Connect provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one saml provider instance
Описание: Creates a new SAML provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one SAML provider instance
Описание: Performs a complete replacement of a specific SAML provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one SAML provider instance
Описание: Performs a selective update of a specific SAML provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one ldap provider instance
Описание: Creates a new LDAP provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one LDAP provider instance
Описание: Performs a complete replacement of a specific LDAP provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one LDAP provider instance
Описание: Performs a selective update of a specific LDAP provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one http provider instance
Описание: Creates a new HTTP provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one HTTP provider instance
Описание: Performs a complete replacement of a specific HTTP provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one HTTP provider instance
Описание: Performs a selective update of a specific HTTP provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one certificate provider instance
Описание: Creates a new certificate provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one certificate provider instance
Описание: Performs a complete replacement of a specific certificate provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one certificate provider instance
Описание: Performs a selective update of a specific certificate provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one database provider instance
Описание: Creates a new database provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one database provider instance
Описание: Performs a complete replacement of a specific database provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one database provider instance
Описание: Performs a selective update of a specific database provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one radius provider instance
Описание: Creates a new RADIUS provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one RADIUS provider instance
Описание: Performs a complete replacement of a specific RADIUS provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one RADIUS provider instance
Описание: Performs a selective update of a specific RADIUS provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one portal provider instance
Описание: Creates a new portal provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one portal provider instance
Описание: Performs a complete replacement of a specific portal provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one portal provider instance
Описание: Performs a selective update of a specific portal provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one web form provider instance
Описание: Creates a new web form provider instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsAuthenticationProviders
CLI-команда: ags authentication-provider add ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюUpdate one web form provider instance
Описание: Performs a complete replacement of a specific web form provider instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider set ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюPartial update one web form provider instance
Описание: Performs a selective update of a specific web form provider instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsAuthenticationProviders/[id]
CLI-команда: ags authentication-provider update ?
Категория: ags / agsAuthenticationProviders
Просмотреть документациюCreate one local database instance
Описание: Creates a new local database (a local authentication database configuration storing local user accounts for AAM services with password policy (minimum length)) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsLocalDatabases
CLI-команда: ags local-database add ?
Категория: ags / agsLocalDatabases
Просмотреть документациюUpdate one local database instance
Описание: Performs a complete replacement of a specific local database (a local authentication database configuration storing local user accounts for AAM services with password policy (minimum length)) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsLocalDatabases/[id]
CLI-команда: ags local-database set ?
Категория: ags / agsLocalDatabases
Просмотреть документациюPartial update one local database instance
Описание: Performs a selective update of a specific local database (a local authentication database configuration storing local user accounts for AAM services with password policy (minimum length)) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsLocalDatabases/[id]
CLI-команда: ags local-database update ?
Категория: ags / agsLocalDatabases
Просмотреть документациюCreate one local user instance
Описание: Creates a new local user (a user account stored in a local database with email and custom attributes, usable for AAM authentication) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/agsLocalUsers
CLI-команда: ags local-user add ?
Категория: ags / agsLocalUsers
Просмотреть документациюUpdate one local user instance
Описание: Performs a complete replacement of a specific local user (a user account stored in a local database with email and custom attributes, usable for AAM authentication) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/agsLocalUsers/[id]
CLI-команда: ags local-user set ?
Категория: ags / agsLocalUsers
Просмотреть документациюPartial update one local user instance
Описание: Performs a selective update of a specific local user (a user account stored in a local database with email and custom attributes, usable for AAM authentication) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/agsLocalUsers/[id]
CLI-команда: ags local-user update ?
Категория: ags / agsLocalUsers
Просмотреть документациюCreate one form instance
Описание: Creates a new form (a form builder configuration for creating custom login forms and user input pages used in authentication flows, supporting rich field types like text, password, email, select, checkbox, radio, file upload, submit button, button group, divider, and custom HTML with validation, placeholder, help text, and conditional logic) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/agsForms
CLI-команда: ags forms add ?
Категория: ags / profiles
Просмотреть документациюUpdate one form instance
Описание: Performs a complete replacement of a specific form (a form builder configuration for creating custom login forms and user input pages used in authentication flows, supporting rich field types like text, password, email, select, checkbox, radio, file upload, submit button, button group, divider, and custom HTML with validation, placeholder, help text, and conditional logic) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/agsForms/[id]
CLI-команда: ags forms set ?
Категория: ags / profiles
Просмотреть документациюPartial update one form instance
Описание: Performs a selective update of a specific form (a form builder configuration for creating custom login forms and user input pages used in authentication flows, supporting rich field types like text, password, email, select, checkbox, radio, file upload, submit button, button group, divider, and custom HTML with validation, placeholder, help text, and conditional logic) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/agsForms/[id]
CLI-команда: ags forms update ?
Категория: ags / profiles
Просмотреть документациюCreate one mfa instance
Описание: Creates a new MFA configuration (a multi-factor authentication configuration supporting email OTP (length, expiration, resend settings) and TOTP authenticator app (algorithm, digits, period, time drift tolerance, backup codes) methods with optional conditions, "trust this device" option, and lockout policy integration) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/agsMFAs
CLI-команда: ags mfas add ?
Категория: ags / profiles
Просмотреть документациюUpdate one MFA instance
Описание: Performs a complete replacement of a specific MFA configuration (a multi-factor authentication configuration supporting email OTP (length, expiration, resend settings) and TOTP authenticator app (algorithm, digits, period, time drift tolerance, backup codes) methods with optional conditions, "trust this device" option, and lockout policy integration) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/agsMFAs/[id]
CLI-команда: ags mfas set ?
Категория: ags / profiles
Просмотреть документациюPartial update one MFA instance
Описание: Performs a selective update of a specific MFA configuration (a multi-factor authentication configuration supporting email OTP (length, expiration, resend settings) and TOTP authenticator app (algorithm, digits, period, time drift tolerance, backup codes) methods with optional conditions, "trust this device" option, and lockout policy integration) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/agsMFAs/[id]
CLI-команда: ags mfas update ?
Категория: ags / profiles
Просмотреть документациюCreate one page template instance
Описание: Creates a new page template (a comprehensive UI branding and appearance customization configuration for authentication pages including page title, favicon, header/footer logo and content, brand color, background image and opacity, with dark mode support) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/agsPageTemplates
CLI-команда: ags profiles page-templates add ?
Категория: ags / profiles
Просмотреть документациюUpdate one page template instance
Описание: Performs a complete replacement of a specific page template (a comprehensive UI branding and appearance customization configuration for authentication pages including page title, favicon, header/footer logo and content, brand color, background image and opacity, with dark mode support) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/agsPageTemplates/[id]
CLI-команда: ags profiles page-templates set ?
Категория: ags / profiles
Просмотреть документациюPartial update one page template instance
Описание: Performs a selective update of a specific page template (a comprehensive UI branding and appearance customization configuration for authentication pages including page title, favicon, header/footer logo and content, brand color, background image and opacity, with dark mode support) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/agsPageTemplates/[id]
CLI-команда: ags profiles page-templates update ?
Категория: ags / profiles
Просмотреть документациюCreate one dictionary instance
Описание: Creates a new dictionary (an internationalization dictionary configuration for dynamic translation in authentication flows with supported languages and key-language-value translation entries including smart variable support) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/agsDictionaries
CLI-команда: ags profiles dictionaries add ?
Категория: ags / profiles
Просмотреть документациюUpdate one dictionary instance
Описание: Performs a complete replacement of a specific dictionary (an internationalization dictionary configuration for dynamic translation in authentication flows with supported languages and key-language-value translation entries including smart variable support) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/agsDictionaries/[id]
CLI-команда: ags profiles dictionaries set ?
Категория: ags / profiles
Просмотреть документациюPartial update one dictionary instance
Описание: Performs a selective update of a specific dictionary (an internationalization dictionary configuration for dynamic translation in authentication flows with supported languages and key-language-value translation entries including smart variable support) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/agsDictionaries/[id]
CLI-команда: ags profiles dictionaries update ?
Категория: ags / profiles
Просмотреть документациюCreate one lockout policy instance
Описание: Creates a new lockout policy (an account lockout policy preventing brute force attacks with failed attempt counting by username, IP, or custom components, progressive enforcement including warning display, CAPTCHA protection, and final lockout with configurable thresholds, durations, and attempt window) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/security/agsLockoutPolicies
CLI-команда: ags security lockoutPolicies add ?
Категория: ags / profiles
Просмотреть документациюUpdate one lockout policy instance
Описание: Performs a complete replacement of a specific lockout policy (an account lockout policy preventing brute force attacks with failed attempt counting by username, IP, or custom components, progressive enforcement including warning display, CAPTCHA protection, and final lockout with configurable thresholds, durations, and attempt window) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/security/agsLockoutPolicies/[id]
CLI-команда: ags security lockoutPolicies set ?
Категория: ags / profiles
Просмотреть документациюPartial update one lockout policy instance
Описание: Performs a selective update of a specific lockout policy (an account lockout policy preventing brute force attacks with failed attempt counting by username, IP, or custom components, progressive enforcement including warning display, CAPTCHA protection, and final lockout with configurable thresholds, durations, and attempt window) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/security/agsLockoutPolicies/[id]
CLI-команда: ags security lockoutPolicies update ?
Категория: ags / profiles
Просмотреть документациюCreate one session protection policy instance
Описание: Creates a new session protection policy (a session security policy preventing session hijacking with session binding to IP, user agent, or custom components, maximum concurrent session limit, deny or killOldest action when limit exceeded, and whitelist condition) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/security/agsSessionProtectionPolicies
CLI-команда: ags security sessionProtectionPolicies add ?
Категория: ags / profiles
Просмотреть документациюUpdate one session protection policy instance
Описание: Performs a complete replacement of a specific session protection policy (a session security policy preventing session hijacking with session binding to IP, user agent, or custom components, maximum concurrent session limit, deny or killOldest action when limit exceeded, and whitelist condition) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/security/agsSessionProtectionPolicies/[id]
CLI-команда: ags security sessionProtectionPolicies set ?
Категория: ags / profiles
Просмотреть документациюPartial update one session protection policy instance
Описание: Performs a selective update of a specific session protection policy (a session security policy preventing session hijacking with session binding to IP, user agent, or custom components, maximum concurrent session limit, deny or killOldest action when limit exceeded, and whitelist condition) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/security/agsSessionProtectionPolicies/[id]
CLI-команда: ags security sessionProtectionPolicies update ?
Категория: ags / profiles
Просмотреть документациюCreate one bot protection policy instance
Описание: Creates a new bot protection policy (a bot detection and mitigation policy detecting bot activity with request rate, risk score, or static triggers across global, IP, username, or custom scopes, with configurable thresholds and time windows including mitigation actions: allow, deny, block, delay, progressive delay, captcha, or bandwidth limiting) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/security/agsBotProtectionPolicies
CLI-команда: ags security rateLimitPolicies add ?
Категория: ags / profiles
Просмотреть документациюUpdate one bot protection policy instance
Описание: Performs a complete replacement of a specific bot protection policy (a bot detection and mitigation policy detecting bot activity with request rate, risk score, or static triggers across global, IP, username, or custom scopes, with configurable thresholds and time windows including mitigation actions: allow, deny, block, delay, progressive delay, captcha, or bandwidth limiting) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/security/agsBotProtectionPolicies/[id]
CLI-команда: ags security rateLimitPolicies set ?
Категория: ags / profiles
Просмотреть документациюPartial update one bot protection policy instance
Описание: Performs a selective update of a specific bot protection policy (a bot detection and mitigation policy detecting bot activity with request rate, risk score, or static triggers across global, IP, username, or custom scopes, with configurable thresholds and time windows including mitigation actions: allow, deny, block, delay, progressive delay, captcha, or bandwidth limiting) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/security/agsBotProtectionPolicies/[id]
CLI-команда: ags security rateLimitPolicies update ?
Категория: ags / profiles
Просмотреть документациюCreate one captcha provider instance
Описание: Creates a new captcha provider (a CAPTCHA integration for bot protection featuring built-in TR7 captcha with text, math, and image types and additionally supporting 3rd party providers including Google reCAPTCHA (v2, v3), Cloudflare Turnstile, and hCaptcha, with site/secret key configuration, difficulty/threshold settings, solved captcha validity duration, max attempts, and network namespace selection) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/security/agsCaptchaProviders
CLI-команда: ags security captchaProviders add ?
Категория: ags / profiles
Просмотреть документациюUpdate one captcha provider instance
Описание: Performs a complete replacement of a specific captcha provider (a CAPTCHA integration for bot protection featuring built-in TR7 captcha with text, math, and image types and additionally supporting 3rd party providers including Google reCAPTCHA (v2, v3), Cloudflare Turnstile, and hCaptcha, with site/secret key configuration, difficulty/threshold settings, solved captcha validity duration, max attempts, and network namespace selection) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/security/agsCaptchaProviders/[id]
CLI-команда: ags security captchaProviders set ?
Категория: ags / profiles
Просмотреть документациюPartial update one captcha provider instance
Описание: Performs a selective update of a specific captcha provider (a CAPTCHA integration for bot protection featuring built-in TR7 captcha with text, math, and image types and additionally supporting 3rd party providers including Google reCAPTCHA (v2, v3), Cloudflare Turnstile, and hCaptcha, with site/secret key configuration, difficulty/threshold settings, solved captcha validity duration, max attempts, and network namespace selection) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/security/agsCaptchaProviders/[id]
CLI-команда: ags security captchaProviders update ?
Категория: ags / profiles
Просмотреть документациюCreate one security profile instance
Описание: Creates a new security profile (a security configuration aggregating all security policies into a single profile assignable to AAM gateways with bot protection policies, lockout policy, session protection policy, default lockout policies, risk score factors, and device fingerprint fields) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /ags/profiles/security/agsGatewaySecurities
CLI-команда: ags security profiles add ?
Категория: ags / profiles
Просмотреть документациюUpdate one security profile instance
Описание: Performs a complete replacement of a specific security profile (a security configuration aggregating all security policies into a single profile assignable to AAM gateways with bot protection policies, lockout policy, session protection policy, default lockout policies, risk score factors, and device fingerprint fields) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /ags/profiles/security/agsGatewaySecurities/[id]
CLI-команда: ags security profiles set ?
Категория: ags / profiles
Просмотреть документациюPartial update one security profile instance
Описание: Performs a selective update of a specific security profile (a security configuration aggregating all security policies into a single profile assignable to AAM gateways with bot protection policies, lockout policy, session protection policy, default lockout policies, risk score factors, and device fingerprint fields) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /ags/profiles/security/agsGatewaySecurities/[id]
CLI-команда: ags security profiles update ?
Категория: ags / profiles
Просмотреть документациюCreate one http vservice instance
Описание: Creates a new HTTP vService (an L7 HTTP/HTTPS application delivery service; with virtual hosting, SSL termination, WAF protection, HTTP compression, web caching, X-Forwarded-For header injection, debug mode, L7 DDOS profiles, conditional backend group routing, URI/header/cookie-based load balancing algorithms, server/TR7 cookie persistence, dynamic hash-based persistence, bandwidth limiting, QoS resource management (CPU/memory limits), timeout/pool limit/log/notification/report profiles, HTTP traffic actions and conditions support for comprehensive HTTP/HTTPS load balancing) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbPools
CLI-команда: lb service add ?
Категория: lb / lbPools
Просмотреть документациюUpdate one HTTP vService instance
Описание: Performs a complete replacement of a specific HTTP vService (an L7 HTTP/HTTPS application delivery service; with virtual hosting, SSL termination, WAF protection, HTTP compression, web caching, X-Forwarded-For header injection, debug mode, L7 DDOS profiles, conditional backend group routing, URI/header/cookie-based load balancing algorithms, server/TR7 cookie persistence, dynamic hash-based persistence, bandwidth limiting, QoS resource management (CPU/memory limits), timeout/pool limit/log/notification/report profiles, HTTP traffic actions and conditions support for comprehensive HTTP/HTTPS load balancing) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbPools/[id]
CLI-команда: lb service set ?
Категория: lb / lbPools
Просмотреть документациюPartial update one HTTP vService instance
Описание: Performs a selective update of a specific HTTP vService (an L7 HTTP/HTTPS application delivery service; with virtual hosting, SSL termination, WAF protection, HTTP compression, web caching, X-Forwarded-For header injection, debug mode, L7 DDOS profiles, conditional backend group routing, URI/header/cookie-based load balancing algorithms, server/TR7 cookie persistence, dynamic hash-based persistence, bandwidth limiting, QoS resource management (CPU/memory limits), timeout/pool limit/log/notification/report profiles, HTTP traffic actions and conditions support for comprehensive HTTP/HTTPS load balancing) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbPools/[id]
CLI-команда: lb service update ?
Категория: lb / lbPools
Просмотреть документациюCreate one tcp vservice instance
Описание: Creates a new TCP vService (an L4 TCP stream load balancing service; with SSL termination (end-to-end only), SSL security profiles, conditional backend group routing, roundrobin/leastconn/source/rdp-cookie-based load balancing algorithms, source IP/SSL session ID persistence, QoS resource management (CPU/memory limits), bandwidth limiting, L7 DDOS profiles (with IP whitelist/blacklist), timeout/pool limit/log/notification/report profiles, TCP traffic actions and conditions support for load balancing TCP stream applications) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbPools
CLI-команда: lb service add ?
Категория: lb / lbPools
Просмотреть документациюUpdate one TCP vService instance
Описание: Performs a complete replacement of a specific TCP vService (an L4 TCP stream load balancing service; with SSL termination (end-to-end only), SSL security profiles, conditional backend group routing, roundrobin/leastconn/source/rdp-cookie-based load balancing algorithms, source IP/SSL session ID persistence, QoS resource management (CPU/memory limits), bandwidth limiting, L7 DDOS profiles (with IP whitelist/blacklist), timeout/pool limit/log/notification/report profiles, TCP traffic actions and conditions support for load balancing TCP stream applications) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbPools/[id]
CLI-команда: lb service set ?
Категория: lb / lbPools
Просмотреть документациюPartial update one TCP vService instance
Описание: Performs a selective update of a specific TCP vService (an L4 TCP stream load balancing service; with SSL termination (end-to-end only), SSL security profiles, conditional backend group routing, roundrobin/leastconn/source/rdp-cookie-based load balancing algorithms, source IP/SSL session ID persistence, QoS resource management (CPU/memory limits), bandwidth limiting, L7 DDOS profiles (with IP whitelist/blacklist), timeout/pool limit/log/notification/report profiles, TCP traffic actions and conditions support for load balancing TCP stream applications) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbPools/[id]
CLI-команда: lb service update ?
Категория: lb / lbPools
Просмотреть документациюCreate one network vservice instance
Описание: Creates a new Network vService (an L3/L4 network layer load balancing service; with IPVS-based packet-level load balancing, TCP/UDP/ANY protocol support, DSR (Direct Server Return)/NAT/SNAT mode selection, route table-based network isolation, port range support, L4 persistence (connection tracking duration), SIP persistence support, L4 load balancing algorithms (rr/wrr/lc/wlc/lblc/lblcr/sh/dh/sed/nq/mh), frontend IP:port (or IP-only for protocol=ANY) configuration for high-performance low-latency network layer load balancing) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbPools
CLI-команда: lb service add ?
Категория: lb / lbPools
Просмотреть документациюUpdate one Network vService instance
Описание: Performs a complete replacement of a specific Network vService (an L3/L4 network layer load balancing service; with IPVS-based packet-level load balancing, TCP/UDP/ANY protocol support, DSR (Direct Server Return)/NAT/SNAT mode selection, route table-based network isolation, port range support, L4 persistence (connection tracking duration), SIP persistence support, L4 load balancing algorithms (rr/wrr/lc/wlc/lblc/lblcr/sh/dh/sed/nq/mh), frontend IP:port (or IP-only for protocol=ANY) configuration for high-performance low-latency network layer load balancing) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbPools/[id]
CLI-команда: lb service set ?
Категория: lb / lbPools
Просмотреть документациюPartial update one Network vService instance
Описание: Performs a selective update of a specific Network vService (an L3/L4 network layer load balancing service; with IPVS-based packet-level load balancing, TCP/UDP/ANY protocol support, DSR (Direct Server Return)/NAT/SNAT mode selection, route table-based network isolation, port range support, L4 persistence (connection tracking duration), SIP persistence support, L4 load balancing algorithms (rr/wrr/lc/wlc/lblc/lblcr/sh/dh/sed/nq/mh), frontend IP:port (or IP-only for protocol=ANY) configuration for high-performance low-latency network layer load balancing) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbPools/[id]
CLI-команда: lb service update ?
Категория: lb / lbPools
Просмотреть документациюCreate one backend instance
Описание: Creates a new backend (a real server instance that processes requests distributed from vServices, with health monitoring, connection limits, SSL support, and weight-based load distribution for optimal resource utilization) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbBackends
CLI-команда: lb backend add ?
Категория: lb / lbBackends
Просмотреть документациюUpdate one backend instance
Описание: Performs a complete replacement of a specific backend (a real server instance that processes requests distributed from vServices, with health monitoring, connection limits, SSL support, and weight-based load distribution for optimal resource utilization) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbBackends/[id]
CLI-команда: lb backend set ?
Категория: lb / lbBackends
Просмотреть документациюPartial update one backend instance
Описание: Performs a selective update of a specific backend (a real server instance that processes requests distributed from vServices, with health monitoring, connection limits, SSL support, and weight-based load distribution for optimal resource utilization) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbBackends/[id]
CLI-команда: lb backend update ?
Категория: lb / lbBackends
Просмотреть документациюCreate one tcp health check instance
Описание: Creates a new TCP health check (a scenario-based TCP connection health monitoring; with customizable TCP handshake and data exchange scenarios using sendText/expectText/expectRegex/wait actions, custom protocol validation, response pattern matching, timing control support for advanced TCP service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one TCP health check instance
Описание: Performs a complete replacement of a specific TCP health check (a scenario-based TCP connection health monitoring; with customizable TCP handshake and data exchange scenarios using sendText/expectText/expectRegex/wait actions, custom protocol validation, response pattern matching, timing control support for advanced TCP service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one TCP health check instance
Описание: Performs a selective update of a specific TCP health check (a scenario-based TCP connection health monitoring; with customizable TCP handshake and data exchange scenarios using sendText/expectText/expectRegex/wait actions, custom protocol validation, response pattern matching, timing control support for advanced TCP service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one ping health check instance
Описание: Creates a new PING health check (a simple network reachability check based on ICMP echo request/reply; with host-level availability check, minimum overhead, fast response time measurement for basic network layer health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one PING health check instance
Описание: Performs a complete replacement of a specific PING health check (a simple network reachability check based on ICMP echo request/reply; with host-level availability check, minimum overhead, fast response time measurement for basic network layer health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one PING health check instance
Описание: Performs a selective update of a specific PING health check (a simple network reachability check based on ICMP echo request/reply; with host-level availability check, minimum overhead, fast response time measurement for basic network layer health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one http health check instance
Описание: Creates a new HTTP health check (an HTTP/1.1 application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes (200/201/204/301/302/etc.), response content query (regex/substring match), virtual domain (Host header) support for comprehensive HTTP web service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one HTTP health check instance
Описание: Performs a complete replacement of a specific HTTP health check (an HTTP/1.1 application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes (200/201/204/301/302/etc.), response content query (regex/substring match), virtual domain (Host header) support for comprehensive HTTP web service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one HTTP health check instance
Описание: Performs a selective update of a specific HTTP health check (an HTTP/1.1 application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes (200/201/204/301/302/etc.), response content query (regex/substring match), virtual domain (Host header) support for comprehensive HTTP web service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one https health check instance
Описание: Creates a new HTTPS health check (an SSL/TLS encrypted HTTP application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes, response content query, virtual domain, SSL certificate validation support for secure HTTPS web service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one HTTPS health check instance
Описание: Performs a complete replacement of a specific HTTPS health check (an SSL/TLS encrypted HTTP application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes, response content query, virtual domain, SSL certificate validation support for secure HTTPS web service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one HTTPS health check instance
Описание: Performs a selective update of a specific HTTPS health check (an SSL/TLS encrypted HTTP application layer health monitoring; with custom URI path + query, HTTP method (GET/POST/PUT/DELETE/HEAD), custom headers, HTTP body payload, expected status codes, response content query, virtual domain, SSL certificate validation support for secure HTTPS web service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one dns health check instance
Описание: Creates a new DNS health check (a DNS resolver health monitoring; with custom DNS query (A/AAAA/CNAME/MX/TXT records), response validation, resolution time measurement support for DNS server availability and response time monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one DNS health check instance
Описание: Performs a complete replacement of a specific DNS health check (a DNS resolver health monitoring; with custom DNS query (A/AAAA/CNAME/MX/TXT records), response validation, resolution time measurement support for DNS server availability and response time monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one DNS health check instance
Описание: Performs a selective update of a specific DNS health check (a DNS resolver health monitoring; with custom DNS query (A/AAAA/CNAME/MX/TXT records), response validation, resolution time measurement support for DNS server availability and response time monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one ftp health check instance
Описание: Creates a new FTP health check (an FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin - login check only, loginAndList - login + directory listing), custom FTP path, connection/authentication/command execution validation support for FTP service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one FTP health check instance
Описание: Performs a complete replacement of a specific FTP health check (an FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin - login check only, loginAndList - login + directory listing), custom FTP path, connection/authentication/command execution validation support for FTP service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one FTP health check instance
Описание: Performs a selective update of a specific FTP health check (an FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin - login check only, loginAndList - login + directory listing), custom FTP path, connection/authentication/command execution validation support for FTP service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one ftps health check instance
Описание: Creates a new FTPS health check (an SSL/TLS encrypted FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin/loginAndList), custom FTP path, SSL certificate validation, encrypted connection/authentication/command execution validation support for secure FTPS service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one FTPS health check instance
Описание: Performs a complete replacement of a specific FTPS health check (an SSL/TLS encrypted FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin/loginAndList), custom FTP path, SSL certificate validation, encrypted connection/authentication/command execution validation support for secure FTPS service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one FTPS health check instance
Описание: Performs a selective update of a specific FTPS health check (an SSL/TLS encrypted FTP server authentication and access control; with username/password authentication, FTP action (onlyLogin/loginAndList), custom FTP path, SSL certificate validation, encrypted connection/authentication/command execution validation support for secure FTPS service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one ldap health check instance
Описание: Creates a new LDAP health check (an LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, LDAP bind operation validation support for LDAP server availability and authentication service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one LDAP health check instance
Описание: Performs a complete replacement of a specific LDAP health check (an LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, LDAP bind operation validation support for LDAP server availability and authentication service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one LDAP health check instance
Описание: Performs a selective update of a specific LDAP health check (an LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, LDAP bind operation validation support for LDAP server availability and authentication service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one ldaps health check instance
Описание: Creates a new LDAPS health check (an SSL/TLS encrypted LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, SSL certificate validation, encrypted LDAP bind operation validation support for secure LDAPS server health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one LDAPS health check instance
Описание: Performs a complete replacement of a specific LDAPS health check (an SSL/TLS encrypted LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, SSL certificate validation, encrypted LDAP bind operation validation support for secure LDAPS server health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one LDAPS health check instance
Описание: Performs a selective update of a specific LDAPS health check (an SSL/TLS encrypted LDAP directory server authentication control; with username/password credentials, optional LDAP authentication flag, SSL certificate validation, encrypted LDAP bind operation validation support for secure LDAPS server health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one oracle health check instance
Описание: Creates a new Oracle health check (an Oracle database server health and query execution control; with username/password/connection string authentication, scenario-based SQL query execution (executeCmd/wait actions), expected result text/minimum row count validation, query response time measurement support for Oracle database availability and query execution health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one Oracle health check instance
Описание: Performs a complete replacement of a specific Oracle health check (an Oracle database server health and query execution control; with username/password/connection string authentication, scenario-based SQL query execution (executeCmd/wait actions), expected result text/minimum row count validation, query response time measurement support for Oracle database availability and query execution health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one Oracle health check instance
Описание: Performs a selective update of a specific Oracle health check (an Oracle database server health and query execution control; with username/password/connection string authentication, scenario-based SQL query execution (executeCmd/wait actions), expected result text/minimum row count validation, query response time measurement support for Oracle database availability and query execution health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one udp health check instance
Описание: Creates a new UDP health check (a scenario-based UDP datagram health monitoring; with customizable UDP packet exchange scenarios using send/wait/expectText/expectRegex actions, data format (text/hex/base64) support, custom protocol validation, response pattern matching, timing control support for advanced UDP service health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbHealthChecks
CLI-команда: lb hc add ?
Категория: lb / lbHealthChecks
Просмотреть документациюUpdate one UDP health check instance
Описание: Performs a complete replacement of a specific UDP health check (a scenario-based UDP datagram health monitoring; with customizable UDP packet exchange scenarios using send/wait/expectText/expectRegex actions, data format (text/hex/base64) support, custom protocol validation, response pattern matching, timing control support for advanced UDP service health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc set ?
Категория: lb / lbHealthChecks
Просмотреть документациюPartial update one UDP health check instance
Описание: Performs a selective update of a specific UDP health check (a scenario-based UDP datagram health monitoring; with customizable UDP packet exchange scenarios using send/wait/expectText/expectRegex actions, data format (text/hex/base64) support, custom protocol validation, response pattern matching, timing control support for advanced UDP service health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbHealthChecks/[id]
CLI-команда: lb hc update ?
Категория: lb / lbHealthChecks
Просмотреть документациюCreate one show content instance
Описание: Creates a new Show content instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Show content instance
Описание: Performs a complete replacement of a specific Show content instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Show content instance
Описание: Performs a selective update of a specific Show content instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one keep header names instance
Описание: Creates a new Keep header names instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Keep header names instance
Описание: Performs a complete replacement of a specific Keep header names instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Keep header names instance
Описание: Performs a selective update of a specific Keep header names instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one manage http security headers instance
Описание: Creates a new Manage HTTP security headers instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Manage HTTP security headers instance
Описание: Performs a complete replacement of a specific Manage HTTP security headers instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Manage HTTP security headers instance
Описание: Performs a selective update of a specific Manage HTTP security headers instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one http cookie security instance
Описание: Creates a new HTTP cookie security instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one HTTP cookie security instance
Описание: Performs a complete replacement of a specific HTTP cookie security instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one HTTP cookie security instance
Описание: Performs a selective update of a specific HTTP cookie security instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one captcha protection instance
Описание: Creates a new CAPTCHA protection instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one CAPTCHA protection instance
Описание: Performs a complete replacement of a specific CAPTCHA protection instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one CAPTCHA protection instance
Описание: Performs a selective update of a specific CAPTCHA protection instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one bandwidth limitation instance
Описание: Creates a new Bandwidth limitation instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Bandwidth limitation instance
Описание: Performs a complete replacement of a specific Bandwidth limitation instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Bandwidth limitation instance
Описание: Performs a selective update of a specific Bandwidth limitation instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one cookie encryption instance
Описание: Creates a new Cookie encryption instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Cookie encryption instance
Описание: Performs a complete replacement of a specific Cookie encryption instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Cookie encryption instance
Описание: Performs a selective update of a specific Cookie encryption instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one ipfix log sending instance
Описание: Creates a new IPFIX log sending instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one IPFIX log sending instance
Описание: Performs a complete replacement of a specific IPFIX log sending instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one IPFIX log sending instance
Описание: Performs a selective update of a specific IPFIX log sending instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one add http header instance
Описание: Creates a new Add HTTP header instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Add HTTP header instance
Описание: Performs a complete replacement of a specific Add HTTP header instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Add HTTP header instance
Описание: Performs a selective update of a specific Add HTTP header instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one delete http header instance
Описание: Creates a new Delete HTTP header instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Delete HTTP header instance
Описание: Performs a complete replacement of a specific Delete HTTP header instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Delete HTTP header instance
Описание: Performs a selective update of a specific Delete HTTP header instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one set http header instance
Описание: Creates a new Set HTTP header instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Set HTTP header instance
Описание: Performs a complete replacement of a specific Set HTTP header instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Set HTTP header instance
Описание: Performs a selective update of a specific Set HTTP header instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one replace http header content instance
Описание: Creates a new Replace HTTP header content instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Replace HTTP header content instance
Описание: Performs a complete replacement of a specific Replace HTTP header content instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Replace HTTP header content instance
Описание: Performs a selective update of a specific Replace HTTP header content instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one advanced traffic inspection instance
Описание: Creates a new Advanced traffic inspection instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Advanced traffic inspection instance
Описание: Performs a complete replacement of a specific Advanced traffic inspection instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Advanced traffic inspection instance
Описание: Performs a selective update of a specific Advanced traffic inspection instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one modify response content instance
Описание: Creates a new Modify response content instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Modify response content instance
Описание: Performs a complete replacement of a specific Modify response content instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Modify response content instance
Описание: Performs a selective update of a specific Modify response content instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one http tcp multiplexing instance
Описание: Creates a new HTTP TCP multiplexing instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one HTTP TCP multiplexing instance
Описание: Performs a complete replacement of a specific HTTP TCP multiplexing instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one HTTP TCP multiplexing instance
Описание: Performs a selective update of a specific HTTP TCP multiplexing instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one http 1.0 header compatibility instance
Описание: Creates a new HTTP 1.0 header compatibility instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one HTTP 1.0 header compatibility instance
Описание: Performs a complete replacement of a specific HTTP 1.0 header compatibility instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one HTTP 1.0 header compatibility instance
Описание: Performs a selective update of a specific HTTP 1.0 header compatibility instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one provide prometheus service instance
Описание: Creates a new Provide Prometheus service instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Provide Prometheus service instance
Описание: Performs a complete replacement of a specific Provide Prometheus service instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Provide Prometheus service instance
Описание: Performs a selective update of a specific Provide Prometheus service instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one conditional silent log instance
Описание: Creates a new Conditional silent log instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Conditional silent log instance
Описание: Performs a complete replacement of a specific Conditional silent log instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Conditional silent log instance
Описание: Performs a selective update of a specific Conditional silent log instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one cors instance
Описание: Creates a new CORS instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one CORS instance
Описание: Performs a complete replacement of a specific CORS instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one CORS instance
Описание: Performs a selective update of a specific CORS instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one ip log masking instance
Описание: Creates a new Ip log masking instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Ip log masking instance
Описание: Performs a complete replacement of a specific Ip log masking instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Ip log masking instance
Описание: Performs a selective update of a specific Ip log masking instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one manual action instance
Описание: Creates a new Manual action instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Manual action instance
Описание: Performs a complete replacement of a specific Manual action instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Manual action instance
Описание: Performs a selective update of a specific Manual action instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one block instance
Описание: Creates a new Block instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Block instance
Описание: Performs a complete replacement of a specific Block instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Block instance
Описание: Performs a selective update of a specific Block instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one location redirection instance
Описание: Creates a new Location redirection instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Location redirection instance
Описание: Performs a complete replacement of a specific Location redirection instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Location redirection instance
Описание: Performs a selective update of a specific Location redirection instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one user authentication (on http request) instance
Описание: Creates a new User authentication (On HTTP request) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one User authentication (On HTTP request) instance
Описание: Performs a complete replacement of a specific User authentication (On HTTP request) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one User authentication (On HTTP request) instance
Описание: Performs a selective update of a specific User authentication (On HTTP request) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one set path instance
Описание: Creates a new Set path instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Set path instance
Описание: Performs a complete replacement of a specific Set path instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Set path instance
Описание: Performs a selective update of a specific Set path instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one set path + query instance
Описание: Creates a new Set path + query instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Set path + query instance
Описание: Performs a complete replacement of a specific Set path + query instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Set path + query instance
Описание: Performs a selective update of a specific Set path + query instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one url normalization instance
Описание: Creates a new URL normalization instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one URL normalization instance
Описание: Performs a complete replacement of a specific URL normalization instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one URL normalization instance
Описание: Performs a selective update of a specific URL normalization instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one cookie based connection persistency instance
Описание: Creates a new Cookie based connection persistency instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Cookie based connection persistency instance
Описание: Performs a complete replacement of a specific Cookie based connection persistency instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Cookie based connection persistency instance
Описание: Performs a selective update of a specific Cookie based connection persistency instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one tcp connection management instance
Описание: Creates a new TCP connection management instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one TCP connection management instance
Описание: Performs a complete replacement of a specific TCP connection management instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one TCP connection management instance
Описание: Performs a selective update of a specific TCP connection management instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one redirect for traffic manager errors instance
Описание: Creates a new Redirect for traffic manager errors instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Redirect for traffic manager errors instance
Описание: Performs a complete replacement of a specific Redirect for traffic manager errors instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Redirect for traffic manager errors instance
Описание: Performs a selective update of a specific Redirect for traffic manager errors instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one redirect for backend service errors instance
Описание: Creates a new Redirect for backend service errors instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Redirect for backend service errors instance
Описание: Performs a complete replacement of a specific Redirect for backend service errors instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Redirect for backend service errors instance
Описание: Performs a selective update of a specific Redirect for backend service errors instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one show content for traffic manager errors instance
Описание: Creates a new Show content for traffic manager errors instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Show content for traffic manager errors instance
Описание: Performs a complete replacement of a specific Show content for traffic manager errors instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Show content for traffic manager errors instance
Описание: Performs a selective update of a specific Show content for traffic manager errors instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one show content for backend service errors instance
Описание: Creates a new Show content for backend service errors instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Show content for backend service errors instance
Описание: Performs a complete replacement of a specific Show content for backend service errors instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Show content for backend service errors instance
Описание: Performs a selective update of a specific Show content for backend service errors instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one redirect to https instance
Описание: Creates a new Redirect to HTTPS instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Redirect to HTTPS instance
Описание: Performs a complete replacement of a specific Redirect to HTTPS instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Redirect to HTTPS instance
Описание: Performs a selective update of a specific Redirect to HTTPS instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one quarantine instance
Описание: Creates a new Quarantine instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbRules
CLI-команда: lb action add ?
Категория: lb / lbRules
Просмотреть документациюUpdate one Quarantine instance
Описание: Performs a complete replacement of a specific Quarantine instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbRules/[id]
CLI-команда: lb action set ?
Категория: lb / lbRules
Просмотреть документациюPartial update one Quarantine instance
Описание: Performs a selective update of a specific Quarantine instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbRules/[id]
CLI-команда: lb action update ?
Категория: lb / lbRules
Просмотреть документациюCreate one ip intelligence category condition instance
Описание: Creates a new IP intelligence category condition (IP reputation/intelligence-based filtering; with configurable blacklist category selection (botnets, proxies, tor, spam, scanners, malware C&C, etc.), real-time threat intelligence integration, automatic blacklist updates, geo-based threat detection, for IP reputation-based condition matching for security threat mitigation, automated blocking) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one IP intelligence category condition instance
Описание: Performs a complete replacement of a specific IP intelligence category condition (IP reputation/intelligence-based filtering; with configurable blacklist category selection (botnets, proxies, tor, spam, scanners, malware C&C, etc.), real-time threat intelligence integration, automatic blacklist updates, geo-based threat detection, for IP reputation-based condition matching for security threat mitigation, automated blocking) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one IP intelligence category condition instance
Описание: Performs a selective update of a specific IP intelligence category condition (IP reputation/intelligence-based filtering; with configurable blacklist category selection (botnets, proxies, tor, spam, scanners, malware C&C, etc.), real-time threat intelligence integration, automatic blacklist updates, geo-based threat detection, for IP reputation-based condition matching for security threat mitigation, automated blocking) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http request body condition instance
Описание: Creates a new HTTP request body condition (HTTP request body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for request payload inspection, JSON/XML content filtering, API request validation, content-based routing, payload security inspection) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP request body condition instance
Описание: Performs a complete replacement of a specific HTTP request body condition (HTTP request body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for request payload inspection, JSON/XML content filtering, API request validation, content-based routing, payload security inspection) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP request body condition instance
Описание: Performs a selective update of a specific HTTP request body condition (HTTP request body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for request payload inspection, JSON/XML content filtering, API request validation, content-based routing, payload security inspection) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http response body condition instance
Описание: Creates a new HTTP response body condition (HTTP response body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for backend response inspection, JSON/XML response filtering, API response validation, response content-based actions, response pattern detection) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP response body condition instance
Описание: Performs a complete replacement of a specific HTTP response body condition (HTTP response body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for backend response inspection, JSON/XML response filtering, API response validation, response content-based actions, response pattern detection) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP response body condition instance
Описание: Performs a selective update of a specific HTTP response body condition (HTTP response body content matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, body size threshold, for backend response inspection, JSON/XML response filtering, API response validation, response content-based actions, response pattern detection) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one url list condition instance
Описание: Creates a new URL list condition (response-based URL list matching condition; with dynamic URL list matching, backend response-based URL validation, list-based routing, URL whitelist/blacklist, dynamic content filtering, response-driven URL validation) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one URL list condition instance
Описание: Performs a complete replacement of a specific URL list condition (response-based URL list matching condition; with dynamic URL list matching, backend response-based URL validation, list-based routing, URL whitelist/blacklist, dynamic content filtering, response-driven URL validation) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one URL list condition instance
Описание: Performs a selective update of a specific URL list condition (response-based URL list matching condition; with dynamic URL list matching, backend response-based URL validation, list-based routing, URL whitelist/blacklist, dynamic content filtering, response-driven URL validation) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one dynamic list instance
Описание: Creates a new Dynamic list (custom dynamic list matching condition; with custom map file usage, dynamic key-value matching, runtime updatable lists, flexible pattern matching, customizable routing logic, dynamic rule sets) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Dynamic list instance
Описание: Performs a complete replacement of a specific Dynamic list (custom dynamic list matching condition; with custom map file usage, dynamic key-value matching, runtime updatable lists, flexible pattern matching, customizable routing logic, dynamic rule sets) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Dynamic list instance
Описание: Performs a selective update of a specific Dynamic list (custom dynamic list matching condition; with custom map file usage, dynamic key-value matching, runtime updatable lists, flexible pattern matching, customizable routing logic, dynamic rule sets) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http query parameter condition instance
Описание: Creates a new HTTP query parameter condition (query parameter matching condition; with configurable parameter name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (parameter existence check), for parameter-based routing, API versioning, feature flag detection, A/B testing routing) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP query parameter condition instance
Описание: Performs a complete replacement of a specific HTTP query parameter condition (query parameter matching condition; with configurable parameter name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (parameter existence check), for parameter-based routing, API versioning, feature flag detection, A/B testing routing) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP query parameter condition instance
Описание: Performs a selective update of a specific HTTP query parameter condition (query parameter matching condition; with configurable parameter name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (parameter existence check), for parameter-based routing, API versioning, feature flag detection, A/B testing routing) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one browser condition instance
Описание: Creates a new browser condition (browser type detection condition; with multiple browser selection (Chrome, Firefox, Safari, Edge, Opera, IE, etc.), User-Agent header parsing, for browser-based routing, browser-specific optimization, compatibility routing, browser version detection, legacy browser handling) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one browser condition instance
Описание: Performs a complete replacement of a specific browser condition (browser type detection condition; with multiple browser selection (Chrome, Firefox, Safari, Edge, Opera, IE, etc.), User-Agent header parsing, for browser-based routing, browser-specific optimization, compatibility routing, browser version detection, legacy browser handling) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one browser condition instance
Описание: Performs a selective update of a specific browser condition (browser type detection condition; with multiple browser selection (Chrome, Firefox, Safari, Edge, Opera, IE, etc.), User-Agent header parsing, for browser-based routing, browser-specific optimization, compatibility routing, browser version detection, legacy browser handling) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one mobile platform condition instance
Описание: Creates a new mobile platform condition (mobile platform detection condition; with multiple platform selection (iOS, Android, Windows Phone, etc.), User-Agent parsing, for mobile device detection, responsive routing, mobile-specific routing, platform-based optimization, mobile app integration) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one mobile platform condition instance
Описание: Performs a complete replacement of a specific mobile platform condition (mobile platform detection condition; with multiple platform selection (iOS, Android, Windows Phone, etc.), User-Agent parsing, for mobile device detection, responsive routing, mobile-specific routing, platform-based optimization, mobile app integration) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one mobile platform condition instance
Описание: Performs a selective update of a specific mobile platform condition (mobile platform detection condition; with multiple platform selection (iOS, Android, Windows Phone, etc.), User-Agent parsing, for mobile device detection, responsive routing, mobile-specific routing, platform-based optimization, mobile app integration) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one bot type condition instance
Описание: Creates a new bot type condition (bot type detection condition; with multiple bot selection (Googlebot, Bingbot, crawler, scraper, etc.), User-Agent pattern matching, for bot detection, bot traffic routing, crawler management, bot rate limiting, SEO bot handling, scraper blocking) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one bot type condition instance
Описание: Performs a complete replacement of a specific bot type condition (bot type detection condition; with multiple bot selection (Googlebot, Bingbot, crawler, scraper, etc.), User-Agent pattern matching, for bot detection, bot traffic routing, crawler management, bot rate limiting, SEO bot handling, scraper blocking) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one bot type condition instance
Описание: Performs a selective update of a specific bot type condition (bot type detection condition; with multiple bot selection (Googlebot, Bingbot, crawler, scraper, etc.), User-Agent pattern matching, for bot detection, bot traffic routing, crawler management, bot rate limiting, SEO bot handling, scraper blocking) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http header condition instance
Описание: Creates a new HTTP header condition (HTTP header matching condition; with configurable header name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (header existence check), for custom header routing, API key validation, client identification, content negotiation, header-based access control) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP header condition instance
Описание: Performs a complete replacement of a specific HTTP header condition (HTTP header matching condition; with configurable header name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (header existence check), for custom header routing, API key validation, client identification, content negotiation, header-based access control) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP header condition instance
Описание: Performs a selective update of a specific HTTP header condition (HTTP header matching condition; with configurable header name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (header existence check), for custom header routing, API key validation, client identification, content negotiation, header-based access control) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http path condition instance
Описание: Creates a new HTTP path condition (URL path matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for path-based routing, API endpoint detection, URL pattern filtering, REST API routing, path-based access control) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP path condition instance
Описание: Performs a complete replacement of a specific HTTP path condition (URL path matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for path-based routing, API endpoint detection, URL pattern filtering, REST API routing, path-based access control) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP path condition instance
Описание: Performs a selective update of a specific HTTP path condition (URL path matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for path-based routing, API endpoint detection, URL pattern filtering, REST API routing, path-based access control) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http path+query condition instance
Описание: Creates a new HTTP path+query condition (URL path + query string matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for combined path/query routing, parameterized URL patterns, query-aware routing, advanced URL matching) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP path+query condition instance
Описание: Performs a complete replacement of a specific HTTP path+query condition (URL path + query string matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for combined path/query routing, parameterized URL patterns, query-aware routing, advanced URL matching) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP path+query condition instance
Описание: Performs a selective update of a specific HTTP path+query condition (URL path + query string matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for combined path/query routing, parameterized URL patterns, query-aware routing, advanced URL matching) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http url condition instance
Описание: Creates a new HTTP URL condition (full URL matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for complete URL matching including protocol/host/path/query, virtual host routing, domain-based routing, absolute URL filtering) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP URL condition instance
Описание: Performs a complete replacement of a specific HTTP URL condition (full URL matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for complete URL matching including protocol/host/path/query, virtual host routing, domain-based routing, absolute URL filtering) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP URL condition instance
Описание: Performs a selective update of a specific HTTP URL condition (full URL matching condition; with content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for complete URL matching including protocol/host/path/query, virtual host routing, domain-based routing, absolute URL filtering) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one http status code condition instance
Описание: Creates a new HTTP status code condition (HTTP status code matching condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable code value, for status code-based routing, error page redirection, success/error differentiation, status code filtering, custom error handling) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one HTTP status code condition instance
Описание: Performs a complete replacement of a specific HTTP status code condition (HTTP status code matching condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable code value, for status code-based routing, error page redirection, success/error differentiation, status code filtering, custom error handling) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one HTTP status code condition instance
Описание: Performs a selective update of a specific HTTP status code condition (HTTP status code matching condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable code value, for status code-based routing, error page redirection, success/error differentiation, status code filtering, custom error handling) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one source ip address condition instance
Описание: Creates a new source IP address condition (source IP address matching; with multiple IP matching types: geo-based filtering, manual IP/CIDR list (subnet support), ASN-based (autonomous system number), for flexible source IP matching for geo-targeting, access control, regional traffic management, IP whitelist/blacklist) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one source IP address condition instance
Описание: Performs a complete replacement of a specific source IP address condition (source IP address matching; with multiple IP matching types: geo-based filtering, manual IP/CIDR list (subnet support), ASN-based (autonomous system number), for flexible source IP matching for geo-targeting, access control, regional traffic management, IP whitelist/blacklist) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one source IP address condition instance
Описание: Performs a selective update of a specific source IP address condition (source IP address matching; with multiple IP matching types: geo-based filtering, manual IP/CIDR list (subnet support), ASN-based (autonomous system number), for flexible source IP matching for geo-targeting, access control, regional traffic management, IP whitelist/blacklist) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one destination ip address condition instance
Описание: Creates a new destination IP address condition (destination IP address matching; with single IP address exact match, for destination IP address condition for virtual IP detection, multi-homed server routing, destination-based routing, IP-based service differentiation) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one destination IP address condition instance
Описание: Performs a complete replacement of a specific destination IP address condition (destination IP address matching; with single IP address exact match, for destination IP address condition for virtual IP detection, multi-homed server routing, destination-based routing, IP-based service differentiation) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one destination IP address condition instance
Описание: Performs a selective update of a specific destination IP address condition (destination IP address matching; with single IP address exact match, for destination IP address condition for virtual IP detection, multi-homed server routing, destination-based routing, IP-based service differentiation) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one destination port condition instance
Описание: Creates a new destination port condition (destination port matching; with operator-based comparison (=, !=, >, <, >=, <=), configurable port value, for destination port condition for port-based routing, service port detection, multi-service load balancing, port-based ACL) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one destination port condition instance
Описание: Performs a complete replacement of a specific destination port condition (destination port matching; with operator-based comparison (=, !=, >, <, >=, <=), configurable port value, for destination port condition for port-based routing, service port detection, multi-service load balancing, port-based ACL) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one destination port condition instance
Описание: Performs a selective update of a specific destination port condition (destination port matching; with operator-based comparison (=, !=, >, <, >=, <=), configurable port value, for destination port condition for port-based routing, service port detection, multi-service load balancing, port-based ACL) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one response time condition instance
Описание: Creates a new response time condition (backend response time threshold condition; with operator-based comparison (=, !=, >, <, >=, <=), duration value in milliseconds, for slow backend detection, performance-based routing, timeout handling, SLA monitoring, performance threshold alerts) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one response time condition instance
Описание: Performs a complete replacement of a specific response time condition (backend response time threshold condition; with operator-based comparison (=, !=, >, <, >=, <=), duration value in milliseconds, for slow backend detection, performance-based routing, timeout handling, SLA monitoring, performance threshold alerts) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one response time condition instance
Описание: Performs a selective update of a specific response time condition (backend response time threshold condition; with operator-based comparison (=, !=, >, <, >=, <=), duration value in milliseconds, for slow backend detection, performance-based routing, timeout handling, SLA monitoring, performance threshold alerts) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one client cookie condition instance
Описание: Creates a new client cookie condition (client cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for session tracking, user identification, cookie-based routing, authentication cookie validation) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one client cookie condition instance
Описание: Performs a complete replacement of a specific client cookie condition (client cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for session tracking, user identification, cookie-based routing, authentication cookie validation) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one client cookie condition instance
Описание: Performs a selective update of a specific client cookie condition (client cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for session tracking, user identification, cookie-based routing, authentication cookie validation) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one server cookie condition instance
Описание: Creates a new server cookie condition (backend server cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for backend session tracking, server-set cookie inspection, backend authentication validation) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one server cookie condition instance
Описание: Performs a complete replacement of a specific server cookie condition (backend server cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for backend session tracking, server-set cookie inspection, backend authentication validation) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one server cookie condition instance
Описание: Performs a selective update of a specific server cookie condition (backend server cookie matching condition; with configurable cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for backend session tracking, server-set cookie inspection, backend authentication validation) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one number of active servers instance
Описание: Creates a new Number of active servers (healthy backend server count condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable count value, for healthy backend detection, capacity-based routing, auto-scaling trigger, high availability control, backend pool health monitoring) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Number of active servers instance
Описание: Performs a complete replacement of a specific Number of active servers (healthy backend server count condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable count value, for healthy backend detection, capacity-based routing, auto-scaling trigger, high availability control, backend pool health monitoring) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Number of active servers instance
Описание: Performs a selective update of a specific Number of active servers (healthy backend server count condition; with operator-based comparison (=, !=, >, <, >=, <=), configurable count value, for healthy backend detection, capacity-based routing, auto-scaling trigger, high availability control, backend pool health monitoring) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one ssl cipher condition instance
Описание: Creates a new SSL cipher condition (SSL cipher suite matching; with cipher name content matching (exactMatch/start/end/sub/regex), for SSL cipher suite condition for cipher strength validation, weak cipher detection, cipher suite whitelisting, security compliance (PCI DSS, HIPAA), TLS configuration enforcement) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one SSL cipher condition instance
Описание: Performs a complete replacement of a specific SSL cipher condition (SSL cipher suite matching; with cipher name content matching (exactMatch/start/end/sub/regex), for SSL cipher suite condition for cipher strength validation, weak cipher detection, cipher suite whitelisting, security compliance (PCI DSS, HIPAA), TLS configuration enforcement) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one SSL cipher condition instance
Описание: Performs a selective update of a specific SSL cipher condition (SSL cipher suite matching; with cipher name content matching (exactMatch/start/end/sub/regex), for SSL cipher suite condition for cipher strength validation, weak cipher detection, cipher suite whitelisting, security compliance (PCI DSS, HIPAA), TLS configuration enforcement) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one ssl version condition instance
Описание: Creates a new SSL version condition (SSL/TLS protocol version matching; with version content matching (SSLv3, TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3), for SSL/TLS version condition for deprecated protocol detection, TLS version enforcement, security compliance, protocol-based routing, minimum TLS version policy) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one SSL version condition instance
Описание: Performs a complete replacement of a specific SSL version condition (SSL/TLS protocol version matching; with version content matching (SSLv3, TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3), for SSL/TLS version condition for deprecated protocol detection, TLS version enforcement, security compliance, protocol-based routing, minimum TLS version policy) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one SSL version condition instance
Описание: Performs a selective update of a specific SSL version condition (SSL/TLS protocol version matching; with version content matching (SSLv3, TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3), for SSL/TLS version condition for deprecated protocol detection, TLS version enforcement, security compliance, protocol-based routing, minimum TLS version policy) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one ssl sni info instance
Описание: Creates a new SSL SNI info (SSL SNI information condition; with Server Name Indication sent by client during SSL/TLS handshake, content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for SNI-based virtual hosting, SSL passthrough routing, domain-based SSL routing, multi-tenant SSL configuration) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one SSL SNI info instance
Описание: Performs a complete replacement of a specific SSL SNI info (SSL SNI information condition; with Server Name Indication sent by client during SSL/TLS handshake, content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for SNI-based virtual hosting, SSL passthrough routing, domain-based SSL routing, multi-tenant SSL configuration) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one SSL SNI info instance
Описание: Performs a selective update of a specific SSL SNI info (SSL SNI information condition; with Server Name Indication sent by client during SSL/TLS handshake, content matching methods (exactMatch/start/end/sub/regex), case-insensitive option, for SNI-based virtual hosting, SSL passthrough routing, domain-based SSL routing, multi-tenant SSL configuration) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one request size (bytes) instance
Описание: Creates a new Request size (bytes) (HTTP request size condition; with operator-based comparison (=, !=, >, <, >=, <=), request size in bytes, for large request filtering, upload size limiting, payload size validation, DoS attack mitigation, bandwidth management) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Request size (bytes) instance
Описание: Performs a complete replacement of a specific Request size (bytes) (HTTP request size condition; with operator-based comparison (=, !=, >, <, >=, <=), request size in bytes, for large request filtering, upload size limiting, payload size validation, DoS attack mitigation, bandwidth management) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Request size (bytes) instance
Описание: Performs a selective update of a specific Request size (bytes) (HTTP request size condition; with operator-based comparison (=, !=, >, <, >=, <=), request size in bytes, for large request filtering, upload size limiting, payload size validation, DoS attack mitigation, bandwidth management) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one response size (bytes) instance
Описание: Creates a new Response size (bytes) (HTTP response size condition; with operator-based comparison (=, !=, >, <, >=, <=), response size in bytes, for large response detection, download size monitoring, bandwidth optimization, response size-based routing, cache decision) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Response size (bytes) instance
Описание: Performs a complete replacement of a specific Response size (bytes) (HTTP response size condition; with operator-based comparison (=, !=, >, <, >=, <=), response size in bytes, for large response detection, download size monitoring, bandwidth optimization, response size-based routing, cache decision) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Response size (bytes) instance
Описание: Performs a selective update of a specific Response size (bytes) (HTTP response size condition; with operator-based comparison (=, !=, >, <, >=, <=), response size in bytes, for large response detection, download size monitoring, bandwidth optimization, response size-based routing, cache decision) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one user authentication instance
Описание: Creates a new User authentication (HTTP authentication status condition; with HTTP Basic/Digest authentication success status check, for authenticated user detection, authorization-based routing, protected resource access verification, user authentication validation, security policy enforcement) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one User authentication instance
Описание: Performs a complete replacement of a specific User authentication (HTTP authentication status condition; with HTTP Basic/Digest authentication success status check, for authenticated user detection, authorization-based routing, protected resource access verification, user authentication validation, security policy enforcement) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one User authentication instance
Описание: Performs a selective update of a specific User authentication (HTTP authentication status condition; with HTTP Basic/Digest authentication success status check, for authenticated user detection, authorization-based routing, protected resource access verification, user authentication validation, security policy enforcement) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one frontend connection instance
Описание: Creates a new Frontend connection (frontend connection count condition; with operator-based comparison (=, !=, >, <, >=, <=), current connection count, for load-based routing, connection limit enforcement, overload protection, capacity management, connection-based throttling) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Frontend connection instance
Описание: Performs a complete replacement of a specific Frontend connection (frontend connection count condition; with operator-based comparison (=, !=, >, <, >=, <=), current connection count, for load-based routing, connection limit enforcement, overload protection, capacity management, connection-based throttling) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Frontend connection instance
Описание: Performs a selective update of a specific Frontend connection (frontend connection count condition; with operator-based comparison (=, !=, >, <, >=, <=), current connection count, for load-based routing, connection limit enforcement, overload protection, capacity management, connection-based throttling) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one frontend number of new sessions / s instance
Описание: Creates a new Frontend number of new sessions / s (frontend session rate condition; with operator-based comparison (=, !=, >, <, >=, <=), new sessions per second value, for rate limiting, traffic spike detection, DDoS mitigation, session rate throttling, burst traffic handling) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Frontend number of new sessions / s instance
Описание: Performs a complete replacement of a specific Frontend number of new sessions / s (frontend session rate condition; with operator-based comparison (=, !=, >, <, >=, <=), new sessions per second value, for rate limiting, traffic spike detection, DDoS mitigation, session rate throttling, burst traffic handling) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Frontend number of new sessions / s instance
Описание: Performs a selective update of a specific Frontend number of new sessions / s (frontend session rate condition; with operator-based comparison (=, !=, >, <, >=, <=), new sessions per second value, for rate limiting, traffic spike detection, DDoS mitigation, session rate throttling, burst traffic handling) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one frontend number of http requests / s instance
Описание: Creates a new Frontend number of HTTP requests / s (frontend HTTP request rate condition; with operator-based comparison (=, !=, >, <, >=, <=), HTTP requests per second value, for request rate limiting, traffic pattern detection, API throttling, burst protection, request-based load shedding) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Frontend number of HTTP requests / s instance
Описание: Performs a complete replacement of a specific Frontend number of HTTP requests / s (frontend HTTP request rate condition; with operator-based comparison (=, !=, >, <, >=, <=), HTTP requests per second value, for request rate limiting, traffic pattern detection, API throttling, burst protection, request-based load shedding) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Frontend number of HTTP requests / s instance
Описание: Performs a selective update of a specific Frontend number of HTTP requests / s (frontend HTTP request rate condition; with operator-based comparison (=, !=, >, <, >=, <=), HTTP requests per second value, for request rate limiting, traffic pattern detection, API throttling, burst protection, request-based load shedding) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one rdp cookie instance
Описание: Creates a new RDP cookie (RDP cookie condition; with configurable RDP cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for RDP session persistence, RDP load balancing, Terminal Services routing, Windows Remote Desktop load distribution) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one RDP cookie instance
Описание: Performs a complete replacement of a specific RDP cookie (RDP cookie condition; with configurable RDP cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for RDP session persistence, RDP load balancing, Terminal Services routing, Windows Remote Desktop load distribution) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one RDP cookie instance
Описание: Performs a selective update of a specific RDP cookie (RDP cookie condition; with configurable RDP cookie name, content matching methods (exactMatch/start/end/sub/regex/found), case-insensitive option, found mode (cookie existence check), for RDP session persistence, RDP load balancing, Terminal Services routing, Windows Remote Desktop load distribution) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one manual condition instance
Описание: Creates a new Manual condition (manual HAProxy condition; with custom HAProxy ACL syntax for custom condition definition, advanced HAProxy features access, expert-level condition configuration, flexible custom logic) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbConditions
CLI-команда: lb condition add ?
Категория: lb / lbConditions
Просмотреть документациюUpdate one Manual condition instance
Описание: Performs a complete replacement of a specific Manual condition (manual HAProxy condition; with custom HAProxy ACL syntax for custom condition definition, advanced HAProxy features access, expert-level condition configuration, flexible custom logic) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition set ?
Категория: lb / lbConditions
Просмотреть документациюPartial update one Manual condition instance
Описание: Performs a selective update of a specific Manual condition (manual HAProxy condition; with custom HAProxy ACL syntax for custom condition definition, advanced HAProxy features access, expert-level condition configuration, flexible custom logic) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbConditions/[id]
CLI-команда: lb condition update ?
Категория: lb / lbConditions
Просмотреть документациюCreate one acme.sh instance
Описание: Creates a new ACME.sh instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbCertificates
CLI-команда: lb certificate add ?
Категория: lb / lbCertificates
Просмотреть документациюUpdate one ACME.sh instance
Описание: Performs a complete replacement of a specific ACME.sh instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate set ?
Категория: lb / lbCertificates
Просмотреть документациюPartial update one ACME.sh instance
Описание: Performs a selective update of a specific ACME.sh instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate update ?
Категория: lb / lbCertificates
Просмотреть документациюCreate one manual instance
Описание: Creates a new manual instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbCertificates
CLI-команда: lb certificate add ?
Категория: lb / lbCertificates
Просмотреть документациюUpdate one manual instance
Описание: Performs a complete replacement of a specific manual instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate set ?
Категория: lb / lbCertificates
Просмотреть документациюPartial update one manual instance
Описание: Performs a selective update of a specific manual instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate update ?
Категория: lb / lbCertificates
Просмотреть документациюCreate one pfx instance
Описание: Creates a new PFX instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/lbCertificates
CLI-команда: lb certificate add ?
Категория: lb / lbCertificates
Просмотреть документациюUpdate one PFX instance
Описание: Performs a complete replacement of a specific PFX instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate set ?
Категория: lb / lbCertificates
Просмотреть документациюPartial update one PFX instance
Описание: Performs a selective update of a specific PFX instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/lbCertificates/[id]
CLI-команда: lb certificate update ?
Категория: lb / lbCertificates
Просмотреть документациюCreate one ca instance
Описание: Creates a new certificate authority profile (a stored root or intermediate CA certificate that can be referenced when configuring SSL certificates to establish the certificate chain of trust) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbCertificateAuthorities
CLI-команда: lb ca add ?
Категория: lb / profiles
Просмотреть документациюUpdate one CA instance
Описание: Performs a complete replacement of a specific certificate authority profile (a stored root or intermediate CA certificate that can be referenced when configuring SSL certificates to establish the certificate chain of trust) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbCertificateAuthorities/[id]
CLI-команда: lb ca set ?
Категория: lb / profiles
Просмотреть документациюPartial update one CA instance
Описание: Performs a selective update of a specific certificate authority profile (a stored root or intermediate CA certificate that can be referenced when configuring SSL certificates to establish the certificate chain of trust) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbCertificateAuthorities/[id]
CLI-команда: lb ca update ?
Категория: lb / profiles
Просмотреть документациюCreate one cache instance
Описание: Creates a new cache profile (an HTTP caching configuration that accelerates content delivery by storing backend responses with configurable expiration timeout, size limits, conditional caching rules, and dynamic cache key generation using custom variables for granular control) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbCaches
CLI-команда: lb cache add ?
Категория: lb / profiles
Просмотреть документациюUpdate one cache instance
Описание: Performs a complete replacement of a specific cache profile (an HTTP caching configuration that accelerates content delivery by storing backend responses with configurable expiration timeout, size limits, conditional caching rules, and dynamic cache key generation using custom variables for granular control) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbCaches/[id]
CLI-команда: lb cache set ?
Категория: lb / profiles
Просмотреть документациюPartial update one cache instance
Описание: Performs a selective update of a specific cache profile (an HTTP caching configuration that accelerates content delivery by storing backend responses with configurable expiration timeout, size limits, conditional caching rules, and dynamic cache key generation using custom variables for granular control) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbCaches/[id]
CLI-команда: lb cache update ?
Категория: lb / profiles
Просмотреть документациюCreate one compression instance
Описание: Creates a new compression profile (a configuration that reduces bandwidth usage and speeds up content delivery by compressing responses using algorithms like gzip or brotli with adjustable compression levels and MIME type filtering) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbCompressions
CLI-команда: lb compression add ?
Категория: lb / profiles
Просмотреть документациюUpdate one compression instance
Описание: Performs a complete replacement of a specific compression profile (a configuration that reduces bandwidth usage and speeds up content delivery by compressing responses using algorithms like gzip or brotli with adjustable compression levels and MIME type filtering) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbCompressions/[id]
CLI-команда: lb compression set ?
Категория: lb / profiles
Просмотреть документациюPartial update one compression instance
Описание: Performs a selective update of a specific compression profile (a configuration that reduces bandwidth usage and speeds up content delivery by compressing responses using algorithms like gzip or brotli with adjustable compression levels and MIME type filtering) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbCompressions/[id]
CLI-команда: lb compression update ?
Категория: lb / profiles
Просмотреть документациюCreate one log instance
Описание: Creates a new log profile (a configuration for sending vService access and error logs to external log servers with configurable destination addresses, sampling rates, log standards like RFC3164 or RFC5424, and custom line formats supporting CEF and JSON structured logging for SIEM integration) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbLogs
CLI-команда: lb log add ?
Категория: lb / profiles
Просмотреть документациюUpdate one log instance
Описание: Performs a complete replacement of a specific log profile (a configuration for sending vService access and error logs to external log servers with configurable destination addresses, sampling rates, log standards like RFC3164 or RFC5424, and custom line formats supporting CEF and JSON structured logging for SIEM integration) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbLogs/[id]
CLI-команда: lb log set ?
Категория: lb / profiles
Просмотреть документациюPartial update one log instance
Описание: Performs a selective update of a specific log profile (a configuration for sending vService access and error logs to external log servers with configurable destination addresses, sampling rates, log standards like RFC3164 or RFC5424, and custom line formats supporting CEF and JSON structured logging for SIEM integration) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbLogs/[id]
CLI-команда: lb log update ?
Категория: lb / profiles
Просмотреть документациюCreate one notification instance
Описание: Creates a new notification profile (an alerting configuration that notifies administrators via SNMP, email, or UI about critical events including backend and frontend service status changes, performance threshold breaches for bandwidth/requests/sessions/connections, and certificate expiration warnings) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbNotifications
CLI-команда: lb notification add ?
Категория: lb / profiles
Просмотреть документациюUpdate one notification instance
Описание: Performs a complete replacement of a specific notification profile (an alerting configuration that notifies administrators via SNMP, email, or UI about critical events including backend and frontend service status changes, performance threshold breaches for bandwidth/requests/sessions/connections, and certificate expiration warnings) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbNotifications/[id]
CLI-команда: lb notification set ?
Категория: lb / profiles
Просмотреть документациюPartial update one notification instance
Описание: Performs a selective update of a specific notification profile (an alerting configuration that notifies administrators via SNMP, email, or UI about critical events including backend and frontend service status changes, performance threshold breaches for bandwidth/requests/sessions/connections, and certificate expiration warnings) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbNotifications/[id]
CLI-команда: lb notification update ?
Категория: lb / profiles
Просмотреть документациюCreate one page content instance
Описание: Creates a new page content (a custom content definition with configurable MIME type and dynamic content supporting variables, used for custom error pages, custom responses, or content injection by actions) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbPageContents
CLI-команда: lb page add ?
Категория: lb / profiles
Просмотреть документациюUpdate one page content instance
Описание: Performs a complete replacement of a specific page content (a custom content definition with configurable MIME type and dynamic content supporting variables, used for custom error pages, custom responses, or content injection by actions) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbPageContents/[id]
CLI-команда: lb page set ?
Категория: lb / profiles
Просмотреть документациюPartial update one page content instance
Описание: Performs a selective update of a specific page content (a custom content definition with configurable MIME type and dynamic content supporting variables, used for custom error pages, custom responses, or content injection by actions) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbPageContents/[id]
CLI-команда: lb page update ?
Категория: lb / profiles
Просмотреть документациюCreate one frontend limits instance
Описание: Creates a new frontend limits profile (a protection configuration that prevents vService resource exhaustion by setting maximum thresholds for concurrent connections, connection rates, session rates, SSL connections, retry attempts, and buffer sizes to mitigate DoS attacks and ensure stable operation) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbPoolLimits
CLI-команда: lb limits add ?
Категория: lb / profiles
Просмотреть документациюUpdate one frontend limits instance
Описание: Performs a complete replacement of a specific frontend limits profile (a protection configuration that prevents vService resource exhaustion by setting maximum thresholds for concurrent connections, connection rates, session rates, SSL connections, retry attempts, and buffer sizes to mitigate DoS attacks and ensure stable operation) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbPoolLimits/[id]
CLI-команда: lb limits set ?
Категория: lb / profiles
Просмотреть документациюPartial update one frontend limits instance
Описание: Performs a selective update of a specific frontend limits profile (a protection configuration that prevents vService resource exhaustion by setting maximum thresholds for concurrent connections, connection rates, session rates, SSL connections, retry attempts, and buffer sizes to mitigate DoS attacks and ensure stable operation) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbPoolLimits/[id]
CLI-команда: lb limits update ?
Категория: lb / profiles
Просмотреть документациюCreate one report instance
Описание: Creates a new report profile (a configuration for generating and delivering scheduled performance reports with customizable sections, frontend and backend statistics graphs, export formats including PDF, XLSX, and CSV, and email delivery options with daily, weekly, or monthly frequency) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbReports
CLI-команда: lb report add ?
Категория: lb / profiles
Просмотреть документациюUpdate one report instance
Описание: Performs a complete replacement of a specific report profile (a configuration for generating and delivering scheduled performance reports with customizable sections, frontend and backend statistics graphs, export formats including PDF, XLSX, and CSV, and email delivery options with daily, weekly, or monthly frequency) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbReports/[id]
CLI-команда: lb report set ?
Категория: lb / profiles
Просмотреть документациюPartial update one report instance
Описание: Performs a selective update of a specific report profile (a configuration for generating and delivering scheduled performance reports with customizable sections, frontend and backend statistics graphs, export formats including PDF, XLSX, and CSV, and email delivery options with daily, weekly, or monthly frequency) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbReports/[id]
CLI-команда: lb report update ?
Категория: lb / profiles
Просмотреть документациюCreate one ssl security instance
Описание: Creates a new SSL security profile (a configuration defining allowed TLS protocol versions, cipher algorithm suites, ECDHE curves, TLS ticket behavior, and hardware acceleration options to control SSL/TLS connection security and performance) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbSecurities
CLI-команда: lb ssl-security add ?
Категория: lb / profiles
Просмотреть документациюUpdate one SSL security instance
Описание: Performs a complete replacement of a specific SSL security profile (a configuration defining allowed TLS protocol versions, cipher algorithm suites, ECDHE curves, TLS ticket behavior, and hardware acceleration options to control SSL/TLS connection security and performance) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbSecurities/[id]
CLI-команда: lb ssl-security set ?
Категория: lb / profiles
Просмотреть документациюPartial update one SSL security instance
Описание: Performs a selective update of a specific SSL security profile (a configuration defining allowed TLS protocol versions, cipher algorithm suites, ECDHE curves, TLS ticket behavior, and hardware acceleration options to control SSL/TLS connection security and performance) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbSecurities/[id]
CLI-команда: lb ssl-security update ?
Категория: lb / profiles
Просмотреть документациюCreate one timeout instance
Описание: Creates a new timeout profile (a configuration controlling connection lifecycle including HTTP keepalive, request/response timeouts, backend connection establishment, client inactivity, queueing, WebSocket tunnels, and TCP FIN handling to prevent resource exhaustion and optimize performance) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /lb/profiles/lbTimeouts
CLI-команда: lb timeouts add ?
Категория: lb / profiles
Просмотреть документациюUpdate one timeout instance
Описание: Performs a complete replacement of a specific timeout profile (a configuration controlling connection lifecycle including HTTP keepalive, request/response timeouts, backend connection establishment, client inactivity, queueing, WebSocket tunnels, and TCP FIN handling to prevent resource exhaustion and optimize performance) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /lb/profiles/lbTimeouts/[id]
CLI-команда: lb timeouts set ?
Категория: lb / profiles
Просмотреть документациюPartial update one timeout instance
Описание: Performs a selective update of a specific timeout profile (a configuration controlling connection lifecycle including HTTP keepalive, request/response timeouts, backend connection establishment, client inactivity, queueing, WebSocket tunnels, and TCP FIN handling to prevent resource exhaustion and optimize performance) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /lb/profiles/lbTimeouts/[id]
CLI-команда: lb timeouts update ?
Категория: lb / profiles
Просмотреть документациюCreate one vdevice instance
Описание: Creates a new vDevice (a virtual device providing tenant isolation with dedicated CPU cores, memory allocation, network interfaces, and separate storage for application data and logging, enabling secure multi-tenant operation with complete resource separation and independent network namespaces) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /zones
CLI-команда: v-device add ?
Категория: zones /
Просмотреть документациюUpdate one vDevice instance
Описание: Performs a complete replacement of a specific vDevice (a virtual device providing tenant isolation with dedicated CPU cores, memory allocation, network interfaces, and separate storage for application data and logging, enabling secure multi-tenant operation with complete resource separation and independent network namespaces) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /zones/[id]
CLI-команда: v-device set ?
Категория: zones /
Просмотреть документациюPartial update one vDevice instance
Описание: Performs a selective update of a specific vDevice (a virtual device providing tenant isolation with dedicated CPU cores, memory allocation, network interfaces, and separate storage for application data and logging, enabling secure multi-tenant operation with complete resource separation and independent network namespaces) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /zones/[id]
CLI-команда: v-device update ?
Категория: zones /
Просмотреть документациюCreate one user instance
Описание: Creates a new user account (a system user with role-based access control supporting local and LDAP authentication, configurable permissions for vDevices, vServices, backends, and certificates, SSH and web CLI access options, and granular resource restrictions for multi-tenant environments) instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /users
CLI-команда: users add ?
Категория: users /
Просмотреть документациюUpdate one user instance
Описание: Performs a complete replacement of a specific user account (a system user with role-based access control supporting local and LDAP authentication, configurable permissions for vDevices, vServices, backends, and certificates, SSH and web CLI access options, and granular resource restrictions for multi-tenant environments) instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /users/[username]
CLI-команда: users set ?
Категория: users /
Просмотреть документациюPartial update one user instance
Описание: Performs a selective update of a specific user account (a system user with role-based access control supporting local and LDAP authentication, configurable permissions for vDevices, vServices, backends, and certificates, SSH and web CLI access options, and granular resource restrictions for multi-tenant environments) instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /users/[username]
CLI-команда: users update ?
Категория: users /
Просмотреть документациюShow access
Описание: Retrieves the complete current configuration of access configuration (system access control managing HTTP(S), SSH, FTP, and SNMP interfaces with IP/port bindings, network whitelisting, CAPTCHA and two-factor authentication protection, session duration limits, failed login rate limiting with IP-based quarantine, and system user permissions for secure administrative access). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/access
CLI-команда: settings access show ?
Категория: settings / access
Просмотреть документациюPartial update access
Описание: Performs a selective update of access configuration (system access control managing HTTP(S), SSH, FTP, and SNMP interfaces with IP/port bindings, network whitelisting, CAPTCHA and two-factor authentication protection, session duration limits, failed login rate limiting with IP-based quarantine, and system user permissions for secure administrative access) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/access
CLI-команда: settings access update ?
Категория: settings / access
Просмотреть документациюShow NTP settings
Описание: Retrieves the complete current configuration of NTP settings. This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/ntp
CLI-команда: settings ntp show ?
Категория: settings / ntp
Просмотреть документациюPartial update NTP settings
Описание: Performs a selective update of NTP settings configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/ntp
CLI-команда: settings ntp update ?
Категория: settings / ntp
Просмотреть документациюShow localization
Описание: Retrieves the complete current configuration of localization configuration (system branding and internationalization settings including company name, hostname, default UI language selection, and custom logo upload for personalized administrative interface appearance). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/localization
CLI-команда: settings localization show ?
Категория: settings / localization
Просмотреть документациюPartial update localization
Описание: Performs a selective update of localization configuration (system branding and internationalization settings including company name, hostname, default UI language selection, and custom logo upload for personalized administrative interface appearance) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/localization
CLI-команда: settings localization update ?
Категория: settings / localization
Просмотреть документациюShow LDAP
Описание: Retrieves the complete current configuration of LDAP configuration (external LDAP authentication integration with server connection settings, TLS encryption, principal pattern for username binding, base DN, optional bind restriction filters, and service account configuration for querying user email and phone fields). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/ldap
CLI-команда: settings ldap show ?
Категория: settings / ldap
Просмотреть документациюPartial update LDAP
Описание: Performs a selective update of LDAP configuration (external LDAP authentication integration with server connection settings, TLS encryption, principal pattern for username binding, base DN, optional bind restriction filters, and service account configuration for querying user email and phone fields) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/ldap
CLI-команда: settings ldap update ?
Категория: settings / ldap
Просмотреть документациюShow Radius
Описание: Retrieves the complete current configuration of Radius configuration (RADIUS protocol integration with server host, port, and shared secret settings providing centralized authentication, authorization, and accounting for network devices). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/radius
CLI-команда: settings radius show ?
Категория: settings / radius
Просмотреть документациюPartial update Radius
Описание: Performs a selective update of Radius configuration (RADIUS protocol integration with server host, port, and shared secret settings providing centralized authentication, authorization, and accounting for network devices) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/radius
CLI-команда: settings radius update ?
Категория: settings / radius
Просмотреть документациюShow TACACS
Описание: Retrieves the complete current configuration of TACACS configuration (centralized AAA (Authentication, Authorization, Accounting) integration for administrative access with server host and port settings, shared secret authentication, and optional accounting feature with username, password, service name, protocol, and language settings). This is a singleton resource, meaning there is only one instance in the system. The response includes all configuration fields with their current values. This operation is read-only and does not modify any data.
HTTP-метод: GET
Путь API: /settings/tacacs
CLI-команда: settings tacacs show ?
Категория: settings / tacacs
Просмотреть документациюPartial update TACACS
Описание: Performs a selective update of TACACS configuration (centralized AAA (Authentication, Authorization, Accounting) integration for administrative access with server host and port settings, shared secret authentication, and optional accounting feature with username, password, service name, protocol, and language settings) configuration. This operation uses shallow merging - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended approach when you want to change specific settings without affecting the rest of the configuration. The request body is merged at the first level with the existing configuration, then the complete updated configuration is returned in the response.
HTTP-метод: PATCH
Путь API: /settings/tacacs
CLI-команда: settings tacacs update ?
Категория: settings / tacacs
Просмотреть документациюCreate one settings.notificationmgmt.notificationentries instance
Описание: Creates a new settings.notificationMgmt.notificationEntries instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /settings/notificationMgmt/notificationEntries
CLI-команда: settings notification entry add ?
Категория: settings / notificationMgmt
Просмотреть документациюUpdate one settings.notificationMgmt.notificationEntries instance
Описание: Performs a complete replacement of a specific settings.notificationMgmt.notificationEntries instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /settings/notificationMgmt/notificationEntries/[id]
CLI-команда: settings notification entry set ?
Категория: settings / notificationMgmt
Просмотреть документациюPartial update one settings.notificationMgmt.notificationEntries instance
Описание: Performs a selective update of a specific settings.notificationMgmt.notificationEntries instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /settings/notificationMgmt/notificationEntries/[id]
CLI-команда: settings notification entry update ?
Категория: settings / notificationMgmt
Просмотреть документациюCreate one settings.notificationmgmt.contactgroups instance
Описание: Creates a new settings.notificationMgmt.contactGroups instance with the provided configuration. You must supply all required fields in the request body. The system will generate a unique identifier for the new instance. The response includes the complete configuration of the newly created instance, including any auto-generated fields. This operation adds a new entry to the collection without affecting existing instances.
HTTP-метод: POST
Путь API: /settings/notificationMgmt/contactGroups
CLI-команда: settings notification contact add ?
Категория: settings / notificationMgmt
Просмотреть документациюUpdate one settings.notificationMgmt.contactGroups instance
Описание: Performs a complete replacement of a specific settings.notificationMgmt.contactGroups instance identified by its ID. This is a full update operation where all required fields must be provided in the request body. Any fields not included will be reset to their default values. The instance ID cannot be changed. Use this when you want to ensure the instance has a specific, known configuration, replacing all previous settings. The response contains the updated instance as it was saved.
HTTP-метод: PUT
Путь API: /settings/notificationMgmt/contactGroups/[id]
CLI-команда: settings notification contact set ?
Категория: settings / notificationMgmt
Просмотреть документациюPartial update one settings.notificationMgmt.contactGroups instance
Описание: Performs a selective update of a specific settings.notificationMgmt.contactGroups instance identified by its ID. This operation uses shallow merging at the first level - only the fields you include in the request body will be modified, while all other fields retain their current values. This is the recommended and most efficient approach when you want to change specific settings of an instance without affecting the rest of its configuration. The instance ID cannot be changed. The response contains the complete updated configuration after the merge operation.
HTTP-метод: PATCH
Путь API: /settings/notificationMgmt/contactGroups/[id]
CLI-команда: settings notification contact update ?
Категория: settings / notificationMgmt
Просмотреть документацию