Skip to main content
GET
/
deployments
/
traffic-filter
/
rulesets
List traffic filter rulesets
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \
  --header 'Authorization: <api-key>'
{
  "rulesets": [
    {
      "associations": [
        {
          "entity_type": "<string>",
          "id": "<string>"
        },
        {
          "entity_type": "<string>",
          "id": "<string>"
        }
      ],
      "description": "<string>",
      "id": "<string>",
      "include_by_default": "<boolean>",
      "name": "<string>",
      "region": "<string>",
      "rules": [
        {
          "azure_endpoint_guid": "<string>",
          "azure_endpoint_name": "<string>",
          "description": "<string>",
          "egress_rule": {
            "ports": [
              "<integer>",
              "<integer>"
            ],
            "protocol": "all",
            "target": "<string>"
          },
          "id": "<string>",
          "remote_cluster_id": "<string>",
          "remote_cluster_org_id": "<string>",
          "source": "<string>"
        },
        {
          "azure_endpoint_guid": "<string>",
          "azure_endpoint_name": "<string>",
          "description": "<string>",
          "egress_rule": {
            "ports": [
              "<integer>",
              "<integer>"
            ],
            "protocol": "udp",
            "target": "<string>"
          },
          "id": "<string>",
          "remote_cluster_id": "<string>",
          "remote_cluster_org_id": "<string>",
          "source": "<string>"
        }
      ],
      "total_associations": "<integer>",
      "type": "<string>"
    },
    {
      "associations": [
        {
          "entity_type": "<string>",
          "id": "<string>"
        },
        {
          "entity_type": "<string>",
          "id": "<string>"
        }
      ],
      "description": "<string>",
      "id": "<string>",
      "include_by_default": "<boolean>",
      "name": "<string>",
      "region": "<string>",
      "rules": [
        {
          "azure_endpoint_guid": "<string>",
          "azure_endpoint_name": "<string>",
          "description": "<string>",
          "egress_rule": {
            "ports": [
              "<integer>",
              "<integer>"
            ],
            "protocol": "all",
            "target": "<string>"
          },
          "id": "<string>",
          "remote_cluster_id": "<string>",
          "remote_cluster_org_id": "<string>",
          "source": "<string>"
        },
        {
          "azure_endpoint_guid": "<string>",
          "azure_endpoint_name": "<string>",
          "description": "<string>",
          "egress_rule": {
            "ports": [
              "<integer>",
              "<integer>"
            ],
            "protocol": "tcp",
            "target": "<string>"
          },
          "id": "<string>",
          "remote_cluster_id": "<string>",
          "remote_cluster_org_id": "<string>",
          "source": "<string>"
        }
      ],
      "total_associations": "<integer>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
include_associations
string

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

Example:

"false"

​
region
string

If provided limits the rulesets to that region only.

Example:

"<string>"

​
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.

Example:

"<string>"

Response

The collection of traffic filter routes

​
rulesets
object[]
Example:
[
  {
    "associations": [
      {
        "entity_type": "<string>",
        "id": "<string>"
      },
      {
        "entity_type": "<string>",
        "id": "<string>"
      }
    ],
    "description": "<string>",
    "id": "<string>",
    "include_by_default": "<boolean>",
    "name": "<string>",
    "region": "<string>",
    "rules": [
      {
        "azure_endpoint_guid": "<string>",
        "azure_endpoint_name": "<string>",
        "description": "<string>",
        "egress_rule": {
          "ports": ["<integer>", "<integer>"],
          "protocol": "all",
          "target": "<string>"
        },
        "id": "<string>",
        "remote_cluster_id": "<string>",
        "remote_cluster_org_id": "<string>",
        "source": "<string>"
      },
      {
        "azure_endpoint_guid": "<string>",
        "azure_endpoint_name": "<string>",
        "description": "<string>",
        "egress_rule": {
          "ports": ["<integer>", "<integer>"],
          "protocol": "udp",
          "target": "<string>"
        },
        "id": "<string>",
        "remote_cluster_id": "<string>",
        "remote_cluster_org_id": "<string>",
        "source": "<string>"
      }
    ],
    "total_associations": "<integer>",
    "type": "<string>"
  },
  {
    "associations": [
      {
        "entity_type": "<string>",
        "id": "<string>"
      },
      {
        "entity_type": "<string>",
        "id": "<string>"
      }
    ],
    "description": "<string>",
    "id": "<string>",
    "include_by_default": "<boolean>",
    "name": "<string>",
    "region": "<string>",
    "rules": [
      {
        "azure_endpoint_guid": "<string>",
        "azure_endpoint_name": "<string>",
        "description": "<string>",
        "egress_rule": {
          "ports": ["<integer>", "<integer>"],
          "protocol": "all",
          "target": "<string>"
        },
        "id": "<string>",
        "remote_cluster_id": "<string>",
        "remote_cluster_org_id": "<string>",
        "source": "<string>"
      },
      {
        "azure_endpoint_guid": "<string>",
        "azure_endpoint_name": "<string>",
        "description": "<string>",
        "egress_rule": {
          "ports": ["<integer>", "<integer>"],
          "protocol": "tcp",
          "target": "<string>"
        },
        "id": "<string>",
        "remote_cluster_id": "<string>",
        "remote_cluster_org_id": "<string>",
        "source": "<string>"
      }
    ],
    "total_associations": "<integer>",
    "type": "<string>"
  }
]
⌘I