List traffic filter rulesets

GET /deployments/traffic-filter/rulesets

List all of the traffic filter rulesets.

Query parameters

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

  • Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.

Responses

  • The collection of traffic filter routes

    Hide response attribute Show response attribute object
    • rulesets array[object] Required

      List of traffic filter rules

      Hide rulesets attributes Show rulesets attributes object
      • id string Required

        The ruleset ID

      • name string Required

        Name of the ruleset

      • 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 array[object] Required

        List of rules

        Hide rules attributes Show rules attributes object
        • id string

          The rule ID

        • The remote cluster organization ID

        • The remote cluster ID

        • Description of the rule

        • source string

          Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID

        • Name of the Azure Private Endpoint to allow connections from

        • Resource GUID of the Azure Private Endpoint to allow connections from

        • An egress traffic filter rule

          Additional properties are allowed.

          Hide egress_rule attributes Show egress_rule attributes object
          • target string Required

            Allowed traffic filter egress target: IP address or CIDR mask

          • ports array[integer(int32)]

            A list of target ports for an egress rule

          • protocol string Required

            The target protocol for an egress rule

            Values are all, tcp, or udp.

      • associations array[object]

        List of associations. Returned only when include_associations query parameter is true

        Hide associations attributes Show associations attributes object
        • entity_type string Required

          Type of the traffic filter ruleset association, such as 'deployment', 'cluster'

        • id string Required

          ID of the entity, such as the deployment ID or Elasticsearch cluster ID.

      • total_associations integer(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

  • Error fetching traffic filter rulesets. (code: traffic_filter.request_execution_failed)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is traffic_filter.request_execution_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

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"
      ]
    }
  ]
}