class Fastly::AclApi
Attributes
Public Class Methods
# File lib/fastly/api/acl_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a new ACL Create a new ACL attached to the specified service version. A new, empty ACL must be attached to a draft version of a service. The version associated with the ACL must be activated to be used. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. @return [AclResponse]
# File lib/fastly/api/acl_api.rb, line 26 def create_acl(opts = {}) data, _status_code, _headers = create_acl_with_http_info(opts) data end
Create a new ACL Create a new ACL attached to the specified service version. A new, empty ACL must be attached to a draft version of a service. The version associated with the ACL must be activated to be used. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. @return [Array<(AclResponse
, Integer, Hash)>] AclResponse
data, response status code and response headers
# File lib/fastly/api/acl_api.rb, line 37 def create_acl_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclApi.create_acl ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling AclApi.create_acl" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling AclApi.create_acl" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/acl'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AclResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"AclApi.create_acl", :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: AclApi#create_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an ACL Delete an ACL from the specified service version. To remove an ACL from use, the ACL must be deleted from a draft version and the version without the ACL must be activated. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @return [InlineResponse200]
# File lib/fastly/api/acl_api.rb, line 104 def delete_acl(opts = {}) data, _status_code, _headers = delete_acl_with_http_info(opts) data end
Delete an ACL Delete an ACL from the specified service version. To remove an ACL from use, the ACL must be deleted from a draft version and the version without the ACL must be activated. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
# File lib/fastly/api/acl_api.rb, line 115 def delete_acl_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclApi.delete_acl ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] acl_name = opts[:'acl_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling AclApi.delete_acl" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling AclApi.delete_acl" end # verify the required parameter 'acl_name' is set if @api_client.config.client_side_validation && acl_name.nil? fail ArgumentError, "Missing the required parameter 'acl_name' when calling AclApi.delete_acl" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/acl/{acl_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'acl_name' + '}', CGI.escape(acl_name.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/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"AclApi.delete_acl", :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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: AclApi#delete_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Describe an ACL Retrieve a single ACL by name for the version and service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @return [AclResponse]
# File lib/fastly/api/acl_api.rb, line 181 def get_acl(opts = {}) data, _status_code, _headers = get_acl_with_http_info(opts) data end
Describe an ACL Retrieve a single ACL by name for the version and service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @return [Array<(AclResponse
, Integer, Hash)>] AclResponse
data, response status code and response headers
# File lib/fastly/api/acl_api.rb, line 192 def get_acl_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclApi.get_acl ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] acl_name = opts[:'acl_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling AclApi.get_acl" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling AclApi.get_acl" end # verify the required parameter 'acl_name' is set if @api_client.config.client_side_validation && acl_name.nil? fail ArgumentError, "Missing the required parameter 'acl_name' when calling AclApi.get_acl" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/acl/{acl_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'acl_name' + '}', CGI.escape(acl_name.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/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AclResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"AclApi.get_acl", :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: AclApi#get_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List ACLs List ACLs. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<AclResponse>]
# File lib/fastly/api/acl_api.rb, line 257 def list_acls(opts = {}) data, _status_code, _headers = list_acls_with_http_info(opts) data end
List ACLs List ACLs. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<(Array<AclResponse>, Integer, Hash)>] Array<AclResponse> data, response status code and response headers
# File lib/fastly/api/acl_api.rb, line 267 def list_acls_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclApi.list_acls ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling AclApi.list_acls" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling AclApi.list_acls" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/acl'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_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/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<AclResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"AclApi.list_acls", :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: AclApi#list_acls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an ACL Update an ACL for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @option opts [String] :name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. @return [AclResponse]
# File lib/fastly/api/acl_api.rb, line 329 def update_acl(opts = {}) data, _status_code, _headers = update_acl_with_http_info(opts) data end
Update an ACL Update an ACL for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :acl_name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. (required) @option opts [String] :name Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. @return [Array<(AclResponse
, Integer, Hash)>] AclResponse
data, response status code and response headers
# File lib/fastly/api/acl_api.rb, line 341 def update_acl_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AclApi.update_acl ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] acl_name = opts[:'acl_name'] # verify the required parameter 'service_id' is set if @api_client.config.client_side_validation && service_id.nil? fail ArgumentError, "Missing the required parameter 'service_id' when calling AclApi.update_acl" end # verify the required parameter 'version_id' is set if @api_client.config.client_side_validation && version_id.nil? fail ArgumentError, "Missing the required parameter 'version_id' when calling AclApi.update_acl" end # verify the required parameter 'acl_name' is set if @api_client.config.client_side_validation && acl_name.nil? fail ArgumentError, "Missing the required parameter 'acl_name' when calling AclApi.update_acl" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/acl/{acl_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'acl_name' + '}', CGI.escape(acl_name.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/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'AclResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"AclApi.update_acl", :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: AclApi#update_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end