You're viewing version 3.7 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

API Key APIs

Introduced 3.7

The API Key APIs let security administrators create, list, and revoke API keys for programmatic access to OpenSearch.

Endpoints

The API Key APIs support the following endpoints:

• Create an API key
• List API keys
• Revoke an API key

Required permissions

If you use the Security plugin, make sure you have the appropriate permissions: cluster:admin/plugins/security/api_token.