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
14
import algoliasearch.api.SearchClient
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = client.addApiKey(
  apiKey = ApiKey(
    acl = Seq(Acl.withName("search"), Acl.withName("addObject")),
    description = Some("my new api key"),
    validity = Some(300),
    maxQueriesPerIPPerHour = Some(100),
    maxHitsPerQuery = Some(20)
  )
)
Did you find this page helpful?
Scala API clients v2