class LaunchDarklyApi::OtherApi
Attributes
Public Class Methods
# File lib/launchdarkly_api/api/other_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Gets the public IP list Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall.<br /><br />This endpoint returns a JSON object with two attributes: `addresses` and `outboundAddresses`. The `addresses` element contains the IP addresses LaunchDarkly's service uses. The `outboundAddresses` element contains the IP addresses outgoing webhook notifications use.<br /><br />We post upcoming changes to this list in advance on our [status page](status.launchdarkly.com/). @param [Hash] opts the optional parameters @return [IpList]
# File lib/launchdarkly_api/api/other_api.rb, line 26 def get_ips(opts = {}) data, _status_code, _headers = get_ips_with_http_info(opts) data end
Gets the public IP list Get a list of IP ranges the LaunchDarkly service uses. You can use this list to allow LaunchDarkly through your firewall.<br /><br />This endpoint returns a JSON object with two attributes: `addresses` and `outboundAddresses`. The `addresses` element contains the IP addresses LaunchDarkly's service uses. The `outboundAddresses` element contains the IP addresses outgoing webhook notifications use.<br /><br />We post upcoming changes to this list in advance on our [status page](status.launchdarkly.com/). @param [Hash] opts the optional parameters @return [Array<(IpList
, Integer, Hash)>] IpList
data, response status code and response headers
# File lib/launchdarkly_api/api/other_api.rb, line 35 def get_ips_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OtherApi.get_ips ...' end # resource path local_var_path = '/api/v2/public-ip-list' # 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] || 'IpList' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] new_options = opts.merge( :operation => :"OtherApi.get_ips", :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: OtherApi#get_ips\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets the OpenAPI spec in json The OpenAPI spec endpoint serves the latest version of the OpenAPI specification for LaunchDarkly's API in json format. @param [Hash] opts the optional parameters @return [nil]
# File lib/launchdarkly_api/api/other_api.rb, line 83 def get_openapi_spec(opts = {}) get_openapi_spec_with_http_info(opts) nil end
Gets the OpenAPI spec in json The OpenAPI spec endpoint serves the latest version of the OpenAPI specification for LaunchDarkly's API in json format. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/launchdarkly_api/api/other_api.rb, line 92 def get_openapi_spec_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OtherApi.get_openapi_spec ...' end # resource path local_var_path = '/api/v2/openapi.json' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] new_options = opts.merge( :operation => :"OtherApi.get_openapi_spec", :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: OtherApi#get_openapi_spec\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Root resource Issue a `GET` request to the root resource to find all of the resource categories supported by the API @param [Hash] opts the optional parameters @return [Hash<String, InlineResponse200>]
# File lib/launchdarkly_api/api/other_api.rb, line 138 def get_root(opts = {}) data, _status_code, _headers = get_root_with_http_info(opts) data end
Root resource Issue a `GET` request to the root resource to find all of the resource categories supported by the API @param [Hash] opts the optional parameters @return [Array<(Hash<String, InlineResponse200>, Integer, Hash)>] Hash<String, InlineResponse200> data, response status code and response headers
# File lib/launchdarkly_api/api/other_api.rb, line 147 def get_root_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OtherApi.get_root ...' end # resource path local_var_path = '/api/v2' # 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] || 'Hash<String, InlineResponse200>' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] new_options = opts.merge( :operation => :"OtherApi.get_root", :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: OtherApi#get_root\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get version information Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. @param [Hash] opts the optional parameters @return [VersionsRep]
# File lib/launchdarkly_api/api/other_api.rb, line 195 def get_versions(opts = {}) data, _status_code, _headers = get_versions_with_http_info(opts) data end
Get version information Get the latest API version, the list of valid API versions in ascending order, and the version being used for this request. These are all in the external, date-based format. @param [Hash] opts the optional parameters @return [Array<(VersionsRep
, Integer, Hash)>] VersionsRep
data, response status code and response headers
# File lib/launchdarkly_api/api/other_api.rb, line 204 def get_versions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OtherApi.get_versions ...' end # resource path local_var_path = '/api/v2/versions' # 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] || 'VersionsRep' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] new_options = opts.merge( :operation => :"OtherApi.get_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: OtherApi#get_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end