IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Updates a ruleset
editUpdates a ruleset
editUpdates the ruleset with the definition.
Request
editPUT /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The mandatory ruleset ID. |
Request body
edit(TrafficFilterRulesetRequest
) (required) The specification for traffic filter ruleset.
Responses
edit-
200
-
(
TrafficFilterRulesetResponse
)The ruleset definition was valid and the update has started.
-
404
-
The traffic filter ruleset specified by {ruleset_id} cannot be found. (code:
traffic_filter.not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [traffic_filter.not_found
]) - The error codes associated with the response
-
-
500
-
Error reading the traffic filter ruleset. (code:
traffic_filter.request_execution_failed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [traffic_filter.request_execution_failed
]) - The error codes associated with the response
-
Request example
editcurl -XPUT https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "description" : "string", "include_by_default" : true, "name" : "string", "region" : "string", "rules" : [ { "azure_endpoint_guid" : "string", "azure_endpoint_name" : "string", "description" : "string", "egress_rule" : { "ports" : [ 0 ], "protocol" : "string", "target" : "string" }, "id" : "string", "source" : "string" } ], "type" : "string" } '