Skip to content

Move Query API keys examples to ES reference documentation #4637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,7 @@ security-application-privileges,https://www.elastic.co/docs/reference/elasticsea
security-encrypt-http,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security-plus-https#encrypt-http-communication,
security-encrypt-internode,https://www.elastic.co/docs/deploy-manage/security/set-up-basic-security#encrypt-internode-communication,
security-privileges,https://www.elastic.co/docs/reference/elasticsearch/security-privileges,
security-query-api-keys,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/query-api-keys,
security-saml-guide,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/saml,
security-settings-api-keys,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#api-key-service-settings,
security-settings-hashing,https://www.elastic.co/docs/reference/elasticsearch/configuration-reference/security-settings#hashing-settings,
Expand Down Expand Up @@ -923,4 +924,4 @@ watcher-api-update-settings,https://www.elastic.co/docs/api/doc/elasticsearch/op
watsonx-api-keys,https://cloud.ibm.com/iam/apikeys,
watsonx-api-models,https://www.ibm.com/products/watsonx-ai/foundation-models,
watsonx-api-version,https://cloud.ibm.com/apidocs/watsonx-ai#active-version-dates,
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,
xpack-rollup,https://www.elastic.co/docs/manage-data/lifecycle/rollup,
2 changes: 2 additions & 0 deletions specification/security/query_api_keys/QueryApiKeysRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ import { ApiKeyAggregationContainer, ApiKeyQueryContainer } from './types'
* To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
* If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
* If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
* Refer to the linked documentation for examples of how to find API keys:
* @rest_spec_name security.query_api_keys
* @availability stack since=7.15.0 stability=stable
* @availability serverless stability=stable visibility=public
* @cluster_privileges manage_own_api_key, read_security
* @ext_doc_id security-query-api-keys
* @doc_id security-api-query-api-key
*/
export interface Request extends RequestBase {
Expand Down

This file was deleted.

Loading