API Documentation
Complete REST API reference for automation, integration, and infrastructure-as-code workflows. Programmatically manage your entire application delivery infrastructure.
Get Started in Minutes
Three simple steps to start using the TR7 API
Authenticate
Send your credentials to the login endpoint to receive an access token
POST /api7/v0.1/loginInclude Token
Add the Bearer token to the Authorization header of every request
Authorization: Bearer <token>Make Requests
Use standard HTTP methods to manage your infrastructure
GET /api7/v0.1/lb/poolsExplore by Category
Browse 400+ endpoints organized into logical groups
Load Balancer
285 endpointsAccess Gateway
69 endpointsNetwork
32 endpointsGEO Traffic Manager
29 endpointsSettings
18 endpointsWeb Application Firewall
5 endpointsvDevice
3 endpointsUsers
3 endpointsInteractive API Explorer
Search, filter, and discover the right endpoints for your use case
Select an endpoint to view details
Built for Automation
Integrate TR7 into your existing workflows and toolchains
Infrastructure as Code
Manage your entire configuration as code. Export, version, and deploy configurations programmatically.
CI/CD Integration
Automate deployments in your pipelines. Update configurations as part of your release process.
CLI Support
Every API endpoint has a corresponding CLI command for terminal-based management and scripting.
OpenAPI Compatible
Standard REST API design following OpenAPI conventions. Generate client libraries in any language.
Ready to Automate?
Explore the complete API reference or contact us for integration support
TR7 REST API Endpoints Reference
Complete list of 444 REST API endpoints for TR7 Application Delivery Controller.
Create one firewall rule instance
Description: 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 Method: POST
API Path: /network/[zoneId]/fwRules
CLI Command: network fw-rule add ?
Category: network / fwRules
View DocumentationUpdate one firewall rule instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/fwRules/[id]
CLI Command: network fw-rule set ?
Category: network / fwRules
View DocumentationPartial update one firewall rule instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/fwRules/[id]
CLI Command: network fw-rule update ?
Category: network / fwRules
View DocumentationCreate one route table instance
Description: 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 Method: POST
API Path: /network/[zoneId]/namespaces
CLI Command: network namespace add ?
Category: network / namespaces
View DocumentationUpdate one route table instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/namespaces/[id]
CLI Command: network namespace set ?
Category: network / namespaces
View DocumentationPartial update one route table instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/namespaces/[id]
CLI Command: network namespace update ?
Category: network / namespaces
View DocumentationUpdate one physical ethernet interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one physical ethernet interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one vlan virtual interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one VLAN virtual interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one VLAN virtual interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one macvtap virtual interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one macvtap virtual interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one macvtap virtual interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one veth peer virtual interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one veth peer virtual interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one veth peer virtual interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one bond aggregate interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one bond aggregate interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one bond aggregate interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one lacp aggregate interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one LACP aggregate interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one LACP aggregate interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one bridge virtual interface instance
Description: 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 Method: POST
API Path: /network/[zoneId]/interfaces
CLI Command: network interface add ?
Category: network / interfaces
View DocumentationUpdate one bridge virtual interface instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface set ?
Category: network / interfaces
View DocumentationPartial update one bridge virtual interface instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/interfaces/[id]
CLI Command: network interface update ?
Category: network / interfaces
View DocumentationCreate one ip instance
Description: 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 Method: POST
API Path: /network/[zoneId]/ips
CLI Command: network ip add ?
Category: network / ips
View DocumentationUpdate one IP instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/ips/[id]
CLI Command: network ip set ?
Category: network / ips
View DocumentationPartial update one IP instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/ips/[id]
CLI Command: network ip update ?
Category: network / ips
View DocumentationCreate one route instance
Description: 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 Method: POST
API Path: /network/[zoneId]/routes
CLI Command: network route add ?
Category: network / routes
View DocumentationUpdate one route instance
Description: 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 Method: PUT
API Path: /network/[zoneId]/routes/[id]
CLI Command: network route set ?
Category: network / routes
View DocumentationPartial update one route instance
Description: 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 Method: PATCH
API Path: /network/[zoneId]/routes/[id]
CLI Command: network route update ?
Category: network / routes
View DocumentationShow WAF option
Description: 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 Method: GET
API Path: /waf/[poolId]/options
CLI Command: waf options show ?
Category: waf / options
View DocumentationPartial update WAF option
Description: 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 Method: PATCH
API Path: /waf/[poolId]/options
CLI Command: waf options update ?
Category: waf / options
View DocumentationCreate one host group instance
Description: 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 Method: POST
API Path: /waf/[poolId]/hostGroups
CLI Command: waf hostGroups add ?
Category: waf / hostGroups
View DocumentationUpdate one host group instance
Description: 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 Method: PUT
API Path: /waf/[poolId]/hostGroups/[id]
CLI Command: waf hostGroups set ?
Category: waf / hostGroups
View DocumentationPartial update one host group instance
Description: 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 Method: PATCH
API Path: /waf/[poolId]/hostGroups/[id]
CLI Command: waf hostGroups update ?
Category: waf / hostGroups
View DocumentationCreate one dns service instance
Description: 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 Method: POST
API Path: /gtm/gtmDns
CLI Command: gtm service add ?
Category: gtm / gtmDns
View DocumentationUpdate one DNS service instance
Description: 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 Method: PUT
API Path: /gtm/gtmDns/[id]
CLI Command: gtm service set ?
Category: gtm / gtmDns
View DocumentationPartial update one DNS service instance
Description: 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 Method: PATCH
API Path: /gtm/gtmDns/[id]
CLI Command: gtm service update ?
Category: gtm / gtmDns
View DocumentationCreate one dns record instance
Description: 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 Method: POST
API Path: /gtm/gtmDnsRecords/[dnsId]
CLI Command: gtm dns-record add ?
Category: gtm / gtmDnsRecords
View DocumentationUpdate one DNS record instance
Description: 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 Method: PUT
API Path: /gtm/gtmDnsRecords/[dnsId]/[id]
CLI Command: gtm dns-record set ?
Category: gtm / gtmDnsRecords
View DocumentationPartial update one DNS record instance
Description: 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 Method: PATCH
API Path: /gtm/gtmDnsRecords/[dnsId]/[id]
CLI Command: gtm dns-record update ?
Category: gtm / gtmDnsRecords
View DocumentationCreate one dns domain instance
Description: 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 Method: POST
API Path: /gtm/gtmDnsDomains/[dnsId]
CLI Command: gtm dns-domain add ?
Category: gtm / gtmDnsDomains
View DocumentationUpdate one DNS domain instance
Description: 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 Method: PUT
API Path: /gtm/gtmDnsDomains/[dnsId]/[id]
CLI Command: gtm dns-domain set ?
Category: gtm / gtmDnsDomains
View DocumentationPartial update one DNS domain instance
Description: 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 Method: PATCH
API Path: /gtm/gtmDnsDomains/[dnsId]/[id]
CLI Command: gtm dns-domain update ?
Category: gtm / gtmDnsDomains
View DocumentationCreate one dns forwarder profile instance
Description: 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 Method: POST
API Path: /gtm/gtmForwarders
CLI Command: gtm forwarder-profile add ?
Category: gtm / gtmForwarders
View DocumentationUpdate one DNS forwarder profile instance
Description: 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 Method: PUT
API Path: /gtm/gtmForwarders/[id]
CLI Command: gtm forwarder-profile set ?
Category: gtm / gtmForwarders
View DocumentationPartial update one DNS forwarder profile instance
Description: 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 Method: PATCH
API Path: /gtm/gtmForwarders/[id]
CLI Command: gtm forwarder-profile update ?
Category: gtm / gtmForwarders
View DocumentationCreate one datacenter instance
Description: 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 Method: POST
API Path: /gtm/gtmDataCenters
CLI Command: gtm data-center-remote add ?
Category: gtm / gtmDataCenters
View DocumentationUpdate one datacenter instance
Description: 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 Method: PUT
API Path: /gtm/gtmDataCenters/[id]
CLI Command: gtm data-center-remote set ?
Category: gtm / gtmDataCenters
View DocumentationPartial update one datacenter instance
Description: 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 Method: PATCH
API Path: /gtm/gtmDataCenters/[id]
CLI Command: gtm data-center-remote update ?
Category: gtm / gtmDataCenters
View DocumentationCreate one health check instance
Description: 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 Method: POST
API Path: /gtm/gtmHc
CLI Command: gtm hc add ?
Category: gtm / gtmHc
View DocumentationUpdate one health check instance
Description: 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 Method: PUT
API Path: /gtm/gtmHc/[id]
CLI Command: gtm hc set ?
Category: gtm / gtmHc
View DocumentationPartial update one health check instance
Description: 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 Method: PATCH
API Path: /gtm/gtmHc/[id]
CLI Command: gtm hc update ?
Category: gtm / gtmHc
View DocumentationCreate one health scenario instance
Description: 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 Method: POST
API Path: /gtm/gtmHcScenarios
CLI Command: gtm scenario add ?
Category: gtm / gtmHcScenarios
View DocumentationUpdate one health scenario instance
Description: 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 Method: PUT
API Path: /gtm/gtmHcScenarios/[id]
CLI Command: gtm scenario set ?
Category: gtm / gtmHcScenarios
View DocumentationPartial update one health scenario instance
Description: 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 Method: PATCH
API Path: /gtm/gtmHcScenarios/[id]
CLI Command: gtm scenario update ?
Category: gtm / gtmHcScenarios
View DocumentationCreate one trigger action instance
Description: 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 Method: POST
API Path: /gtm/gtmTriggers
CLI Command: gtm trigger add ?
Category: gtm / gtmTriggers
View DocumentationUpdate one trigger action instance
Description: 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 Method: PUT
API Path: /gtm/gtmTriggers/[id]
CLI Command: gtm trigger set ?
Category: gtm / gtmTriggers
View DocumentationPartial update one trigger action instance
Description: 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 Method: PATCH
API Path: /gtm/gtmTriggers/[id]
CLI Command: gtm trigger update ?
Category: gtm / gtmTriggers
View DocumentationCreate one express profile instance
Description: 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 Method: POST
API Path: /gtm/gtmRecordMgmt
CLI Command: gtm express-profile add ?
Category: gtm / gtmRecordMgmt
View DocumentationUpdate one express profile instance
Description: 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 Method: PUT
API Path: /gtm/gtmRecordMgmt/[id]
CLI Command: gtm express-profile set ?
Category: gtm / gtmRecordMgmt
View DocumentationPartial update one express profile instance
Description: 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 Method: PATCH
API Path: /gtm/gtmRecordMgmt/[id]
CLI Command: gtm express-profile update ?
Category: gtm / gtmRecordMgmt
View DocumentationShow local datacenter settings
Description: 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 Method: GET
API Path: /gtm/localDcSettings
CLI Command: gtm data-center-local show ?
Category: gtm / localDcSettings
View DocumentationPartial update local datacenter settings
Description: 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 Method: PATCH
API Path: /gtm/localDcSettings
CLI Command: gtm data-center-local update ?
Category: gtm / localDcSettings
View DocumentationCreate one access service instance
Description: 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 Method: POST
API Path: /ags/agsGateways
CLI Command: ags gateway add ?
Category: ags / agsGateways
View DocumentationUpdate one access service instance
Description: 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 Method: PUT
API Path: /ags/agsGateways/[id]
CLI Command: ags gateway set ?
Category: ags / agsGateways
View DocumentationPartial update one access service instance
Description: 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 Method: PATCH
API Path: /ags/agsGateways/[id]
CLI Command: ags gateway update ?
Category: ags / agsGateways
View DocumentationCreate one authentication server instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationServers
CLI Command: ags authentication-server add ?
Category: ags / agsAuthenticationServers
View DocumentationUpdate one authentication server instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationServers/[id]
CLI Command: ags authentication-server set ?
Category: ags / agsAuthenticationServers
View DocumentationPartial update one authentication server instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationServers/[id]
CLI Command: ags authentication-server update ?
Category: ags / agsAuthenticationServers
View DocumentationCreate one oauth2 provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one OAuth2 provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one OAuth2 provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one openid connect provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one OpenID Connect provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one OpenID Connect provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one saml provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one SAML provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one SAML provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one ldap provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one LDAP provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one LDAP provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one http provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one HTTP provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one HTTP provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one certificate provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one certificate provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one certificate provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one database provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one database provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one database provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one radius provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one RADIUS provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one RADIUS provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one portal provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one portal provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one portal provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one web form provider instance
Description: 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 Method: POST
API Path: /ags/agsAuthenticationProviders
CLI Command: ags authentication-provider add ?
Category: ags / agsAuthenticationProviders
View DocumentationUpdate one web form provider instance
Description: 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 Method: PUT
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider set ?
Category: ags / agsAuthenticationProviders
View DocumentationPartial update one web form provider instance
Description: 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 Method: PATCH
API Path: /ags/agsAuthenticationProviders/[id]
CLI Command: ags authentication-provider update ?
Category: ags / agsAuthenticationProviders
View DocumentationCreate one local database instance
Description: 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 Method: POST
API Path: /ags/agsLocalDatabases
CLI Command: ags local-database add ?
Category: ags / agsLocalDatabases
View DocumentationUpdate one local database instance
Description: 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 Method: PUT
API Path: /ags/agsLocalDatabases/[id]
CLI Command: ags local-database set ?
Category: ags / agsLocalDatabases
View DocumentationPartial update one local database instance
Description: 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 Method: PATCH
API Path: /ags/agsLocalDatabases/[id]
CLI Command: ags local-database update ?
Category: ags / agsLocalDatabases
View DocumentationCreate one local user instance
Description: 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 Method: POST
API Path: /ags/agsLocalUsers
CLI Command: ags local-user add ?
Category: ags / agsLocalUsers
View DocumentationUpdate one local user instance
Description: 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 Method: PUT
API Path: /ags/agsLocalUsers/[id]
CLI Command: ags local-user set ?
Category: ags / agsLocalUsers
View DocumentationPartial update one local user instance
Description: 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 Method: PATCH
API Path: /ags/agsLocalUsers/[id]
CLI Command: ags local-user update ?
Category: ags / agsLocalUsers
View DocumentationCreate one form instance
Description: 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 Method: POST
API Path: /ags/profiles/agsForms
CLI Command: ags forms add ?
Category: ags / profiles
View DocumentationUpdate one form instance
Description: 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 Method: PUT
API Path: /ags/profiles/agsForms/[id]
CLI Command: ags forms set ?
Category: ags / profiles
View DocumentationPartial update one form instance
Description: 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 Method: PATCH
API Path: /ags/profiles/agsForms/[id]
CLI Command: ags forms update ?
Category: ags / profiles
View DocumentationCreate one mfa instance
Description: 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 Method: POST
API Path: /ags/profiles/agsMFAs
CLI Command: ags mfas add ?
Category: ags / profiles
View DocumentationUpdate one MFA instance
Description: 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 Method: PUT
API Path: /ags/profiles/agsMFAs/[id]
CLI Command: ags mfas set ?
Category: ags / profiles
View DocumentationPartial update one MFA instance
Description: 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 Method: PATCH
API Path: /ags/profiles/agsMFAs/[id]
CLI Command: ags mfas update ?
Category: ags / profiles
View DocumentationCreate one page template instance
Description: 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 Method: POST
API Path: /ags/profiles/agsPageTemplates
CLI Command: ags profiles page-templates add ?
Category: ags / profiles
View DocumentationUpdate one page template instance
Description: 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 Method: PUT
API Path: /ags/profiles/agsPageTemplates/[id]
CLI Command: ags profiles page-templates set ?
Category: ags / profiles
View DocumentationPartial update one page template instance
Description: 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 Method: PATCH
API Path: /ags/profiles/agsPageTemplates/[id]
CLI Command: ags profiles page-templates update ?
Category: ags / profiles
View DocumentationCreate one dictionary instance
Description: 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 Method: POST
API Path: /ags/profiles/agsDictionaries
CLI Command: ags profiles dictionaries add ?
Category: ags / profiles
View DocumentationUpdate one dictionary instance
Description: 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 Method: PUT
API Path: /ags/profiles/agsDictionaries/[id]
CLI Command: ags profiles dictionaries set ?
Category: ags / profiles
View DocumentationPartial update one dictionary instance
Description: 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 Method: PATCH
API Path: /ags/profiles/agsDictionaries/[id]
CLI Command: ags profiles dictionaries update ?
Category: ags / profiles
View DocumentationCreate one lockout policy instance
Description: 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 Method: POST
API Path: /ags/profiles/security/agsLockoutPolicies
CLI Command: ags security lockoutPolicies add ?
Category: ags / profiles
View DocumentationUpdate one lockout policy instance
Description: 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 Method: PUT
API Path: /ags/profiles/security/agsLockoutPolicies/[id]
CLI Command: ags security lockoutPolicies set ?
Category: ags / profiles
View DocumentationPartial update one lockout policy instance
Description: 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 Method: PATCH
API Path: /ags/profiles/security/agsLockoutPolicies/[id]
CLI Command: ags security lockoutPolicies update ?
Category: ags / profiles
View DocumentationCreate one session protection policy instance
Description: 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 Method: POST
API Path: /ags/profiles/security/agsSessionProtectionPolicies
CLI Command: ags security sessionProtectionPolicies add ?
Category: ags / profiles
View DocumentationUpdate one session protection policy instance
Description: 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 Method: PUT
API Path: /ags/profiles/security/agsSessionProtectionPolicies/[id]
CLI Command: ags security sessionProtectionPolicies set ?
Category: ags / profiles
View DocumentationPartial update one session protection policy instance
Description: 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 Method: PATCH
API Path: /ags/profiles/security/agsSessionProtectionPolicies/[id]
CLI Command: ags security sessionProtectionPolicies update ?
Category: ags / profiles
View DocumentationCreate one bot protection policy instance
Description: 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 Method: POST
API Path: /ags/profiles/security/agsBotProtectionPolicies
CLI Command: ags security rateLimitPolicies add ?
Category: ags / profiles
View DocumentationUpdate one bot protection policy instance
Description: 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 Method: PUT
API Path: /ags/profiles/security/agsBotProtectionPolicies/[id]
CLI Command: ags security rateLimitPolicies set ?
Category: ags / profiles
View DocumentationPartial update one bot protection policy instance
Description: 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 Method: PATCH
API Path: /ags/profiles/security/agsBotProtectionPolicies/[id]
CLI Command: ags security rateLimitPolicies update ?
Category: ags / profiles
View DocumentationCreate one captcha provider instance
Description: 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 Method: POST
API Path: /ags/profiles/security/agsCaptchaProviders
CLI Command: ags security captchaProviders add ?
Category: ags / profiles
View DocumentationUpdate one captcha provider instance
Description: 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 Method: PUT
API Path: /ags/profiles/security/agsCaptchaProviders/[id]
CLI Command: ags security captchaProviders set ?
Category: ags / profiles
View DocumentationPartial update one captcha provider instance
Description: 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 Method: PATCH
API Path: /ags/profiles/security/agsCaptchaProviders/[id]
CLI Command: ags security captchaProviders update ?
Category: ags / profiles
View DocumentationCreate one security profile instance
Description: 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 Method: POST
API Path: /ags/profiles/security/agsGatewaySecurities
CLI Command: ags security profiles add ?
Category: ags / profiles
View DocumentationUpdate one security profile instance
Description: 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 Method: PUT
API Path: /ags/profiles/security/agsGatewaySecurities/[id]
CLI Command: ags security profiles set ?
Category: ags / profiles
View DocumentationPartial update one security profile instance
Description: 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 Method: PATCH
API Path: /ags/profiles/security/agsGatewaySecurities/[id]
CLI Command: ags security profiles update ?
Category: ags / profiles
View DocumentationCreate one http vservice instance
Description: 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 Method: POST
API Path: /lb/lbPools
CLI Command: lb service add ?
Category: lb / lbPools
View DocumentationUpdate one HTTP vService instance
Description: 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 Method: PUT
API Path: /lb/lbPools/[id]
CLI Command: lb service set ?
Category: lb / lbPools
View DocumentationPartial update one HTTP vService instance
Description: 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 Method: PATCH
API Path: /lb/lbPools/[id]
CLI Command: lb service update ?
Category: lb / lbPools
View DocumentationCreate one tcp vservice instance
Description: 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 Method: POST
API Path: /lb/lbPools
CLI Command: lb service add ?
Category: lb / lbPools
View DocumentationUpdate one TCP vService instance
Description: 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 Method: PUT
API Path: /lb/lbPools/[id]
CLI Command: lb service set ?
Category: lb / lbPools
View DocumentationPartial update one TCP vService instance
Description: 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 Method: PATCH
API Path: /lb/lbPools/[id]
CLI Command: lb service update ?
Category: lb / lbPools
View DocumentationCreate one network vservice instance
Description: 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 Method: POST
API Path: /lb/lbPools
CLI Command: lb service add ?
Category: lb / lbPools
View DocumentationUpdate one Network vService instance
Description: 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 Method: PUT
API Path: /lb/lbPools/[id]
CLI Command: lb service set ?
Category: lb / lbPools
View DocumentationPartial update one Network vService instance
Description: 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 Method: PATCH
API Path: /lb/lbPools/[id]
CLI Command: lb service update ?
Category: lb / lbPools
View DocumentationCreate one backend instance
Description: 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 Method: POST
API Path: /lb/lbBackends
CLI Command: lb backend add ?
Category: lb / lbBackends
View DocumentationUpdate one backend instance
Description: 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 Method: PUT
API Path: /lb/lbBackends/[id]
CLI Command: lb backend set ?
Category: lb / lbBackends
View DocumentationPartial update one backend instance
Description: 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 Method: PATCH
API Path: /lb/lbBackends/[id]
CLI Command: lb backend update ?
Category: lb / lbBackends
View DocumentationCreate one tcp health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one TCP health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one TCP health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one ping health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one PING health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one PING health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one http health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one HTTP health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one HTTP health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one https health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one HTTPS health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one HTTPS health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one dns health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one DNS health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one DNS health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one ftp health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one FTP health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one FTP health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one ftps health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one FTPS health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one FTPS health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one ldap health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one LDAP health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one LDAP health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one ldaps health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one LDAPS health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one LDAPS health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one oracle health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one Oracle health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one Oracle health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one udp health check instance
Description: 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 Method: POST
API Path: /lb/lbHealthChecks
CLI Command: lb hc add ?
Category: lb / lbHealthChecks
View DocumentationUpdate one UDP health check instance
Description: 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 Method: PUT
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc set ?
Category: lb / lbHealthChecks
View DocumentationPartial update one UDP health check instance
Description: 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 Method: PATCH
API Path: /lb/lbHealthChecks/[id]
CLI Command: lb hc update ?
Category: lb / lbHealthChecks
View DocumentationCreate one show content instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Show content instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Show content instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one keep header names instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Keep header names instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Keep header names instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one manage http security headers instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Manage HTTP security headers instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Manage HTTP security headers instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one http cookie security instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one HTTP cookie security instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one HTTP cookie security instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one captcha protection instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one CAPTCHA protection instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one CAPTCHA protection instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one bandwidth limitation instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Bandwidth limitation instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Bandwidth limitation instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one cookie encryption instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Cookie encryption instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Cookie encryption instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one ipfix log sending instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one IPFIX log sending instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one IPFIX log sending instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one add http header instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Add HTTP header instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Add HTTP header instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one delete http header instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Delete HTTP header instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Delete HTTP header instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one set http header instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Set HTTP header instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Set HTTP header instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one replace http header content instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Replace HTTP header content instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Replace HTTP header content instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one advanced traffic inspection instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Advanced traffic inspection instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Advanced traffic inspection instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one modify response content instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Modify response content instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Modify response content instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one http tcp multiplexing instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one HTTP TCP multiplexing instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one HTTP TCP multiplexing instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one http 1.0 header compatibility instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one HTTP 1.0 header compatibility instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one HTTP 1.0 header compatibility instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one provide prometheus service instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Provide Prometheus service instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Provide Prometheus service instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one conditional silent log instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Conditional silent log instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Conditional silent log instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one cors instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one CORS instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one CORS instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one ip log masking instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Ip log masking instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Ip log masking instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one manual action instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Manual action instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Manual action instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one block instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Block instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Block instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one location redirection instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Location redirection instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Location redirection instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one user authentication (on http request) instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one User authentication (On HTTP request) instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one User authentication (On HTTP request) instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one set path instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Set path instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Set path instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one set path + query instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Set path + query instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Set path + query instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one url normalization instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one URL normalization instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one URL normalization instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one cookie based connection persistency instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Cookie based connection persistency instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Cookie based connection persistency instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one tcp connection management instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one TCP connection management instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one TCP connection management instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one redirect for traffic manager errors instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Redirect for traffic manager errors instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Redirect for traffic manager errors instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one redirect for backend service errors instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Redirect for backend service errors instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Redirect for backend service errors instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one show content for traffic manager errors instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Show content for traffic manager errors instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Show content for traffic manager errors instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one show content for backend service errors instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Show content for backend service errors instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Show content for backend service errors instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one redirect to https instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Redirect to HTTPS instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Redirect to HTTPS instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one quarantine instance
Description: 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 Method: POST
API Path: /lb/lbRules
CLI Command: lb action add ?
Category: lb / lbRules
View DocumentationUpdate one Quarantine instance
Description: 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 Method: PUT
API Path: /lb/lbRules/[id]
CLI Command: lb action set ?
Category: lb / lbRules
View DocumentationPartial update one Quarantine instance
Description: 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 Method: PATCH
API Path: /lb/lbRules/[id]
CLI Command: lb action update ?
Category: lb / lbRules
View DocumentationCreate one ip intelligence category condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one IP intelligence category condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one IP intelligence category condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http request body condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP request body condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP request body condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http response body condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP response body condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP response body condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one url list condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one URL list condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one URL list condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one dynamic list instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Dynamic list instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Dynamic list instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http query parameter condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP query parameter condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP query parameter condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one browser condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one browser condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one browser condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one mobile platform condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one mobile platform condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one mobile platform condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one bot type condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one bot type condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one bot type condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http header condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP header condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP header condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http path condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP path condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP path condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http path+query condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP path+query condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP path+query condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http url condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP URL condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP URL condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one http status code condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one HTTP status code condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one HTTP status code condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one source ip address condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one source IP address condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one source IP address condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one destination ip address condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one destination IP address condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one destination IP address condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one destination port condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one destination port condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one destination port condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one response time condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one response time condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one response time condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one client cookie condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one client cookie condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one client cookie condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one server cookie condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one server cookie condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one server cookie condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one number of active servers instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Number of active servers instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Number of active servers instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one ssl cipher condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one SSL cipher condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one SSL cipher condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one ssl version condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one SSL version condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one SSL version condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one ssl sni info instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one SSL SNI info instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one SSL SNI info instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one request size (bytes) instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Request size (bytes) instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Request size (bytes) instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one response size (bytes) instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Response size (bytes) instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Response size (bytes) instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one user authentication instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one User authentication instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one User authentication instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one frontend connection instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Frontend connection instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Frontend connection instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one frontend number of new sessions / s instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Frontend number of new sessions / s instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Frontend number of new sessions / s instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one frontend number of http requests / s instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Frontend number of HTTP requests / s instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Frontend number of HTTP requests / s instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one rdp cookie instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one RDP cookie instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one RDP cookie instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one manual condition instance
Description: 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 Method: POST
API Path: /lb/lbConditions
CLI Command: lb condition add ?
Category: lb / lbConditions
View DocumentationUpdate one Manual condition instance
Description: 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 Method: PUT
API Path: /lb/lbConditions/[id]
CLI Command: lb condition set ?
Category: lb / lbConditions
View DocumentationPartial update one Manual condition instance
Description: 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 Method: PATCH
API Path: /lb/lbConditions/[id]
CLI Command: lb condition update ?
Category: lb / lbConditions
View DocumentationCreate one acme.sh instance
Description: 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 Method: POST
API Path: /lb/lbCertificates
CLI Command: lb certificate add ?
Category: lb / lbCertificates
View DocumentationUpdate one ACME.sh instance
Description: 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 Method: PUT
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate set ?
Category: lb / lbCertificates
View DocumentationPartial update one ACME.sh instance
Description: 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 Method: PATCH
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate update ?
Category: lb / lbCertificates
View DocumentationCreate one manual instance
Description: 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 Method: POST
API Path: /lb/lbCertificates
CLI Command: lb certificate add ?
Category: lb / lbCertificates
View DocumentationUpdate one manual instance
Description: 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 Method: PUT
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate set ?
Category: lb / lbCertificates
View DocumentationPartial update one manual instance
Description: 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 Method: PATCH
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate update ?
Category: lb / lbCertificates
View DocumentationCreate one pfx instance
Description: 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 Method: POST
API Path: /lb/lbCertificates
CLI Command: lb certificate add ?
Category: lb / lbCertificates
View DocumentationUpdate one PFX instance
Description: 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 Method: PUT
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate set ?
Category: lb / lbCertificates
View DocumentationPartial update one PFX instance
Description: 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 Method: PATCH
API Path: /lb/lbCertificates/[id]
CLI Command: lb certificate update ?
Category: lb / lbCertificates
View DocumentationCreate one ca instance
Description: 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 Method: POST
API Path: /lb/profiles/lbCertificateAuthorities
CLI Command: lb ca add ?
Category: lb / profiles
View DocumentationUpdate one CA instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbCertificateAuthorities/[id]
CLI Command: lb ca set ?
Category: lb / profiles
View DocumentationPartial update one CA instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbCertificateAuthorities/[id]
CLI Command: lb ca update ?
Category: lb / profiles
View DocumentationCreate one cache instance
Description: 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 Method: POST
API Path: /lb/profiles/lbCaches
CLI Command: lb cache add ?
Category: lb / profiles
View DocumentationUpdate one cache instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbCaches/[id]
CLI Command: lb cache set ?
Category: lb / profiles
View DocumentationPartial update one cache instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbCaches/[id]
CLI Command: lb cache update ?
Category: lb / profiles
View DocumentationCreate one compression instance
Description: 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 Method: POST
API Path: /lb/profiles/lbCompressions
CLI Command: lb compression add ?
Category: lb / profiles
View DocumentationUpdate one compression instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbCompressions/[id]
CLI Command: lb compression set ?
Category: lb / profiles
View DocumentationPartial update one compression instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbCompressions/[id]
CLI Command: lb compression update ?
Category: lb / profiles
View DocumentationCreate one log instance
Description: 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 Method: POST
API Path: /lb/profiles/lbLogs
CLI Command: lb log add ?
Category: lb / profiles
View DocumentationUpdate one log instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbLogs/[id]
CLI Command: lb log set ?
Category: lb / profiles
View DocumentationPartial update one log instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbLogs/[id]
CLI Command: lb log update ?
Category: lb / profiles
View DocumentationCreate one notification instance
Description: 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 Method: POST
API Path: /lb/profiles/lbNotifications
CLI Command: lb notification add ?
Category: lb / profiles
View DocumentationUpdate one notification instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbNotifications/[id]
CLI Command: lb notification set ?
Category: lb / profiles
View DocumentationPartial update one notification instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbNotifications/[id]
CLI Command: lb notification update ?
Category: lb / profiles
View DocumentationCreate one page content instance
Description: 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 Method: POST
API Path: /lb/profiles/lbPageContents
CLI Command: lb page add ?
Category: lb / profiles
View DocumentationUpdate one page content instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbPageContents/[id]
CLI Command: lb page set ?
Category: lb / profiles
View DocumentationPartial update one page content instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbPageContents/[id]
CLI Command: lb page update ?
Category: lb / profiles
View DocumentationCreate one frontend limits instance
Description: 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 Method: POST
API Path: /lb/profiles/lbPoolLimits
CLI Command: lb limits add ?
Category: lb / profiles
View DocumentationUpdate one frontend limits instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbPoolLimits/[id]
CLI Command: lb limits set ?
Category: lb / profiles
View DocumentationPartial update one frontend limits instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbPoolLimits/[id]
CLI Command: lb limits update ?
Category: lb / profiles
View DocumentationCreate one report instance
Description: 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 Method: POST
API Path: /lb/profiles/lbReports
CLI Command: lb report add ?
Category: lb / profiles
View DocumentationUpdate one report instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbReports/[id]
CLI Command: lb report set ?
Category: lb / profiles
View DocumentationPartial update one report instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbReports/[id]
CLI Command: lb report update ?
Category: lb / profiles
View DocumentationCreate one ssl security instance
Description: 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 Method: POST
API Path: /lb/profiles/lbSecurities
CLI Command: lb ssl-security add ?
Category: lb / profiles
View DocumentationUpdate one SSL security instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbSecurities/[id]
CLI Command: lb ssl-security set ?
Category: lb / profiles
View DocumentationPartial update one SSL security instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbSecurities/[id]
CLI Command: lb ssl-security update ?
Category: lb / profiles
View DocumentationCreate one timeout instance
Description: 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 Method: POST
API Path: /lb/profiles/lbTimeouts
CLI Command: lb timeouts add ?
Category: lb / profiles
View DocumentationUpdate one timeout instance
Description: 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 Method: PUT
API Path: /lb/profiles/lbTimeouts/[id]
CLI Command: lb timeouts set ?
Category: lb / profiles
View DocumentationPartial update one timeout instance
Description: 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 Method: PATCH
API Path: /lb/profiles/lbTimeouts/[id]
CLI Command: lb timeouts update ?
Category: lb / profiles
View DocumentationCreate one vdevice instance
Description: 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 Method: POST
API Path: /zones
CLI Command: v-device add ?
Category: zones /
View DocumentationUpdate one vDevice instance
Description: 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 Method: PUT
API Path: /zones/[id]
CLI Command: v-device set ?
Category: zones /
View DocumentationPartial update one vDevice instance
Description: 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 Method: PATCH
API Path: /zones/[id]
CLI Command: v-device update ?
Category: zones /
View DocumentationCreate one user instance
Description: 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 Method: POST
API Path: /users
CLI Command: users add ?
Category: users /
View DocumentationUpdate one user instance
Description: 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 Method: PUT
API Path: /users/[username]
CLI Command: users set ?
Category: users /
View DocumentationPartial update one user instance
Description: 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 Method: PATCH
API Path: /users/[username]
CLI Command: users update ?
Category: users /
View DocumentationShow access
Description: 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 Method: GET
API Path: /settings/access
CLI Command: settings access show ?
Category: settings / access
View DocumentationPartial update access
Description: 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 Method: PATCH
API Path: /settings/access
CLI Command: settings access update ?
Category: settings / access
View DocumentationShow NTP settings
Description: 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 Method: GET
API Path: /settings/ntp
CLI Command: settings ntp show ?
Category: settings / ntp
View DocumentationPartial update NTP settings
Description: 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 Method: PATCH
API Path: /settings/ntp
CLI Command: settings ntp update ?
Category: settings / ntp
View DocumentationShow localization
Description: 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 Method: GET
API Path: /settings/localization
CLI Command: settings localization show ?
Category: settings / localization
View DocumentationPartial update localization
Description: 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 Method: PATCH
API Path: /settings/localization
CLI Command: settings localization update ?
Category: settings / localization
View DocumentationShow LDAP
Description: 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 Method: GET
API Path: /settings/ldap
CLI Command: settings ldap show ?
Category: settings / ldap
View DocumentationPartial update LDAP
Description: 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 Method: PATCH
API Path: /settings/ldap
CLI Command: settings ldap update ?
Category: settings / ldap
View DocumentationShow Radius
Description: 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 Method: GET
API Path: /settings/radius
CLI Command: settings radius show ?
Category: settings / radius
View DocumentationPartial update Radius
Description: 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 Method: PATCH
API Path: /settings/radius
CLI Command: settings radius update ?
Category: settings / radius
View DocumentationShow TACACS
Description: 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 Method: GET
API Path: /settings/tacacs
CLI Command: settings tacacs show ?
Category: settings / tacacs
View DocumentationPartial update TACACS
Description: 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 Method: PATCH
API Path: /settings/tacacs
CLI Command: settings tacacs update ?
Category: settings / tacacs
View DocumentationCreate one settings.notificationmgmt.notificationentries instance
Description: 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 Method: POST
API Path: /settings/notificationMgmt/notificationEntries
CLI Command: settings notification entry add ?
Category: settings / notificationMgmt
View DocumentationUpdate one settings.notificationMgmt.notificationEntries instance
Description: 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 Method: PUT
API Path: /settings/notificationMgmt/notificationEntries/[id]
CLI Command: settings notification entry set ?
Category: settings / notificationMgmt
View DocumentationPartial update one settings.notificationMgmt.notificationEntries instance
Description: 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 Method: PATCH
API Path: /settings/notificationMgmt/notificationEntries/[id]
CLI Command: settings notification entry update ?
Category: settings / notificationMgmt
View DocumentationCreate one settings.notificationmgmt.contactgroups instance
Description: 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 Method: POST
API Path: /settings/notificationMgmt/contactGroups
CLI Command: settings notification contact add ?
Category: settings / notificationMgmt
View DocumentationUpdate one settings.notificationMgmt.contactGroups instance
Description: 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 Method: PUT
API Path: /settings/notificationMgmt/contactGroups/[id]
CLI Command: settings notification contact set ?
Category: settings / notificationMgmt
View DocumentationPartial update one settings.notificationMgmt.contactGroups instance
Description: 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 Method: PATCH
API Path: /settings/notificationMgmt/contactGroups/[id]
CLI Command: settings notification contact update ?
Category: settings / notificationMgmt
View Documentation