Deployments - Traffic Filter - CRUDedit
List traffic filter rulesetsedit
List all of the traffic filter rulesets.
Requestedit
GET /api/v1/deployments/traffic-filter/rulesets
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Retrieves a list of resources that are associated to the specified ruleset. |
|
|
N |
Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin. |
|
|
N |
If provided limits the rulesets to that region only. |
Responsesedit
-
200
-
The collection of traffic filter routes
-
500
-
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 exampleedit
curl -XGET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \ -H "Authorization: ApiKey $EC_API_KEY"
Create a rulesetedit
Creates a ruleset that consists of a set of rules.
Requestedit
POST /api/v1/deployments/traffic-filter/rulesets
Request bodyedit
(TrafficFilterRulesetRequest
) (required) The specification for traffic filter ruleset.
Responsesedit
-
201
-
(
TrafficFilterRulesetResponse
)The ruleset definition is valid and the creation has started.
-
500
-
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 exampleedit
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 rulesetedit
Deletes the ruleset by ID.
Requestedit
DELETE /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The mandatory ruleset ID. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When true, ignores the associations and deletes the ruleset. When false, recognizes the associations, which prevents the deletion of the rule set. |
Responsesedit
-
200
-
The traffic filter ruleset was successfully deleted.
-
404
-
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
-
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 exampleedit
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.
Requestedit
GET /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The mandatory ruleset ID. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Retrieves a list of resources that are associated to the specified ruleset. |
Responsesedit
-
200
-
The container for a set of traffic filter rules.
-
404
-
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
-
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 exampleedit
curl -XGET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \ -H "Authorization: ApiKey $EC_API_KEY"
Updates a rulesetedit
Updates the ruleset with the definition.
Requestedit
PUT /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The mandatory ruleset ID. |
Request bodyedit
(TrafficFilterRulesetRequest
) (required) The specification for traffic filter ruleset.
Responsesedit
-
200
-
(
TrafficFilterRulesetResponse
)The ruleset definition was valid and the update has started.
-
404
-
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
-
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 exampleedit
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" } '