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.

Responses

• 200 application/json

  The collection of traffic filter routes

  Hide response attribute Show response attribute object

  • rulesets array[object] Required

    List of traffic filter rules

    The container for a set 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 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 array[object] Required

      List of rules

      The container for a traffic filter rule.

      Hide rules attributes Show rules attributes object

      • id string

        The rule ID

      • remote_cluster_org_id string

        The remote cluster organization ID

      • remote_cluster_id string

        The remote cluster ID

      • description string

        Description of the rule

      • source string

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

      • azure_endpoint_name string

        Name of the Azure Private Endpoint to allow connections from

      • azure_endpoint_guid string

        Resource GUID of the Azure Private Endpoint to allow connections from

      • egress_rule object

        An egress traffic filter rule

        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

      The association with a ruleset or user auth token for a deployment, template, or product.

      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

• 500 application/json

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

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    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