class Fastly::TlsDomainsApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/tls_domains_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/tls_domains_api.rb, line 30 def list_tls_domains(opts = {}) data, _status_code, _headers = list_tls_domains_with_http_info(opts) data end
List TLS domains List all TLS domains. @option opts [String] :filter_in_use Optional. Limit the returned domains to those currently using Fastly
to terminate TLS with SNI (that is, domains considered "in use") Permitted values: true, false. @option opts [String] :filter_tls_certificates_id Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list. @option opts [String] :filter_tls_subscriptions_id Optional. Limit the returned domains to those for a given TLS subscription. @option opts [String] :include Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. @option opts [String] :sort The order in which to list the results. (default to ‘id’) @option opts [Integer] :page_number Current page. @option opts [Integer] :page_size Number of records per page. (default to 20) @return [TlsDomainsResponse]
Source
# File lib/fastly/api/tls_domains_api.rb, line 45 def list_tls_domains_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TlsDomainsApi.list_tls_domains ...' end # unbox the parameters from the hash allowable_values = ["tls_activations.created_at", "-tls_activations.created_at", "id", "-id"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end 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 TlsDomainsApi.list_tls_domains, 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 TlsDomainsApi.list_tls_domains, must be greater than or equal to 1.' end # resource path local_var_path = '/tls/domains' # query parameters query_params = opts[:query_params] || {} query_params[:'filter[in_use]'] = opts[:'filter_in_use'] if !opts[:'filter_in_use'].nil? query_params[:'filter[tls_certificates.id]'] = opts[:'filter_tls_certificates_id'] if !opts[:'filter_tls_certificates_id'].nil? query_params[:'filter[tls_subscriptions.id]'] = opts[:'filter_tls_subscriptions_id'] if !opts[:'filter_tls_subscriptions_id'].nil? query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'TlsDomainsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"TlsDomainsApi.list_tls_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: TlsDomainsApi#list_tls_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List TLS domains List all TLS domains. @option opts [String] :filter_in_use Optional. Limit the returned domains to those currently using Fastly
to terminate TLS with SNI (that is, domains considered "in use") Permitted values: true, false. @option opts [String] :filter_tls_certificates_id Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list. @option opts [String] :filter_tls_subscriptions_id Optional. Limit the returned domains to those for a given TLS subscription. @option opts [String] :include Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. @option opts [String] :sort The order in which to list the results. (default to ‘id’) @option opts [Integer] :page_number Current page. @option opts [Integer] :page_size Number of records per page. (default to 20) @return [Array<(TlsDomainsResponse
, Integer, Hash)>] TlsDomainsResponse
data, response status code and response headers