Class: Fastly::WafRulesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/waf_rules_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WafRulesApi

Returns a new instance of WafRulesApi.



17
18
19
 
# File 'lib/fastly/api/waf_rules_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/waf_rules_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_waf_rule(opts = {}) ⇒ WafRuleResponse

Get a rule Get a specific rule. The ‘id` provided can be the ModSecurity Rule ID or the Fastly generated rule ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :include (String) —

    Include relationships. Optional, comma-separated values. Permitted values: `waf_tags` and `waf_rule_revisions`.

Returns:



25
26
27
28
 
# File 'lib/fastly/api/waf_rules_api.rb', line 25

def get_waf_rule(opts = {})
  data, _status_code, _headers = get_waf_rule_with_http_info(opts)
  data
end

#get_waf_rule_with_http_info(opts = {}) ⇒ Array<(WafRuleResponse, Integer, Hash)>

Get a rule Get a specific rule. The &#x60;id&#x60; provided can be the ModSecurity Rule ID or the Fastly generated rule ID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :waf_rule_id (String) —

    Alphanumeric string identifying a WAF rule. (required)

  • :include (String) —

    Include relationships. Optional, comma-separated values. Permitted values: &#x60;waf_tags&#x60; and &#x60;waf_rule_revisions&#x60;.

Returns:

  • (Array<(WafRuleResponse, Integer, Hash)>) —

    WafRuleResponse data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/fastly/api/waf_rules_api.rb', line 35

def get_waf_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafRulesApi.get_waf_rule ...'
  end
  # unbox the parameters from the hash
  waf_rule_id = opts[:'waf_rule_id']
  # verify the required parameter 'waf_rule_id' is set
  if @api_client.config.client_side_validation && waf_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'waf_rule_id' when calling WafRulesApi.get_waf_rule"
  end
  # resource path
  local_var_path = '/waf/rules/{waf_rule_id}'.sub('{' + 'waf_rule_id' + '}', CGI.escape(waf_rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WafRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"WafRulesApi.get_waf_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WafRulesApi#get_waf_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_waf_rules(opts = {}) ⇒ WafRulesResponse

List available WAF rules List all available WAF rules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :filter_modsec_rule_id (String) —

    Limit the returned rules to a specific ModSecurity rule ID.

  • :filter_waf_tags_name (String) —

    Limit the returned rules to a set linked to a tag by name.

  • :filter_waf_rule_revisions_source (String) —

    Limit the returned rules to a set linked to a source.

  • :filter_waf_firewall_id_not_match (String) —

    Limit the returned rules to a set not included in the active firewall version for a firewall.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional, comma-separated values. Permitted values: &#x60;waf_tags&#x60; and &#x60;waf_rule_revisions&#x60;.

Returns:



96
97
98
99
 
# File 'lib/fastly/api/waf_rules_api.rb', line 96

def list_waf_rules(opts = {})
  data, _status_code, _headers = list_waf_rules_with_http_info(opts)
  data
end

#list_waf_rules_with_http_info(opts = {}) ⇒ Array<(WafRulesResponse, Integer, Hash)>

List available WAF rules List all available WAF rules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :filter_modsec_rule_id (String) —

    Limit the returned rules to a specific ModSecurity rule ID.

  • :filter_waf_tags_name (String) —

    Limit the returned rules to a set linked to a tag by name.

  • :filter_waf_rule_revisions_source (String) —

    Limit the returned rules to a set linked to a source.

  • :filter_waf_firewall_id_not_match (String) —

    Limit the returned rules to a set not included in the active firewall version for a firewall.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :include (String) —

    Include relationships. Optional, comma-separated values. Permitted values: &#x60;waf_tags&#x60; and &#x60;waf_rule_revisions&#x60;.

Returns:

  • (Array<(WafRulesResponse, Integer, Hash)>) —

    WafRulesResponse data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/fastly/api/waf_rules_api.rb', line 111

def list_waf_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WafRulesApi.list_waf_rules ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WafRulesApi.list_waf_rules, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WafRulesApi.list_waf_rules, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/waf/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[modsec_rule_id]'] = opts[:'filter_modsec_rule_id'] if !opts[:'filter_modsec_rule_id'].nil?
  query_params[:'filter[waf_tags][name]'] = opts[:'filter_waf_tags_name'] if !opts[:'filter_waf_tags_name'].nil?
  query_params[:'filter[waf_rule_revisions][source]'] = opts[:'filter_waf_rule_revisions_source'] if !opts[:'filter_waf_rule_revisions_source'].nil?
  query_params[:'filter[waf_firewall.id][not][match]'] = opts[:'filter_waf_firewall_id_not_match'] if !opts[:'filter_waf_firewall_id_not_match'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WafRulesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"WafRulesApi.list_waf_rules",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WafRulesApi#list_waf_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end