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.

« Create a ruleset Retrieves the ruleset by ID. »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.7] ›RESTful API ›API reference ›Deployments - Traffic Filter - CRUD

Delete a ruleset

edit

Delete a ruleset

edit

Deletes the ruleset by ID.

Request

edit

DELETE /api/v1/deployments/traffic-filter/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; default: false

N

When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set.

Responses

edit
200

(EmptyResponse) The traffic filter ruleset was successfully deleted.

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 deleting 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

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

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Create a ruleset Retrieves the ruleset by ID. »