From 4da0180d8069501555000e9f2aa1481e81b4a777 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 30 Dec 2024 18:10:26 -0800 Subject: [PATCH] [DOCS] Add links to searchable snapshot and security APIs --- docs/reference/rest-api/security.asciidoc | 7 +++++++ .../rest-api/security/activate-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/authenticate.asciidoc | 6 ++++++ .../reference/rest-api/security/bulk-create-roles.asciidoc | 6 ++++++ .../reference/rest-api/security/bulk-delete-roles.asciidoc | 6 ++++++ .../rest-api/security/bulk-update-api-keys.asciidoc | 6 ++++++ docs/reference/rest-api/security/change-password.asciidoc | 6 ++++++ .../rest-api/security/clear-api-key-cache.asciidoc | 6 ++++++ docs/reference/rest-api/security/clear-cache.asciidoc | 6 ++++++ .../rest-api/security/clear-privileges-cache.asciidoc | 6 ++++++ .../reference/rest-api/security/clear-roles-cache.asciidoc | 6 ++++++ .../rest-api/security/clear-service-token-caches.asciidoc | 6 ++++++ docs/reference/rest-api/security/create-api-keys.asciidoc | 6 ++++++ .../security/create-cross-cluster-api-key.asciidoc | 7 ++++++- .../rest-api/security/create-role-mappings.asciidoc | 6 ++++++ docs/reference/rest-api/security/create-roles.asciidoc | 6 ++++++ .../rest-api/security/create-service-token.asciidoc | 6 ++++++ docs/reference/rest-api/security/create-users.asciidoc | 6 ++++++ .../rest-api/security/delegate-pki-authentication.asciidoc | 6 ++++++ .../rest-api/security/delete-app-privileges.asciidoc | 6 ++++++ .../rest-api/security/delete-role-mappings.asciidoc | 6 ++++++ docs/reference/rest-api/security/delete-roles.asciidoc | 6 ++++++ .../rest-api/security/delete-service-token.asciidoc | 6 ++++++ docs/reference/rest-api/security/delete-users.asciidoc | 6 ++++++ .../rest-api/security/disable-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/disable-users.asciidoc | 6 ++++++ .../rest-api/security/enable-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/enable-users.asciidoc | 6 ++++++ docs/reference/rest-api/security/enroll-kibana.asciidoc | 6 ++++++ docs/reference/rest-api/security/enroll-node.asciidoc | 6 ++++++ docs/reference/rest-api/security/get-api-keys.asciidoc | 6 ++++++ .../rest-api/security/get-app-privileges.asciidoc | 6 ++++++ .../rest-api/security/get-builtin-privileges.asciidoc | 6 ++++++ .../reference/rest-api/security/get-role-mappings.asciidoc | 6 ++++++ docs/reference/rest-api/security/get-roles.asciidoc | 6 ++++++ .../rest-api/security/get-service-accounts.asciidoc | 6 ++++++ .../rest-api/security/get-service-credentials.asciidoc | 7 ++++++- docs/reference/rest-api/security/get-settings.asciidoc | 6 ++++++ docs/reference/rest-api/security/get-tokens.asciidoc | 6 ++++++ .../rest-api/security/get-user-privileges.asciidoc | 6 ++++++ docs/reference/rest-api/security/get-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/get-users.asciidoc | 7 ++++++- docs/reference/rest-api/security/grant-api-keys.asciidoc | 6 ++++++ .../rest-api/security/has-privileges-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/has-privileges.asciidoc | 6 ++++++ .../rest-api/security/invalidate-api-keys.asciidoc | 6 ++++++ .../reference/rest-api/security/invalidate-tokens.asciidoc | 6 ++++++ .../rest-api/security/oidc-authenticate-api.asciidoc | 6 ++++++ docs/reference/rest-api/security/oidc-logout-api.asciidoc | 6 ++++++ .../security/oidc-prepare-authentication-api.asciidoc | 6 ++++++ .../rest-api/security/put-app-privileges.asciidoc | 6 ++++++ docs/reference/rest-api/security/query-api-key.asciidoc | 7 ++++++- docs/reference/rest-api/security/query-role.asciidoc | 6 ++++++ .../rest-api/security/saml-authenticate-api.asciidoc | 6 ++++++ .../rest-api/security/saml-complete-logout-api.asciidoc | 6 ++++++ .../rest-api/security/saml-invalidate-api.asciidoc | 6 ++++++ docs/reference/rest-api/security/saml-logout-api.asciidoc | 6 ++++++ .../security/saml-prepare-authentication-api.asciidoc | 6 ++++++ docs/reference/rest-api/security/saml-sp-metadata.asciidoc | 6 ++++++ docs/reference/rest-api/security/ssl.asciidoc | 6 ++++++ .../rest-api/security/suggest-user-profile.asciidoc | 6 ++++++ docs/reference/rest-api/security/update-api-key.asciidoc | 6 ++++++ .../security/update-cross-cluster-api-key.asciidoc | 6 ++++++ docs/reference/rest-api/security/update-settings.asciidoc | 6 ++++++ .../rest-api/security/update-user-profile-data.asciidoc | 6 ++++++ .../searchable-snapshots/apis/clear-cache.asciidoc | 6 ++++++ .../searchable-snapshots/apis/mount-snapshot.asciidoc | 6 ++++++ .../searchable-snapshots/apis/node-cache-stats.asciidoc | 6 ++++++ .../apis/searchable-snapshots-apis.asciidoc | 6 ++++++ .../searchable-snapshots/apis/shard-stats.asciidoc | 6 ++++++ 70 files changed, 421 insertions(+), 4 deletions(-) diff --git a/docs/reference/rest-api/security.asciidoc b/docs/reference/rest-api/security.asciidoc index 82cf38e52bd80..57726b074ac3f 100644 --- a/docs/reference/rest-api/security.asciidoc +++ b/docs/reference/rest-api/security.asciidoc @@ -1,6 +1,13 @@ [role="xpack"] [[security-api]] == Security APIs + +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + To use the security APIs, you must set `xpack.security.enabled` to `true` in the `elasticsearch.yml` file. diff --git a/docs/reference/rest-api/security/activate-user-profile.asciidoc b/docs/reference/rest-api/security/activate-user-profile.asciidoc index f6ce32e1bb19e..0db41937f2ff2 100644 --- a/docs/reference/rest-api/security/activate-user-profile.asciidoc +++ b/docs/reference/rest-api/security/activate-user-profile.asciidoc @@ -5,6 +5,12 @@ Activate user profile ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/authenticate.asciidoc b/docs/reference/rest-api/security/authenticate.asciidoc index a02deb444628d..78d9cc2bcaa9f 100644 --- a/docs/reference/rest-api/security/authenticate.asciidoc +++ b/docs/reference/rest-api/security/authenticate.asciidoc @@ -5,6 +5,12 @@ Authenticate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. diff --git a/docs/reference/rest-api/security/bulk-create-roles.asciidoc b/docs/reference/rest-api/security/bulk-create-roles.asciidoc index 37f49f2445770..030e5e42bf29a 100644 --- a/docs/reference/rest-api/security/bulk-create-roles.asciidoc +++ b/docs/reference/rest-api/security/bulk-create-roles.asciidoc @@ -5,6 +5,12 @@ Bulk create or update roles API ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Bulk adds and updates roles in the native realm. [[security-api-bulk-put-role-request]] diff --git a/docs/reference/rest-api/security/bulk-delete-roles.asciidoc b/docs/reference/rest-api/security/bulk-delete-roles.asciidoc index b9978c89bef3a..899591b3276db 100644 --- a/docs/reference/rest-api/security/bulk-delete-roles.asciidoc +++ b/docs/reference/rest-api/security/bulk-delete-roles.asciidoc @@ -5,6 +5,12 @@ Bulk delete roles API ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Bulk deletes roles in the native realm. [[security-api-bulk-delete-role-request]] diff --git a/docs/reference/rest-api/security/bulk-update-api-keys.asciidoc b/docs/reference/rest-api/security/bulk-update-api-keys.asciidoc index faf87c67d1ccc..8206ac5d9d4f3 100644 --- a/docs/reference/rest-api/security/bulk-update-api-keys.asciidoc +++ b/docs/reference/rest-api/security/bulk-update-api-keys.asciidoc @@ -6,6 +6,12 @@ Bulk update API keys ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + [[security-api-bulk-update-api-keys-request]] ==== {api-request-title} diff --git a/docs/reference/rest-api/security/change-password.asciidoc b/docs/reference/rest-api/security/change-password.asciidoc index c035661cdd707..f2dc45cad20b0 100644 --- a/docs/reference/rest-api/security/change-password.asciidoc +++ b/docs/reference/rest-api/security/change-password.asciidoc @@ -5,6 +5,12 @@ Change passwords ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Changes the passwords of users in the native realm and built-in users. [[security-api-change-password-request]] diff --git a/docs/reference/rest-api/security/clear-api-key-cache.asciidoc b/docs/reference/rest-api/security/clear-api-key-cache.asciidoc index 7828026b604f0..61f05a85dfaff 100644 --- a/docs/reference/rest-api/security/clear-api-key-cache.asciidoc +++ b/docs/reference/rest-api/security/clear-api-key-cache.asciidoc @@ -5,6 +5,12 @@ Clear API key cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Evicts a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. diff --git a/docs/reference/rest-api/security/clear-cache.asciidoc b/docs/reference/rest-api/security/clear-cache.asciidoc index 3e4e5432768bd..270856ba28e6b 100644 --- a/docs/reference/rest-api/security/clear-cache.asciidoc +++ b/docs/reference/rest-api/security/clear-cache.asciidoc @@ -5,6 +5,12 @@ Clear cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Evicts users from the user cache. You can completely clear the cache or evict specific users. diff --git a/docs/reference/rest-api/security/clear-privileges-cache.asciidoc b/docs/reference/rest-api/security/clear-privileges-cache.asciidoc index 69a5743419d2c..cf615010779b7 100644 --- a/docs/reference/rest-api/security/clear-privileges-cache.asciidoc +++ b/docs/reference/rest-api/security/clear-privileges-cache.asciidoc @@ -5,6 +5,12 @@ Clear privileges cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Evicts privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. diff --git a/docs/reference/rest-api/security/clear-roles-cache.asciidoc b/docs/reference/rest-api/security/clear-roles-cache.asciidoc index 63c54b51dcf2f..edcb2c2723512 100644 --- a/docs/reference/rest-api/security/clear-roles-cache.asciidoc +++ b/docs/reference/rest-api/security/clear-roles-cache.asciidoc @@ -5,6 +5,12 @@ Clear roles cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Evicts roles from the native role cache. [[security-api-clear-role-cache-request]] diff --git a/docs/reference/rest-api/security/clear-service-token-caches.asciidoc b/docs/reference/rest-api/security/clear-service-token-caches.asciidoc index ff4587549534d..26158220418e0 100644 --- a/docs/reference/rest-api/security/clear-service-token-caches.asciidoc +++ b/docs/reference/rest-api/security/clear-service-token-caches.asciidoc @@ -6,6 +6,12 @@ Clear service account token caches ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Evicts a subset of all entries from the <> token caches. diff --git a/docs/reference/rest-api/security/create-api-keys.asciidoc b/docs/reference/rest-api/security/create-api-keys.asciidoc index f740e9413e3e9..20f1c2cb155ce 100644 --- a/docs/reference/rest-api/security/create-api-keys.asciidoc +++ b/docs/reference/rest-api/security/create-api-keys.asciidoc @@ -5,6 +5,12 @@ Create API keys ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates an API key for access without requiring basic authentication. [[security-api-create-api-key-request]] diff --git a/docs/reference/rest-api/security/create-cross-cluster-api-key.asciidoc b/docs/reference/rest-api/security/create-cross-cluster-api-key.asciidoc index d7d55bafc6d18..63b2f37063f9f 100644 --- a/docs/reference/rest-api/security/create-cross-cluster-api-key.asciidoc +++ b/docs/reference/rest-api/security/create-cross-cluster-api-key.asciidoc @@ -1,11 +1,16 @@ [role="xpack"] [[security-api-create-cross-cluster-api-key]] === Create Cross-Cluster API key API - ++++ Create Cross-Cluster API key ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates an API key of the `cross_cluster` type for the <> access. A `cross_cluster` API key cannot be used to authenticate through the REST interface. On the contrary, a <> is meant to be used through the REST interface diff --git a/docs/reference/rest-api/security/create-role-mappings.asciidoc b/docs/reference/rest-api/security/create-role-mappings.asciidoc index e78d06a5676e4..71c931260865f 100644 --- a/docs/reference/rest-api/security/create-role-mappings.asciidoc +++ b/docs/reference/rest-api/security/create-role-mappings.asciidoc @@ -5,6 +5,12 @@ Create or update role mappings ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates and updates role mappings. [[security-api-put-role-mapping-request]] diff --git a/docs/reference/rest-api/security/create-roles.asciidoc b/docs/reference/rest-api/security/create-roles.asciidoc index d23b9f06e2d87..0b0cd828140a1 100644 --- a/docs/reference/rest-api/security/create-roles.asciidoc +++ b/docs/reference/rest-api/security/create-roles.asciidoc @@ -5,6 +5,12 @@ Create or update roles ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Adds and updates roles in the native realm. [[security-api-put-role-request]] diff --git a/docs/reference/rest-api/security/create-service-token.asciidoc b/docs/reference/rest-api/security/create-service-token.asciidoc index 9a3c2b678c92e..30195d89ff47d 100644 --- a/docs/reference/rest-api/security/create-service-token.asciidoc +++ b/docs/reference/rest-api/security/create-service-token.asciidoc @@ -5,6 +5,12 @@ Create service account tokens ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates a <> token for access without requiring basic authentication. diff --git a/docs/reference/rest-api/security/create-users.asciidoc b/docs/reference/rest-api/security/create-users.asciidoc index 428df1102329c..6d8e1cdaa9ba0 100644 --- a/docs/reference/rest-api/security/create-users.asciidoc +++ b/docs/reference/rest-api/security/create-users.asciidoc @@ -5,6 +5,12 @@ Create or update users ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Adds and updates users in the native realm. These users are commonly referred to as _native users_. diff --git a/docs/reference/rest-api/security/delegate-pki-authentication.asciidoc b/docs/reference/rest-api/security/delegate-pki-authentication.asciidoc index 860708011cd25..00a80b3fd27bc 100644 --- a/docs/reference/rest-api/security/delegate-pki-authentication.asciidoc +++ b/docs/reference/rest-api/security/delegate-pki-authentication.asciidoc @@ -5,6 +5,12 @@ Delegate PKI authentication ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Implements the exchange of an _X509Certificate_ chain into an {es} access token. diff --git a/docs/reference/rest-api/security/delete-app-privileges.asciidoc b/docs/reference/rest-api/security/delete-app-privileges.asciidoc index 39ac1706c6dc2..dad57bcac409c 100644 --- a/docs/reference/rest-api/security/delete-app-privileges.asciidoc +++ b/docs/reference/rest-api/security/delete-app-privileges.asciidoc @@ -5,6 +5,12 @@ Delete application privileges ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Removes <>. [[security-api-delete-privilege-request]] diff --git a/docs/reference/rest-api/security/delete-role-mappings.asciidoc b/docs/reference/rest-api/security/delete-role-mappings.asciidoc index c5dd1aa9c909f..4ec7e3817b031 100644 --- a/docs/reference/rest-api/security/delete-role-mappings.asciidoc +++ b/docs/reference/rest-api/security/delete-role-mappings.asciidoc @@ -5,6 +5,12 @@ Delete role mappings ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Removes role mappings. [[security-api-delete-role-mapping-request]] diff --git a/docs/reference/rest-api/security/delete-roles.asciidoc b/docs/reference/rest-api/security/delete-roles.asciidoc index 427e7c6b1860d..d30a4c5251809 100644 --- a/docs/reference/rest-api/security/delete-roles.asciidoc +++ b/docs/reference/rest-api/security/delete-roles.asciidoc @@ -5,6 +5,12 @@ Delete roles ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Removes roles in the native realm. [[security-api-delete-role-request]] diff --git a/docs/reference/rest-api/security/delete-service-token.asciidoc b/docs/reference/rest-api/security/delete-service-token.asciidoc index b704fb9121263..f7c488e9e7139 100644 --- a/docs/reference/rest-api/security/delete-service-token.asciidoc +++ b/docs/reference/rest-api/security/delete-service-token.asciidoc @@ -5,6 +5,12 @@ Delete service account token ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Deletes <> tokens for a `service` in a specified `namespace`. diff --git a/docs/reference/rest-api/security/delete-users.asciidoc b/docs/reference/rest-api/security/delete-users.asciidoc index b08f99e809b44..ff781a7d9ef0b 100644 --- a/docs/reference/rest-api/security/delete-users.asciidoc +++ b/docs/reference/rest-api/security/delete-users.asciidoc @@ -5,6 +5,12 @@ Delete users ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Deletes users from the native realm. [[security-api-delete-user-request]] diff --git a/docs/reference/rest-api/security/disable-user-profile.asciidoc b/docs/reference/rest-api/security/disable-user-profile.asciidoc index 35658f071679b..f665b8955e0d0 100644 --- a/docs/reference/rest-api/security/disable-user-profile.asciidoc +++ b/docs/reference/rest-api/security/disable-user-profile.asciidoc @@ -5,6 +5,12 @@ Disable user profile ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/disable-users.asciidoc b/docs/reference/rest-api/security/disable-users.asciidoc index 9859085cb1824..3f8bc74d7e106 100644 --- a/docs/reference/rest-api/security/disable-users.asciidoc +++ b/docs/reference/rest-api/security/disable-users.asciidoc @@ -5,6 +5,12 @@ Disable users ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Disables users in the native realm. diff --git a/docs/reference/rest-api/security/enable-user-profile.asciidoc b/docs/reference/rest-api/security/enable-user-profile.asciidoc index e27673b07f598..9f74d90f88b99 100644 --- a/docs/reference/rest-api/security/enable-user-profile.asciidoc +++ b/docs/reference/rest-api/security/enable-user-profile.asciidoc @@ -5,6 +5,12 @@ Enable user profile ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/enable-users.asciidoc b/docs/reference/rest-api/security/enable-users.asciidoc index 04193e6c27944..db78a5c222116 100644 --- a/docs/reference/rest-api/security/enable-users.asciidoc +++ b/docs/reference/rest-api/security/enable-users.asciidoc @@ -5,6 +5,12 @@ Enable users ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Enables users in the native realm. diff --git a/docs/reference/rest-api/security/enroll-kibana.asciidoc b/docs/reference/rest-api/security/enroll-kibana.asciidoc index 55de31b5407d1..78bc0569fa193 100644 --- a/docs/reference/rest-api/security/enroll-kibana.asciidoc +++ b/docs/reference/rest-api/security/enroll-kibana.asciidoc @@ -4,6 +4,12 @@ Enroll {kib} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Enables a {kib} instance to configure itself for communication with a secured {es} cluster. NOTE: This API is currently intended for internal use only by {kib}. diff --git a/docs/reference/rest-api/security/enroll-node.asciidoc b/docs/reference/rest-api/security/enroll-node.asciidoc index 81cae73fb22d6..d5c2ce2a51746 100644 --- a/docs/reference/rest-api/security/enroll-node.asciidoc +++ b/docs/reference/rest-api/security/enroll-node.asciidoc @@ -4,6 +4,12 @@ Enroll node ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Allows a new node to join an existing cluster with security features enabled. [[security-api-node-enrollment-api-request]] diff --git a/docs/reference/rest-api/security/get-api-keys.asciidoc b/docs/reference/rest-api/security/get-api-keys.asciidoc index bf49297539895..6a133f136d4b3 100644 --- a/docs/reference/rest-api/security/get-api-keys.asciidoc +++ b/docs/reference/rest-api/security/get-api-keys.asciidoc @@ -5,6 +5,12 @@ Get API key information ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves information for one or more API keys. [[security-api-get-api-key-request]] diff --git a/docs/reference/rest-api/security/get-app-privileges.asciidoc b/docs/reference/rest-api/security/get-app-privileges.asciidoc index f0f3f1b69071c..c8bb709f96d5a 100644 --- a/docs/reference/rest-api/security/get-app-privileges.asciidoc +++ b/docs/reference/rest-api/security/get-app-privileges.asciidoc @@ -5,6 +5,12 @@ Get application privileges ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves <>. [[security-api-get-privileges-request]] diff --git a/docs/reference/rest-api/security/get-builtin-privileges.asciidoc b/docs/reference/rest-api/security/get-builtin-privileges.asciidoc index 7f3d75b926780..08a03a5b1e830 100644 --- a/docs/reference/rest-api/security/get-builtin-privileges.asciidoc +++ b/docs/reference/rest-api/security/get-builtin-privileges.asciidoc @@ -6,6 +6,12 @@ Get builtin privileges ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves the list of <> and <> that are available in this version of {es}. diff --git a/docs/reference/rest-api/security/get-role-mappings.asciidoc b/docs/reference/rest-api/security/get-role-mappings.asciidoc index 8272ec4d015a8..49063e775982b 100644 --- a/docs/reference/rest-api/security/get-role-mappings.asciidoc +++ b/docs/reference/rest-api/security/get-role-mappings.asciidoc @@ -5,6 +5,12 @@ Get role mappings ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves role mappings. [[security-api-get-role-mapping-request]] diff --git a/docs/reference/rest-api/security/get-roles.asciidoc b/docs/reference/rest-api/security/get-roles.asciidoc index 3cc2f95c6ea7e..03f083e8202f0 100644 --- a/docs/reference/rest-api/security/get-roles.asciidoc +++ b/docs/reference/rest-api/security/get-roles.asciidoc @@ -5,6 +5,12 @@ Get roles ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves roles in the native realm. [[security-api-get-role-request]] diff --git a/docs/reference/rest-api/security/get-service-accounts.asciidoc b/docs/reference/rest-api/security/get-service-accounts.asciidoc index 74f98f2602e34..e392b3100d989 100644 --- a/docs/reference/rest-api/security/get-service-accounts.asciidoc +++ b/docs/reference/rest-api/security/get-service-accounts.asciidoc @@ -6,6 +6,12 @@ Get service accounts ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves information about <>. NOTE: Currently, only the `elastic/fleet-server` service account is available. diff --git a/docs/reference/rest-api/security/get-service-credentials.asciidoc b/docs/reference/rest-api/security/get-service-credentials.asciidoc index 3da6c3d860558..7a24aef059ae9 100644 --- a/docs/reference/rest-api/security/get-service-credentials.asciidoc +++ b/docs/reference/rest-api/security/get-service-credentials.asciidoc @@ -1,11 +1,16 @@ [role="xpack"] [[security-api-get-service-credentials]] === Get service account credentials API - ++++ Get service account credentials ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves all service credentials for a <>. [[security-api-get-service-credentials-request]] diff --git a/docs/reference/rest-api/security/get-settings.asciidoc b/docs/reference/rest-api/security/get-settings.asciidoc index 46e4e0cf529bb..c99b9bcedba21 100644 --- a/docs/reference/rest-api/security/get-settings.asciidoc +++ b/docs/reference/rest-api/security/get-settings.asciidoc @@ -5,6 +5,12 @@ Get Security settings ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves settings for the security internal indices. [[security-api-get-settings-prereqs]] diff --git a/docs/reference/rest-api/security/get-tokens.asciidoc b/docs/reference/rest-api/security/get-tokens.asciidoc index 9f5261a477bcb..eefc86528ef43 100644 --- a/docs/reference/rest-api/security/get-tokens.asciidoc +++ b/docs/reference/rest-api/security/get-tokens.asciidoc @@ -5,6 +5,12 @@ Get token ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates a bearer token for access without requiring basic authentication. [[security-api-get-token-request]] diff --git a/docs/reference/rest-api/security/get-user-privileges.asciidoc b/docs/reference/rest-api/security/get-user-privileges.asciidoc index 8115cd365c5a3..4e0d68b4b679c 100644 --- a/docs/reference/rest-api/security/get-user-privileges.asciidoc +++ b/docs/reference/rest-api/security/get-user-privileges.asciidoc @@ -5,6 +5,12 @@ Get user privileges ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves the <> for the logged in user. diff --git a/docs/reference/rest-api/security/get-user-profile.asciidoc b/docs/reference/rest-api/security/get-user-profile.asciidoc index 9f0ba64d136ac..60732cf0ab395 100644 --- a/docs/reference/rest-api/security/get-user-profile.asciidoc +++ b/docs/reference/rest-api/security/get-user-profile.asciidoc @@ -5,6 +5,12 @@ Get user profiles ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/get-users.asciidoc b/docs/reference/rest-api/security/get-users.asciidoc index 59a390f6f2538..8770c90cdec0a 100644 --- a/docs/reference/rest-api/security/get-users.asciidoc +++ b/docs/reference/rest-api/security/get-users.asciidoc @@ -5,8 +5,13 @@ Get users ++++ -Retrieves information about users in the native realm and built-in users. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- +Retrieves information about users in the native realm and built-in users. [[security-api-get-user-request]] ==== {api-request-title} diff --git a/docs/reference/rest-api/security/grant-api-keys.asciidoc b/docs/reference/rest-api/security/grant-api-keys.asciidoc index 10c109b00bbf9..4ab599c18dd61 100644 --- a/docs/reference/rest-api/security/grant-api-keys.asciidoc +++ b/docs/reference/rest-api/security/grant-api-keys.asciidoc @@ -5,6 +5,12 @@ Grant API keys ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates an API key on behalf of another user. [[security-api-grant-api-key-request]] diff --git a/docs/reference/rest-api/security/has-privileges-user-profile.asciidoc b/docs/reference/rest-api/security/has-privileges-user-profile.asciidoc index afadf394aa43c..3fc825b60bce8 100644 --- a/docs/reference/rest-api/security/has-privileges-user-profile.asciidoc +++ b/docs/reference/rest-api/security/has-privileges-user-profile.asciidoc @@ -5,6 +5,12 @@ Has privileges user profile ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/has-privileges.asciidoc b/docs/reference/rest-api/security/has-privileges.asciidoc index 229ffb4997273..1e08b41d92fe0 100644 --- a/docs/reference/rest-api/security/has-privileges.asciidoc +++ b/docs/reference/rest-api/security/has-privileges.asciidoc @@ -6,6 +6,12 @@ ++++ [[security-api-has-privilege]] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Determines whether the logged in user has a specified list of privileges. [[security-api-has-privileges-request]] diff --git a/docs/reference/rest-api/security/invalidate-api-keys.asciidoc b/docs/reference/rest-api/security/invalidate-api-keys.asciidoc index 57a36a97634ac..27c5a8c831808 100644 --- a/docs/reference/rest-api/security/invalidate-api-keys.asciidoc +++ b/docs/reference/rest-api/security/invalidate-api-keys.asciidoc @@ -5,6 +5,12 @@ Invalidate API key ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Invalidates one or more API keys. [[security-api-invalidate-api-key-request]] diff --git a/docs/reference/rest-api/security/invalidate-tokens.asciidoc b/docs/reference/rest-api/security/invalidate-tokens.asciidoc index 58f20fdcdc425..9a6fe6185b477 100644 --- a/docs/reference/rest-api/security/invalidate-tokens.asciidoc +++ b/docs/reference/rest-api/security/invalidate-tokens.asciidoc @@ -5,6 +5,12 @@ Invalidate token ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Invalidates one or more access tokens or refresh tokens. [[security-api-invalidate-token-request]] diff --git a/docs/reference/rest-api/security/oidc-authenticate-api.asciidoc b/docs/reference/rest-api/security/oidc-authenticate-api.asciidoc index 282a054717e6d..7bf8a1aad3ee1 100644 --- a/docs/reference/rest-api/security/oidc-authenticate-api.asciidoc +++ b/docs/reference/rest-api/security/oidc-authenticate-api.asciidoc @@ -5,6 +5,12 @@ OpenID Connect authenticate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Submits the response to an oAuth 2.0 authentication request for consumption from {es}. Upon successful validation, {es} will respond with an {es} internal Access Token and Refresh Token that can be subsequently used for authentication. diff --git a/docs/reference/rest-api/security/oidc-logout-api.asciidoc b/docs/reference/rest-api/security/oidc-logout-api.asciidoc index a181f4c836fbd..d8bd60b3cd85b 100644 --- a/docs/reference/rest-api/security/oidc-logout-api.asciidoc +++ b/docs/reference/rest-api/security/oidc-logout-api.asciidoc @@ -5,6 +5,12 @@ OpenID Connect logout ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Submits a request to invalidate a refresh token and an access token that was generated as a response to a call to `/_security/oidc/authenticate`. diff --git a/docs/reference/rest-api/security/oidc-prepare-authentication-api.asciidoc b/docs/reference/rest-api/security/oidc-prepare-authentication-api.asciidoc index 4452020b4547c..227f154934306 100644 --- a/docs/reference/rest-api/security/oidc-prepare-authentication-api.asciidoc +++ b/docs/reference/rest-api/security/oidc-prepare-authentication-api.asciidoc @@ -5,6 +5,12 @@ OpenID Connect prepare authentication ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates an oAuth 2.0 authentication request as a URL string based on the configuration of the respective OpenID Connect authentication realm in {es}. diff --git a/docs/reference/rest-api/security/put-app-privileges.asciidoc b/docs/reference/rest-api/security/put-app-privileges.asciidoc index 28be4c08c4e71..cf903d99a724d 100644 --- a/docs/reference/rest-api/security/put-app-privileges.asciidoc +++ b/docs/reference/rest-api/security/put-app-privileges.asciidoc @@ -5,6 +5,12 @@ Create or update application privileges ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Adds or updates <>. [[security-api-put-privileges-request]] diff --git a/docs/reference/rest-api/security/query-api-key.asciidoc b/docs/reference/rest-api/security/query-api-key.asciidoc index 513cb99a55a4c..1dec37c166f89 100644 --- a/docs/reference/rest-api/security/query-api-key.asciidoc +++ b/docs/reference/rest-api/security/query-api-key.asciidoc @@ -1,11 +1,16 @@ [role="xpack"] [[security-api-query-api-key]] === Query API key information API - ++++ Query API key information ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + //// [source,console] ---- diff --git a/docs/reference/rest-api/security/query-role.asciidoc b/docs/reference/rest-api/security/query-role.asciidoc index 937bd263140fc..acdfbb45b84f6 100644 --- a/docs/reference/rest-api/security/query-role.asciidoc +++ b/docs/reference/rest-api/security/query-role.asciidoc @@ -6,6 +6,12 @@ Query Role ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Retrieves roles with <> in a <> fashion. [[security-api-query-role-request]] diff --git a/docs/reference/rest-api/security/saml-authenticate-api.asciidoc b/docs/reference/rest-api/security/saml-authenticate-api.asciidoc index aa556a42d699c..4c156df6e1bb3 100644 --- a/docs/reference/rest-api/security/saml-authenticate-api.asciidoc +++ b/docs/reference/rest-api/security/saml-authenticate-api.asciidoc @@ -5,6 +5,12 @@ SAML authenticate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Submits a SAML `Response` message to {es} for consumption. NOTE: This API is intended for use by custom web applications other than {kib}. diff --git a/docs/reference/rest-api/security/saml-complete-logout-api.asciidoc b/docs/reference/rest-api/security/saml-complete-logout-api.asciidoc index 1fb4ab1581abc..d4847fb481cdb 100644 --- a/docs/reference/rest-api/security/saml-complete-logout-api.asciidoc +++ b/docs/reference/rest-api/security/saml-complete-logout-api.asciidoc @@ -5,6 +5,12 @@ SAML complete logout ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Verifies the logout response sent from the SAML IdP. NOTE: This API is intended for use by custom web applications other than {kib}. diff --git a/docs/reference/rest-api/security/saml-invalidate-api.asciidoc b/docs/reference/rest-api/security/saml-invalidate-api.asciidoc index 21c10341c6fee..fb233f3903d1c 100644 --- a/docs/reference/rest-api/security/saml-invalidate-api.asciidoc +++ b/docs/reference/rest-api/security/saml-invalidate-api.asciidoc @@ -5,6 +5,12 @@ SAML invalidate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Submits a SAML LogoutRequest message to {es} for consumption. NOTE: This API is intended for use by custom web applications other than {kib}. diff --git a/docs/reference/rest-api/security/saml-logout-api.asciidoc b/docs/reference/rest-api/security/saml-logout-api.asciidoc index 71729365865dc..560a713b5bf15 100644 --- a/docs/reference/rest-api/security/saml-logout-api.asciidoc +++ b/docs/reference/rest-api/security/saml-logout-api.asciidoc @@ -5,6 +5,12 @@ SAML logout ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Submits a request to invalidate an access token and refresh token. NOTE: This API is intended for use by custom web applications other than {kib}. diff --git a/docs/reference/rest-api/security/saml-prepare-authentication-api.asciidoc b/docs/reference/rest-api/security/saml-prepare-authentication-api.asciidoc index b62d3d2ac9f75..60b3451cc531d 100644 --- a/docs/reference/rest-api/security/saml-prepare-authentication-api.asciidoc +++ b/docs/reference/rest-api/security/saml-prepare-authentication-api.asciidoc @@ -5,6 +5,12 @@ SAML prepare authentication ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Creates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in {es}. NOTE: This API is intended for use by custom web applications other than {kib}. diff --git a/docs/reference/rest-api/security/saml-sp-metadata.asciidoc b/docs/reference/rest-api/security/saml-sp-metadata.asciidoc index deecbf5f0e664..0f66b7a9f76f8 100644 --- a/docs/reference/rest-api/security/saml-sp-metadata.asciidoc +++ b/docs/reference/rest-api/security/saml-sp-metadata.asciidoc @@ -5,6 +5,12 @@ SAML service provider metadata ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Generate SAML metadata for a SAML 2.0 Service Provider. [[security-api-saml-sp-metadata-request]] diff --git a/docs/reference/rest-api/security/ssl.asciidoc b/docs/reference/rest-api/security/ssl.asciidoc index 3b8ba0eab6888..78b9aee301096 100644 --- a/docs/reference/rest-api/security/ssl.asciidoc +++ b/docs/reference/rest-api/security/ssl.asciidoc @@ -5,6 +5,12 @@ SSL certificate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + The `certificates` API enables you to retrieve information about the X.509 certificates that are used to encrypt communications in your {es} cluster. diff --git a/docs/reference/rest-api/security/suggest-user-profile.asciidoc b/docs/reference/rest-api/security/suggest-user-profile.asciidoc index ad01987a1e704..4ea04864e4a6e 100644 --- a/docs/reference/rest-api/security/suggest-user-profile.asciidoc +++ b/docs/reference/rest-api/security/suggest-user-profile.asciidoc @@ -5,6 +5,12 @@ Suggest user profile ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/rest-api/security/update-api-key.asciidoc b/docs/reference/rest-api/security/update-api-key.asciidoc index f297e3922a657..12dd883b5955d 100644 --- a/docs/reference/rest-api/security/update-api-key.asciidoc +++ b/docs/reference/rest-api/security/update-api-key.asciidoc @@ -6,6 +6,12 @@ Update API key ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + [[security-api-update-api-key-request]] ==== {api-request-title} diff --git a/docs/reference/rest-api/security/update-cross-cluster-api-key.asciidoc b/docs/reference/rest-api/security/update-cross-cluster-api-key.asciidoc index b90cb6368eefb..5c5f55b73597a 100644 --- a/docs/reference/rest-api/security/update-cross-cluster-api-key.asciidoc +++ b/docs/reference/rest-api/security/update-cross-cluster-api-key.asciidoc @@ -6,6 +6,12 @@ Update Cross-Cluster API key ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Update an existing cross-cluster API Key that is used for <> access. diff --git a/docs/reference/rest-api/security/update-settings.asciidoc b/docs/reference/rest-api/security/update-settings.asciidoc index b227bb70b31d7..3ec2ef98153c4 100644 --- a/docs/reference/rest-api/security/update-settings.asciidoc +++ b/docs/reference/rest-api/security/update-settings.asciidoc @@ -5,6 +5,12 @@ Update Security settings ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + Updates the settings of the security internal indices. diff --git a/docs/reference/rest-api/security/update-user-profile-data.asciidoc b/docs/reference/rest-api/security/update-user-profile-data.asciidoc index 01fa5e11d10e8..c461c169a517a 100644 --- a/docs/reference/rest-api/security/update-user-profile-data.asciidoc +++ b/docs/reference/rest-api/security/update-user-profile-data.asciidoc @@ -5,6 +5,12 @@ Update user profile data ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-security[Security APIs]. +-- + NOTE: The user profile feature is designed only for use by {kib} and Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual users and external applications should not call this API directly. Elastic reserves diff --git a/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc b/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc index ff67be02e6d00..ac357e29d1d17 100644 --- a/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc +++ b/docs/reference/searchable-snapshots/apis/clear-cache.asciidoc @@ -5,6 +5,12 @@ Clear cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-searchable_snapshots[Searchable snapshots APIs]. +-- + experimental::[] Clears indices and data streams from the shared cache for diff --git a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc index b47bc2370ab10..f1613ea62492d 100644 --- a/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc +++ b/docs/reference/searchable-snapshots/apis/mount-snapshot.asciidoc @@ -5,6 +5,12 @@ Mount snapshot ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-searchable_snapshots[Searchable snapshots APIs]. +-- + Mount a snapshot as a searchable snapshot index. [[searchable-snapshots-api-mount-request]] diff --git a/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc b/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc index 62faceb99d4fc..d42ba02876941 100644 --- a/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc +++ b/docs/reference/searchable-snapshots/apis/node-cache-stats.asciidoc @@ -5,6 +5,12 @@ Cache stats ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-searchable_snapshots[Searchable snapshots APIs]. +-- + Retrieves statistics about the shared cache for <>. diff --git a/docs/reference/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc b/docs/reference/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc index f90e27ea63224..1a1856198d286 100644 --- a/docs/reference/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc +++ b/docs/reference/searchable-snapshots/apis/searchable-snapshots-apis.asciidoc @@ -2,6 +2,12 @@ [[searchable-snapshots-apis]] == Searchable snapshots APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-searchable_snapshots[Searchable snapshots APIs]. +-- + You can use the following APIs to perform searchable snapshots operations. * <> diff --git a/docs/reference/searchable-snapshots/apis/shard-stats.asciidoc b/docs/reference/searchable-snapshots/apis/shard-stats.asciidoc index 369d19da9ae56..f1eb9ac8d92b2 100644 --- a/docs/reference/searchable-snapshots/apis/shard-stats.asciidoc +++ b/docs/reference/searchable-snapshots/apis/shard-stats.asciidoc @@ -5,6 +5,12 @@ Searchable snapshot statistics ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-searchable_snapshots[Searchable snapshots APIs]. +-- + experimental::[] Retrieves statistics about searchable snapshots.