class Fastly::DomainApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/domain_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/domain_api.rb, line 26 def check_domain(opts = {}) data, _status_code, _headers = check_domain_with_http_info(opts) data end
Validate DNS configuration for a single domain on a service Checks the status of a specific domain’s DNS record for a Service
Version
. Returns an array in the same format as domain/check_all. @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] :domain_name The name of the domain or domains associated with this service. (required) @return [Array<Object>]
Source
# File lib/fastly/api/domain_api.rb, line 37 def check_domain_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.check_domain ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] domain_name = opts[:'domain_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 DomainApi.check_domain" 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 DomainApi.check_domain" end # verify the required parameter 'domain_name' is set if @api_client.config.client_side_validation && domain_name.nil? fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainApi.check_domain" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain/{domain_name}/check'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'domain_name' + '}', CGI.escape(domain_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] || 'Array<Object>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.check_domain", :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: DomainApi#check_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Validate DNS configuration for a single domain on a service Checks the status of a specific domain's DNS record for a Service
Version
. Returns an array in the same format as domain/check_all. @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] :domain_name The name of the domain or domains associated with this service. (required) @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 102 def check_domains(opts = {}) data, _status_code, _headers = check_domains_with_http_info(opts) data end
Validate DNS configuration for all domains on a service Checks the status of all domains’ DNS records for a Service
Version
. Returns an array of 3 items for each domain; the first is the details for the domain, the second is the current CNAME of the domain, and the third is a boolean indicating whether or not it has been properly setup to use Fastly
. @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>]
Source
# File lib/fastly/api/domain_api.rb, line 112 def check_domains_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.check_domains ...' 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 DomainApi.check_domains" 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 DomainApi.check_domains" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain/check_all'.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<Array>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.check_domains", :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: DomainApi#check_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Validate DNS configuration for all domains on a service Checks the status of all domains' DNS records for a Service
Version
. Returns an array of 3 items for each domain; the first is the details for the domain, the second is the current CNAME of the domain, and the third is a boolean indicating whether or not it has been properly setup to use Fastly
. @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<Array>, Integer, Hash)>] Array<Array> data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 174 def create_domain(opts = {}) data, _status_code, _headers = create_domain_with_http_info(opts) data end
Add a domain name to a service Create a domain 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] :comment A freeform descriptive note. @option opts [String] :name The name of the domain or domains associated with this service. @return [DomainResponse]
Source
# File lib/fastly/api/domain_api.rb, line 186 def create_domain_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.create_domain ...' 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 DomainApi.create_domain" 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 DomainApi.create_domain" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain'.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['comment'] = opts[:'comment'] if !opts[:'comment'].nil? 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] || 'DomainResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.create_domain", :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: DomainApi#create_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a domain name to a service Create a domain 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] :comment A freeform descriptive note. @option opts [String] :name The name of the domain or domains associated with this service. @return [Array<(DomainResponse
, Integer, Hash)>] DomainResponse
data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 254 def delete_domain(opts = {}) data, _status_code, _headers = delete_domain_with_http_info(opts) data end
Remove a domain from a service Delete the domain for a particular service and versions. @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] :domain_name The name of the domain or domains associated with this service. (required) @return [InlineResponse200]
Source
# File lib/fastly/api/domain_api.rb, line 265 def delete_domain_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.delete_domain ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] domain_name = opts[:'domain_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 DomainApi.delete_domain" 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 DomainApi.delete_domain" end # verify the required parameter 'domain_name' is set if @api_client.config.client_side_validation && domain_name.nil? fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainApi.delete_domain" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain/{domain_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'domain_name' + '}', CGI.escape(domain_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 => :"DomainApi.delete_domain", :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: DomainApi#delete_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Remove a domain from a service Delete the domain for a particular service and versions. @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] :domain_name The name of the domain or domains associated with this service. (required) @return [Array<(InlineResponse200
, Integer, Hash)>] InlineResponse200
data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 331 def get_domain(opts = {}) data, _status_code, _headers = get_domain_with_http_info(opts) data end
Describe a domain Get the domain 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] :domain_name The name of the domain or domains associated with this service. (required) @return [DomainResponse]
Source
# File lib/fastly/api/domain_api.rb, line 342 def get_domain_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.get_domain ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] domain_name = opts[:'domain_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 DomainApi.get_domain" 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 DomainApi.get_domain" end # verify the required parameter 'domain_name' is set if @api_client.config.client_side_validation && domain_name.nil? fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainApi.get_domain" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain/{domain_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'domain_name' + '}', CGI.escape(domain_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] || 'DomainResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.get_domain", :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: DomainApi#get_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Describe a domain Get the domain 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] :domain_name The name of the domain or domains associated with this service. (required) @return [Array<(DomainResponse
, Integer, Hash)>] DomainResponse
data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 407 def list_domains(opts = {}) data, _status_code, _headers = list_domains_with_http_info(opts) data end
List domains List all the domains 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) @return [Array<DomainResponse>]
Source
# File lib/fastly/api/domain_api.rb, line 417 def list_domains_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.list_domains ...' 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 DomainApi.list_domains" 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 DomainApi.list_domains" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain'.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<DomainResponse>' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.list_domains", :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: DomainApi#list_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List domains List all the domains 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) @return [Array<(Array<DomainResponse>, Integer, Hash)>] Array<DomainResponse> data, response status code and response headers
Source
# File lib/fastly/api/domain_api.rb, line 480 def update_domain(opts = {}) data, _status_code, _headers = update_domain_with_http_info(opts) data end
Update a domain Update the domain 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] :domain_name The name of the domain or domains associated with this service. (required) @option opts [String] :comment A freeform descriptive note. @option opts [String] :name The name of the domain or domains associated with this service. @return [DomainResponse]
Source
# File lib/fastly/api/domain_api.rb, line 493 def update_domain_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DomainApi.update_domain ...' end # unbox the parameters from the hash service_id = opts[:'service_id'] version_id = opts[:'version_id'] domain_name = opts[:'domain_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 DomainApi.update_domain" 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 DomainApi.update_domain" end # verify the required parameter 'domain_name' is set if @api_client.config.client_side_validation && domain_name.nil? fail ArgumentError, "Missing the required parameter 'domain_name' when calling DomainApi.update_domain" end # resource path local_var_path = '/service/{service_id}/version/{version_id}/domain/{domain_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'domain_name' + '}', CGI.escape(domain_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['comment'] = opts[:'comment'] if !opts[:'comment'].nil? 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] || 'DomainResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"DomainApi.update_domain", :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: DomainApi#update_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a domain Update the domain 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] :domain_name The name of the domain or domains associated with this service. (required) @option opts [String] :comment A freeform descriptive note. @option opts [String] :name The name of the domain or domains associated with this service. @return [Array<(DomainResponse
, Integer, Hash)>] DomainResponse
data, response status code and response headers