class Fastly::WafFirewallVersionsApi
Attributes
Public Class Methods
# File lib/fastly/api/waf_firewall_versions_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Clone a firewall version Clone a specific, existing firewall version into a new, draft firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @return [WafFirewallVersionResponse]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 25 def clone_waf_firewall_version(opts = {}) data, _status_code, _headers = clone_waf_firewall_version_with_http_info(opts) data end
Clone a firewall version Clone a specific, existing firewall version into a new, draft firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @return [Array<(WafFirewallVersionResponse
, Integer, Hash)>] WafFirewallVersionResponse
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 35 def clone_waf_firewall_version_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.clone_waf_firewall_version ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] firewall_version_number = opts[:'firewall_version_number'] # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.clone_waf_firewall_version" end # verify the required parameter 'firewall_version_number' is set if @api_client.config.client_side_validation && firewall_version_number.nil? fail ArgumentError, "Missing the required parameter 'firewall_version_number' when calling WafFirewallVersionsApi.clone_waf_firewall_version" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions/{firewall_version_number}/clone'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'firewall_version_number' + '}', CGI.escape(firewall_version_number.to_s)) # query parameters query_params = opts[:query_params] || {} # 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] || 'WafFirewallVersionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.clone_waf_firewall_version", :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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: WafFirewallVersionsApi#clone_waf_firewall_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a firewall version Create a new, draft firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [WafFirewallVersion] :waf_firewall_version @return [WafFirewallVersionResponse]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 95 def create_waf_firewall_version(opts = {}) data, _status_code, _headers = create_waf_firewall_version_with_http_info(opts) data end
Create a firewall version Create a new, draft firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [WafFirewallVersion] :waf_firewall_version @return [Array<(WafFirewallVersionResponse
, Integer, Hash)>] WafFirewallVersionResponse
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 105 def create_waf_firewall_version_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.create_waf_firewall_version ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.create_waf_firewall_version" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'waf_firewall_version']) # return_type return_type = opts[:debug_return_type] || 'WafFirewallVersionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.create_waf_firewall_version", :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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: WafFirewallVersionsApi#create_waf_firewall_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deploy or activate a firewall version Deploy or activate a specific firewall version. If a firewall has been disabled, deploying a firewall version will automatically enable the firewall again. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @return [Object]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 165 def deploy_activate_waf_firewall_version(opts = {}) data, _status_code, _headers = deploy_activate_waf_firewall_version_with_http_info(opts) data end
Deploy or activate a firewall version Deploy or activate a specific firewall version. If a firewall has been disabled, deploying a firewall version will automatically enable the firewall again. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @return [Array<(Object
, Integer, Hash)>] Object
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 175 def deploy_activate_waf_firewall_version_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.deploy_activate_waf_firewall_version ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] firewall_version_number = opts[:'firewall_version_number'] # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.deploy_activate_waf_firewall_version" end # verify the required parameter 'firewall_version_number' is set if @api_client.config.client_side_validation && firewall_version_number.nil? fail ArgumentError, "Missing the required parameter 'firewall_version_number' when calling WafFirewallVersionsApi.deploy_activate_waf_firewall_version" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions/{firewall_version_number}/activate'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'firewall_version_number' + '}', CGI.escape(firewall_version_number.to_s)) # query parameters query_params = opts[:query_params] || {} # 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] || 'Object' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.deploy_activate_waf_firewall_version", :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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: WafFirewallVersionsApi#deploy_activate_waf_firewall_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a firewall version Get details about a specific firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @option opts [String] :include Include relationships. Optional, comma-separated values. Permitted values: `waf_firewall` and `waf_active_rules`. @return [WafFirewallVersionResponse]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 236 def get_waf_firewall_version(opts = {}) data, _status_code, _headers = get_waf_firewall_version_with_http_info(opts) data end
Get a firewall version Get details about a specific firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @option opts [String] :include Include relationships. Optional, comma-separated values. Permitted values: `waf_firewall` and `waf_active_rules`. @return [Array<(WafFirewallVersionResponse
, Integer, Hash)>] WafFirewallVersionResponse
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 247 def get_waf_firewall_version_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.get_waf_firewall_version ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] firewall_version_number = opts[:'firewall_version_number'] # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.get_waf_firewall_version" end # verify the required parameter 'firewall_version_number' is set if @api_client.config.client_side_validation && firewall_version_number.nil? fail ArgumentError, "Missing the required parameter 'firewall_version_number' when calling WafFirewallVersionsApi.get_waf_firewall_version" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions/{firewall_version_number}'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'firewall_version_number' + '}', CGI.escape(firewall_version_number.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] || 'WafFirewallVersionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.get_waf_firewall_version", :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: WafFirewallVersionsApi#get_waf_firewall_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List firewall versions Get a list of firewall versions associated with a specific firewall. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [String] :include Include relationships. Optional. @option opts [Integer] :page_number Current page. @option opts [Integer] :page_size Number of records per page. (default to 20) @return [WafFirewallVersionsResponse]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 310 def list_waf_firewall_versions(opts = {}) data, _status_code, _headers = list_waf_firewall_versions_with_http_info(opts) data end
List firewall versions Get a list of firewall versions associated with a specific firewall. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [String] :include Include relationships. Optional. @option opts [Integer] :page_number Current page. @option opts [Integer] :page_size Number of records per page. (default to 20) @return [Array<(WafFirewallVersionsResponse
, Integer, Hash)>] WafFirewallVersionsResponse
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 322 def list_waf_firewall_versions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.list_waf_firewall_versions ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] 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 WafFirewallVersionsApi.list_waf_firewall_versions, 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 WafFirewallVersionsApi.list_waf_firewall_versions, must be greater than or equal to 1.' end # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.list_waf_firewall_versions" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = opts[:'include'] if !opts[:'include'].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? # 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] || 'WafFirewallVersionsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.list_waf_firewall_versions", :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: WafFirewallVersionsApi#list_waf_firewall_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a firewall version Update a specific firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @option opts [WafFirewallVersion] :waf_firewall_version @return [WafFirewallVersionResponse]
# File lib/fastly/api/waf_firewall_versions_api.rb, line 389 def update_waf_firewall_version(opts = {}) data, _status_code, _headers = update_waf_firewall_version_with_http_info(opts) data end
Update a firewall version Update a specific firewall version. @option opts [String] :firewall_id Alphanumeric string identifying a WAF Firewall. (required) @option opts [Integer] :firewall_version_number Integer identifying a WAF firewall version. (required) @option opts [WafFirewallVersion] :waf_firewall_version @return [Array<(WafFirewallVersionResponse
, Integer, Hash)>] WafFirewallVersionResponse
data, response status code and response headers
# File lib/fastly/api/waf_firewall_versions_api.rb, line 400 def update_waf_firewall_version_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WafFirewallVersionsApi.update_waf_firewall_version ...' end # unbox the parameters from the hash firewall_id = opts[:'firewall_id'] firewall_version_number = opts[:'firewall_version_number'] # verify the required parameter 'firewall_id' is set if @api_client.config.client_side_validation && firewall_id.nil? fail ArgumentError, "Missing the required parameter 'firewall_id' when calling WafFirewallVersionsApi.update_waf_firewall_version" end # verify the required parameter 'firewall_version_number' is set if @api_client.config.client_side_validation && firewall_version_number.nil? fail ArgumentError, "Missing the required parameter 'firewall_version_number' when calling WafFirewallVersionsApi.update_waf_firewall_version" end # resource path local_var_path = '/waf/firewalls/{firewall_id}/versions/{firewall_version_number}'.sub('{' + 'firewall_id' + '}', CGI.escape(firewall_id.to_s)).sub('{' + 'firewall_version_number' + '}', CGI.escape(firewall_version_number.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/vnd.api+json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'waf_firewall_version']) # return_type return_type = opts[:debug_return_type] || 'WafFirewallVersionResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"WafFirewallVersionsApi.update_waf_firewall_version", :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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: WafFirewallVersionsApi#update_waf_firewall_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end