IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Delete a ruleset

edit

Delete a ruleset

edit

DEPRECATED: Deletes the ruleset by ID. Deprecated in favor of traffic-filter endpoints.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`ruleset_id`	`string`	Y	The mandatory ruleset ID

Query parameters

edit

Name	Type	Required	Description
`ignore_associations`	`boolean`	N	When true, ignores the associations and deletes the rule set. When false, recognizes the associations, which prevents the deletion of the rule set.

Responses

edit

200

(EmptyResponse)

The IP filter ruleset was successfully deleted

404

(BasicFailedReply)

The IP filter ruleset specified by {ruleset_id} cannot be found (code: 'ip_filtering.ruleset_not_found')

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')

Request example

edit

curl -XDELETE https://{{hostname}}/api/v1/deployments/ip-filtering/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Create a ruleset Get a ruleset »