Skip to main content
POST
/
deployments
/
traffic-filter
/
rulesets
Create a ruleset
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<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": "tcp",
        "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>"
    }
  ],
  "type": "<string>"
}'
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
description
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": "tcp",
      "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>"
  }
]
​
type
string
Example:

"<string>"

Response

The ruleset definition is valid and the creation has started.

​
id
string
Example:

"<string>"

⌘I