clients/oathkeeper/ruby/lib/ory-oathkeeper-client/api/api_api.rb
# Check alive status
# This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working.  If the service supports TLS Edge Termination, this endpoint does not require the &#x60;X-Forwarded-Proto&#x60; header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
# @param [Hash] opts the optional parameters
# @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
Check alive status
This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
Check alive status This endpoint returns a 200 status code when the HTTP server is up running . This status does currently not include checks whether the database connection is working . If the service supports TLS Edge Termination this endpoint does not require the ` X - Forwarded - Proto ` header to be set . Be aware that if you are running multiple nodes of this service the health status will never refer to the cluster state only to a single instance .
def is_instance_alive_with_http_info(opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: ApiApi.is_instance_alive ...'
      end
      local_var_path = '/health/alive'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type] || 'HealthStatus'
      auth_names = opts[:debug_auth_names] || []
      new_options = opts.merge(
        :operation => :"ApiApi.is_instance_alive",
        :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: ApiApi#is_instance_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def is_instance_alive_with_http_info ( opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: ApiApi.is_instance_alive ...' end local_var_path = '/health/alive' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] || 'HealthStatus' auth_names = opts [ :debug_auth_names ] || [ ] new_options = opts . merge ( :operation => :" ApiApi.is_instance_alive " , :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: ApiApi#is_instance_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Check alive status
This endpoint returns a 200 status code when the HTTP server is up running.
Check alive status This endpoint returns a 200 status code when the HTTP server is up running .
# resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
HealthStatus data, response status code and response headers
HealthStatus data response status code and response headers
Array<(HealthStatus, Integer, Hash)>
opts
<not_specific>
<not_specific>
opts the optional parameters
opts the optional parameters