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 all rulesets Delete a ruleset »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.5] ›RESTful API ›API reference ›Deployments - IP Filtering - CRUD

Create a ruleset

edit

Create a ruleset

edit

Creates a ruleset that combines a set of rules.

Request

edit

POST /api/v1/deployments/ip-filtering/rulesets

Request body

edit

(IpFilterRuleset) (required) The ruleset definition

Responses

edit
201

(RuleSetResponse) The ruleset definition is valid and the creation has started

400

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

449

(BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

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 -XPOST https://{{hostname}}/api/v1/deployments/ip-filtering/rulesets \
-H "Authorization: ApiKey $ECE_API_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 all rulesets Delete a ruleset »