« Deployments - Traffic Filter - Associations Deployments - Traffic Filter Claimed Link Id »

› › ›

Deployments - Traffic Filter - CRUD

edit

Deployments - Traffic Filter - CRUD

edit

List traffic filter rulesets

edit

List all of the traffic filter rulesets.

Request

edit

GET /api/v1/deployments/traffic-filter/rulesets

Query parameters

edit

Name	Type	Required	Description
`include_associations`	`boolean`; default: `false`	N	Retrieves a list of resources that are associated to the specified ruleset.
`organization_id`	`string`	N	Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.
`region`	`string`	N	If provided limits the rulesets to that region only.

Responses

edit

200

(TrafficFilterRulesets)

The collection of traffic filter routes

500

(BasicFailedReply)

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

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.request_execution_failed]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \
-H "Authorization: ApiKey $EC_API_KEY"

Create a ruleset

edit

Creates a ruleset that consists of a set of rules.

Request

edit

POST /api/v1/deployments/traffic-filter/rulesets

Request body

edit

(TrafficFilterRulesetRequest) (required) The specification for traffic filter ruleset.

Responses

edit

201

(TrafficFilterRulesetResponse)

The ruleset definition is valid and the creation has started.

500

(BasicFailedReply)

Error creating the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.request_execution_failed]): The error codes associated with the response

Request example

edit

curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \
-H "Authorization: ApiKey $EC_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "description" : "string",
   "include_by_default" : true,
   "name" : "string",
   "region" : "string",
   "rules" : [
      {
         "azure_endpoint_guid" : "string",
         "azure_endpoint_name" : "string",
         "description" : "string",
         "egress_rule" : {
            "ports" : [
               0
            ],
            "protocol" : "string",
            "target" : "string"
         },
         "id" : "string",
         "remote_cluster_id" : "string",
         "remote_cluster_org_id" : "string",
         "source" : "string"
      }
   ],
   "type" : "string"
}
'

Delete a ruleset

edit

Deletes the ruleset by ID.

Request

edit

DELETE /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}

Path parameters

edit

Name	Type	Required	Description
`ruleset_id`	`string`	Y	The mandatory ruleset ID.

Query parameters

edit

Name	Type	Required	Description
`ignore_associations`	`boolean`; default: `false`	N	When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set.

Responses

edit

200

(EmptyResponse)

The traffic filter ruleset was successfully deleted.

404

(BasicFailedReply)

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.not_found]): The error codes associated with the response

500

(BasicFailedReply)

Error deleting the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.request_execution_failed]): The error codes associated with the response

Request example

edit

curl -XDELETE https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Retrieves the ruleset by ID.

edit

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

Request

edit

GET /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}

Path parameters

edit

Name	Type	Required	Description
`ruleset_id`	`string`	Y	The mandatory ruleset ID.

Query parameters

edit

Name	Type	Required	Description
`include_associations`	`boolean`; default: `false`	N	Retrieves a list of resources that are associated to the specified ruleset.

Responses

edit

200

(TrafficFilterRulesetInfo)

The container for a set of traffic filter rules.

404

(BasicFailedReply)

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.not_found]): The error codes associated with the response

500

(BasicFailedReply)

Error reading the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.request_execution_failed]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Updates a ruleset

edit

Updates the ruleset with the definition.

Request

edit

PUT /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}

Path parameters

edit

Name	Type	Required	Description
`ruleset_id`	`string`	Y	The mandatory ruleset ID.

Request body

edit

(TrafficFilterRulesetRequest) (required) The specification for traffic filter ruleset.

Responses

edit

200

(TrafficFilterRulesetResponse)

The ruleset definition was valid and the update has started.

404

(BasicFailedReply)

The traffic filter ruleset specified by {ruleset_id} cannot be found. (code: traffic_filter.not_found)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.not_found]): The error codes associated with the response

500

(BasicFailedReply)

Error reading the traffic filter ruleset. (code: traffic_filter.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter.request_execution_failed]): The error codes associated with the response

Request example

edit

curl -XPUT https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $EC_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "description" : "string",
   "include_by_default" : true,
   "name" : "string",
   "region" : "string",
   "rules" : [
      {
         "azure_endpoint_guid" : "string",
         "azure_endpoint_name" : "string",
         "description" : "string",
         "egress_rule" : {
            "ports" : [
               0
            ],
            "protocol" : "string",
            "target" : "string"
         },
         "id" : "string",
         "remote_cluster_id" : "string",
         "remote_cluster_org_id" : "string",
         "source" : "string"
      }
   ],
   "type" : "string"
}
'

« Deployments - Traffic Filter - Associations Deployments - Traffic Filter Claimed Link Id »