class Algolia::Index

def update_api_key(key, object, validity = 0, max_queries_per_IP_per_hour = 0, max_hits_per_query = 0, request_options = {})

Parameters:
  • request_options () -- contains extra parameters to send with your query
  • max_hits_per_query () -- the maximum number of hits this API key can retrieve in one call (0 means unlimited)
  • max_queries_per_IP_per_hour () -- the maximum number of API calls allowed from an IP address per hour (0 means unlimited)
  • validity () -- the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
  • object () -- can be two different parameters: 
def update_api_key(key, object, validity = 0, max_queries_per_IP_per_hour = 0, max_hits_per_query = 0, request_options = {})
  if object.instance_of?(Array)
    params = { :acl => object }
  else
    params = object
  end
  params['validity'] = validity.to_i if validity != 0
  params['maxHitsPerQuery'] = max_hits_per_query.to_i if max_hits_per_query != 0
  params['maxQueriesPerIPPerHour'] = max_queries_per_IP_per_hour.to_i if max_queries_per_IP_per_hour != 0
  client.put(Protocol.index_key_uri(name, key), params.to_json, :write, request_options)
end