List traffic filter rulesets
List all of the traffic filter rulesets.
Query parameters
-
include_associations boolean
Retrieves a list of resources that are associated to the specified ruleset.
Default value is
false
. -
region string
If provided limits the rulesets to that region only.
-
organization_id string
Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.
GET /deployments/traffic-filter/rulesets
curl \
-X GET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets
Response examples (200)
{
"rulesets": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"include_by_default": true,
"region": "string",
"rules": [
{
"id": "string",
"remote_cluster_org_id": "string",
"remote_cluster_id": "string",
"description": "string",
"source": "string",
"azure_endpoint_name": "string",
"azure_endpoint_guid": "string",
"egress_rule": {
"target": "string",
"ports": [
42
],
"protocol": "all"
}
}
],
"associations": [
{
"entity_type": "string",
"id": "string"
}
],
"total_associations": 42
}
]
}
Response examples (500)
# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}