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

› › › ›

Retrieves the ruleset by ID.

edit

Retrieves the ruleset by ID.

edit

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

Request

edit

GET /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
`include_associations`	`boolean`; default: `false`	N	Retrieves a list of resources that are associated to the specified ruleset.

Responses

edit

200

(TrafficFilterRulesetInfo)

The container for a set of traffic filter rules.

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

Request example

edit

curl -XGET https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Delete a ruleset Updates a ruleset »