Skip to main content
GET
/
deployments
/
traffic-filter
/
rulesets
/
{ruleset_id}
Retrieves the ruleset by ID.
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
  --header 'Authorization: <api-key>'
{
  "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

Path Parameters

​
ruleset_id
string
required

(Required) The mandatory ruleset ID.

Example:

"<string>"

Query Parameters

​
include_associations
string

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

Example:

"false"

Response

The container for a set of traffic filter rules.

​
associations
object[]
Example:
[
  {
    "entity_type": "<string>",
    "id": "<string>"
  },
  {
    "entity_type": "<string>",
    "id": "<string>"
  }
]
​
description
string
Example:

"<string>"

​
id
string
Example:

"<string>"

​
include_by_default
string
Example:

"<boolean>"

​
name
string
Example:

"<string>"

​
region
string
Example:

"<string>"

​
rules
object[]
Example:
[
  {
    "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
string
Example:

"<integer>"

​
type
string
Example:

"<string>"

⌘I