Deployments - Traffic Filter - CRUD

List traffic filter rulesets

List all of the traffic filter rulesets.

Request

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

Query parameters

Name Type Required Description

include_associations

boolean; default: false

N

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

region

string

N

If provided limits the rulesets to that region only.

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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

Create a ruleset

Creates a ruleset that consists of a set of rules.

Request

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

Request body

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "description" : "string",
   "include_by_default" : true,
   "name" : "string",
   "region" : "string",
   "rules" : [
      {
         "description" : "string",
         "id" : "string",
         "source" : "string"
      }
   ],
   "type" : "string"
}
'

Delete a ruleset

Deletes the ruleset by ID.

Request

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

Path parameters

Name Type Required Description

ruleset_id

string

Y

The mandatory ruleset ID.

Query parameters

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

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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.

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

Request

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

Path parameters

Name Type Required Description

ruleset_id

string

Y

The mandatory ruleset ID.

Query parameters

Name Type Required Description

include_associations

boolean; default: false

N

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

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

Updates a ruleset

Updates the ruleset with the definition.

Request

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

Path parameters

Name Type Required Description

ruleset_id

string

Y

The mandatory ruleset ID.

Request body

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

Responses

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/rulesets/{ruleset_id} \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "description" : "string",
   "include_by_default" : true,
   "name" : "string",
   "region" : "string",
   "rules" : [
      {
         "description" : "string",
         "id" : "string",
         "source" : "string"
      }
   ],
   "type" : "string"
}
'