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