Retrieves the ruleset by ID.

Auth

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

Path parameters

include_associations boolean · default: false: Retrieves a list of resources that are associated to the specified ruleset.

The container for a set of traffic filter rules.

application/json

id string required: The ruleset ID
name string required: Name of the ruleset
description string: Description of the ruleset
type string required: Type of the ruleset
include_by_default boolean required: Should the ruleset be automatically included in the new deployments
region string required: The ruleset can be attached only to deployments in the specific region
rules object[] required: List of rules
associations object[]: List of associations. Returned only when include_associations query parameter is true
total_associations integer · format: int32: Total number of associations. This includes associations the user does not have permission to view.Returned only when include_associations query parameter is true

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

application/json

Error reading the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

application/json