diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index d9a006bc5f..815d4b2965 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -113,6 +113,9 @@ actions: - name: license x-displayName: Licensing description: Licensing APIs enable you to manage your licenses. + externalDocs: + url: https://www.elastic.co/subscriptions + description: For more information about the different types of licenses, refer to Elastic subscriptions - name: logstash x-displayName: Logstash description: > diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5a07e1e9c6..0da92ddd44 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15775,7 +15775,7 @@ "license" ], "summary": "Get license information", - "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "operationId": "license-get", "parameters": [ { @@ -15824,7 +15824,8 @@ "tags": [ "license" ], - "summary": "Updates the license for the cluster", + "summary": "Update the license", + "description": "You can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "operationId": "license-post", "parameters": [ { @@ -15844,7 +15845,8 @@ "tags": [ "license" ], - "summary": "Updates the license for the cluster", + "summary": "Update the license", + "description": "You can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "operationId": "license-post-1", "parameters": [ { @@ -15864,7 +15866,11 @@ "tags": [ "license" ], - "summary": "Deletes licensing information for the cluster", + "summary": "Delete the license", + "description": "When the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/kibana/current/managing-licenses.html" + }, "operationId": "license-delete", "responses": { "200": { @@ -15885,7 +15891,7 @@ "tags": [ "license" ], - "summary": "Retrieves information about the status of the basic license", + "summary": "Get the basic license status", "operationId": "license-get-basic-status", "responses": { "200": { @@ -15915,7 +15921,7 @@ "tags": [ "license" ], - "summary": "Retrieves information about the status of the trial license", + "summary": "Get the trial status", "operationId": "license-get-trial-status", "responses": { "200": { @@ -15945,8 +15951,8 @@ "tags": [ "license" ], - "summary": "The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features", - "description": "If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.\nTo check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", + "summary": "Start a basic license", + "description": "Start an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "operationId": "license-post-start-basic", "parameters": [ { @@ -16014,7 +16020,8 @@ "tags": [ "license" ], - "summary": "The start trial API enables you to start a 30-day trial, which gives access to all subscription features", + "summary": "Start a trial", + "description": "Start a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "operationId": "license-post-start-trial", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 597cbfcab5..4588f770bc 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9398,7 +9398,7 @@ "license" ], "summary": "Get license information", - "description": "Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Get information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "operationId": "license-get", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2a2f991e10..7b6dee6672 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9114,9 +9114,16 @@ "stability": "stable" } }, - "description": "Deletes licensing information for the cluster", + "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html", + "extDocId": "license-management", + "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html", "name": "license.delete", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "license.delete" @@ -9148,7 +9155,7 @@ "stability": "stable" } }, - "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html", "name": "license.get", "request": { @@ -9179,9 +9186,14 @@ "stability": "stable" } }, - "description": "Retrieves information about the status of the basic license.", + "description": "Get the basic license status.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html", "name": "license.get_basic_status", + "privileges": { + "cluster": [ + "monitor" + ] + }, "request": { "name": "Request", "namespace": "license.get_basic_status" @@ -9210,9 +9222,14 @@ "stability": "stable" } }, - "description": "Retrieves information about the status of the trial license.", + "description": "Get the trial status.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html", "name": "license.get_trial_status", + "privileges": { + "cluster": [ + "monitor" + ] + }, "request": { "name": "Request", "namespace": "license.get_trial_status" @@ -9240,7 +9257,7 @@ "stability": "stable" } }, - "description": "Updates the license for the cluster.", + "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html", "name": "license.post", "privileges": { @@ -9280,9 +9297,14 @@ "stability": "stable" } }, - "description": "The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.\nTo check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", + "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html", "name": "license.post_start_basic", + "privileges": { + "cluster": [ + "manage" + ] + }, "request": { "name": "Request", "namespace": "license.post_start_basic" @@ -9311,7 +9333,7 @@ "stability": "stable" } }, - "description": "The start trial API enables you to start a 30-day trial, which gives access to all subscription features.", + "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html", "name": "license.post_start_trial", "privileges": { @@ -147880,7 +147902,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes licensing information for the cluster", + "description": "Delete the license.\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -147893,7 +147915,7 @@ }, "path": [], "query": [], - "specLocation": "license/delete/DeleteLicenseRequest.ts#L22-L26" + "specLocation": "license/delete/DeleteLicenseRequest.ts#L22-L32" }, { "kind": "response", @@ -148114,7 +148136,7 @@ "body": { "kind": "no_body" }, - "description": "Get license information.\nReturns information about your Elastic license, including its type, its status, when it was issued, and when it expires.\nFor more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).", + "description": "Get license information.\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\nNOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\nIf you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "inherits": { "type": { "name": "RequestBase", @@ -148158,7 +148180,7 @@ } } ], - "specLocation": "license/get/GetLicenseRequest.ts#L22-L45" + "specLocation": "license/get/GetLicenseRequest.ts#L22-L47" }, { "kind": "response", @@ -148192,7 +148214,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about the status of the basic license.", + "description": "Get the basic license status.", "inherits": { "type": { "name": "RequestBase", @@ -148205,7 +148227,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L26" + "specLocation": "license/get_basic_status/GetBasicLicenseStatusRequest.ts#L22-L28" }, { "kind": "response", @@ -148239,7 +148261,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about the status of the trial license.", + "description": "Get the trial status.", "inherits": { "type": { "name": "RequestBase", @@ -148252,7 +148274,7 @@ }, "path": [], "query": [], - "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L26" + "specLocation": "license/get_trial_status/GetTrialLicenseStatusRequest.ts#L22-L28" }, { "kind": "response", @@ -148349,7 +148371,7 @@ } ] }, - "description": "Updates the license for the cluster.", + "description": "Update the license.\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "inherits": { "type": { "name": "RequestBase", @@ -148376,7 +148398,7 @@ } } ], - "specLocation": "license/post/PostLicenseRequest.ts#L23-L43" + "specLocation": "license/post/PostLicenseRequest.ts#L23-L51" }, { "kind": "response", @@ -148432,7 +148454,7 @@ "body": { "kind": "no_body" }, - "description": "The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.\nTo check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).", + "description": "Start a basic license.\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "inherits": { "type": { "name": "RequestBase", @@ -148458,7 +148480,7 @@ } } ], - "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L22-L32" + "specLocation": "license/post_start_basic/StartBasicLicenseRequest.ts#L22-L40" }, { "kind": "response", @@ -148562,7 +148584,7 @@ "body": { "kind": "no_body" }, - "description": "The start trial API enables you to start a 30-day trial, which gives access to all subscription features.", + "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "inherits": { "type": { "name": "RequestBase", @@ -148599,7 +148621,7 @@ } } ], - "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L33" + "specLocation": "license/post_start_trial/StartTrialLicenseRequest.ts#L22-L39" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 28e522a7a8..1e7fac6559 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -261,6 +261,7 @@ k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sea k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall kv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv-processor.html knn-inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn-search.html#nested-knn-search-inner-hits +license-management,https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html diff --git a/specification/license/delete/DeleteLicenseRequest.ts b/specification/license/delete/DeleteLicenseRequest.ts index 26656cd76a..2f432fecda 100644 --- a/specification/license/delete/DeleteLicenseRequest.ts +++ b/specification/license/delete/DeleteLicenseRequest.ts @@ -20,7 +20,13 @@ import { RequestBase } from '@_types/Base' /** + * Delete the license. + * When the license expires, your subscription level reverts to Basic. + * + * If the operator privileges feature is enabled, only operator users can use this API. * @rest_spec_name license.delete * @availability stack stability=stable + * @cluster_privileges manage + * @ext_doc_id license-management */ export interface Request extends RequestBase {} diff --git a/specification/license/get/GetLicenseRequest.ts b/specification/license/get/GetLicenseRequest.ts index 4010183869..94c7f5d2f4 100644 --- a/specification/license/get/GetLicenseRequest.ts +++ b/specification/license/get/GetLicenseRequest.ts @@ -21,8 +21,10 @@ import { RequestBase } from '@_types/Base' /** * Get license information. - * Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. - * For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions). + * Get information about your Elastic license including its type, its status, when it was issued, and when it expires. + * + * NOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. + * If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. * @rest_spec_name license.get * @availability stack stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts index 80ecfbc11a..56d021756c 100644 --- a/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts +++ b/specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** + * Get the basic license status. * @rest_spec_name license.get_basic_status * @availability stack since=6.3.0 stability=stable + * @cluster_privileges monitor */ export interface Request extends RequestBase {} diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts index b4ae8ca6c7..01b9a2d6df 100644 --- a/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts +++ b/specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** + * Get the trial status. * @rest_spec_name license.get_trial_status * @availability stack since=6.1.0 stability=stable + * @cluster_privileges monitor */ export interface Request extends RequestBase {} diff --git a/specification/license/post/PostLicenseRequest.ts b/specification/license/post/PostLicenseRequest.ts index 8951d5188d..bc7d0e89ca 100644 --- a/specification/license/post/PostLicenseRequest.ts +++ b/specification/license/post/PostLicenseRequest.ts @@ -21,6 +21,14 @@ import { License } from '@license/_types/License' import { RequestBase } from '@_types/Base' /** + * Update the license. + * You can update your license at runtime without shutting down your nodes. + * License updates take effect immediately. + * If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + * You must then re-submit the API request with the acknowledge parameter set to true. + * + * NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + * If the operator privileges feature is enabled, only operator users can use this API. * @rest_spec_name license.post * @availability stack stability=stable * @cluster_privileges manage diff --git a/specification/license/post_start_basic/StartBasicLicenseRequest.ts b/specification/license/post_start_basic/StartBasicLicenseRequest.ts index 996c20ba7a..63339ddafb 100644 --- a/specification/license/post_start_basic/StartBasicLicenseRequest.ts +++ b/specification/license/post_start_basic/StartBasicLicenseRequest.ts @@ -20,10 +20,18 @@ import { RequestBase } from '@_types/Base' /** - * The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. - * To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html). + * Start a basic license. + * Start an indefinite basic license, which gives access to all the basic features. + * + * NOTE: In order to start a basic license, you must not currently have a basic license. + * + * If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + * You must then re-submit the API request with the `acknowledge` parameter set to `true`. + * + * To check the status of your basic license, use the get basic license API. * @rest_spec_name license.post_start_basic * @availability stack since=6.3.0 stability=stable + * @cluster_privileges manage */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/license/post_start_trial/StartTrialLicenseRequest.ts b/specification/license/post_start_trial/StartTrialLicenseRequest.ts index a28040f803..5c722aec81 100644 --- a/specification/license/post_start_trial/StartTrialLicenseRequest.ts +++ b/specification/license/post_start_trial/StartTrialLicenseRequest.ts @@ -20,7 +20,13 @@ import { RequestBase } from '@_types/Base' /** - * The start trial API enables you to start a 30-day trial, which gives access to all subscription features. + * Start a trial. + * Start a 30-day trial, which gives access to all subscription features. + * + * NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + * For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + * + * To check the status of your trial, use the get trial status API. * @rest_spec_name license.post_start_trial * @availability stack since=6.1.0 stability=stable * @cluster_privileges manage