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.

« Get a ruleset Get associated deployments »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Deployments - IP Filtering - CRUD

Updates a ruleset

edit

Updates a ruleset

edit

Updates the ruleset with the definition.

Request

edit

PUT /api/v1/deployments/ip-filtering/rulesets/{ruleset_id}

Path parameters

edit
Name Type Required Description

ruleset_id

string

Y

The mandatory ruleset ID

Request body

edit

(IpFilterRuleset) (required) The ruleset definition

Responses

edit
200

(RuleSetResponse) The ruleset definition was valid and the update has started

400

(BasicFailedReply) The ruleset definition contains errors (code: 'ip_filtering.ruleset_invalid')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')

500

(BasicFailedReply) The request execution failed (code: 'ip_filtering.request_execution_failed')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT {{hostname}}/api/v1/deployments/ip-filtering/rulesets/{ruleset_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "associations" : [
      {
         "entity_type" : "string",
         "id" : "string"
      }
   ],
   "description" : "string",
   "id" : "string",
   "name" : "string",
   "rules" : [
      {
         "description" : "string",
         "id" : "string",
         "source" : "string"
      }
   ],
   "total_associations" : 0
}
'
« Get a ruleset Get associated deployments »