Create an API key

Creates a new API key with specific permissions and restrictions.

Usage

Requires Admin API key
1
2
3
4
5
6
7
8
9
10
11
12
13
require "algolia"

client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.add_api_key(
  Algolia::Search::ApiKey.new(
    acl: ["search", "addObject"],
    description: "my new api key",
    validity: 300,
    max_queries_per_ip_per_hour: 100,
    max_hits_per_query: 20
  )
)
Did you find this page helpful?
Ruby API clients v3