Serverless
In serverless projects, the following types of API keys exist:
You can manage your keys in Project settings â Management â API keys:
In API keys, click Create API key:
Once created, you can copy the encoded API key and use it to send requests to the Elasticsearch HTTP API. For example:
curl "${ES_URL}" \
-H "Authorization: ApiKey ${API_KEY}"
Important
API keys are intended for programmatic access. Donât use API keys to authenticate access using a web browser.
When you create or update an API key, use Control security privileges to configure access to specific Elasticsearch APIs and resources. Define the permissions using a JSON role_descriptors
object, where you specify one or more roles and the associated privileges.
For example, the following role_descriptors
object defines a books-read-only
role that limits the API key to read
privileges on the books
index.
{
"books-read-only": {
"cluster": [],
"indices": [
{
"names": ["books"],
"privileges": ["read"]
}
],
"applications": [],
"run_as": [],
"metadata": {},
"transient_metadata": {
"enabled": true
}
}
}
For the role_descriptors
object schema, check out the /_security/api_key
endpoint docs. For supported privileges, check Security privileges.
In API keys, click on the name of the key. You can update only Restrict privileges and Include metadata.
The API keys app lists your API keys, including the name, date created, and status. When API keys expire, the status changes from Active
to Expired
.
You can delete API keys individually or in bulk.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4