It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Retrieves the ruleset by ID. Networking - Deployment Domain Names »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.12] ›RESTful API ›API reference ›Deployments - Traffic Filter - CRUD

Updates a ruleset

edit

Updates a ruleset

edit

Updates the ruleset with the definition.

Request

edit

PUT /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}

Path parameters

edit
Name Type Required Description

ruleset_id

string

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

(BasicFailedReply) 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

(BasicFailedReply) 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

edit
curl -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"
}
'
« Retrieves the ruleset by ID. Networking - Deployment Domain Names »