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 com.algolia.client.api.SearchClient
import com.algolia.client.extensions.*

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

var response = client.addApiKey(
  apiKey = ApiKey(
    acl = listOf(Acl.entries.first { it.value == "search" }, Acl.entries.first { it.value == "addObject" }),
    description = "my new api key",
    validity = 300,
    maxQueriesPerIPPerHour = 100,
    maxHitsPerQuery = 20,
  ),
)
Did you find this page helpful?
Kotlin API clients v3