API key APIs
Introduced 3.7
The API key APIs create, list, and revoke the API keys used to authenticate requests without a user name and password.
OpenSearch supports the following API key APIs.
| API | Description |
|---|---|
| Create API Key API | Creates an API key with the specified permissions and expiration. |
| List API Keys API | Returns all API keys, including active, expired, and revoked keys. |
| Revoke API Key API | Revokes an API key, making it immediately unusable for authentication. |
Required permissions
To use the API key APIs, you must have the cluster:admin/plugins/security/api_token permission.