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.

« Deployments - Traffic Filter - CRUD Create a ruleset »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.8] ›RESTful API ›API reference ›Deployments - Traffic Filter - CRUD

List traffic filter rulesets

edit

List traffic filter rulesets

edit

List all of the traffic filter rulesets.

Request

edit

GET /api/v1/deployments/traffic-filter/rulesets

Query parameters

edit
Name Type Required Description

include_associations

boolean; default: false

N

Retrieves a list of resources that are associated to the specified ruleset.

region

string

N

If provided limits the rulesets to that region only.

Responses

edit
200

(TrafficFilterRulesets) The collection of traffic filter routes

500

(BasicFailedReply) Error fetching traffic filter rulesets. (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 -XGET https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets \
-H "Authorization: ApiKey $ECE_API_KEY"
« Deployments - Traffic Filter - CRUD Create a ruleset »