Skip to content

[DOCS] Reformat update license API docs #48967

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.

Sign up for GitHub

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 1 commit into from
Nov 14, 2019
Merged

[DOCS] Reformat update license API docs #48967

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 29 additions & 27 deletions docs/reference/licensing/update-license.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,25 @@

This API enables you to update your license.

[float]
==== Request
[[update-license-api-request]]
==== {api-request-title}

`PUT /_license`
`PUT _license`

[float]
==== Description
`POST _license`

[[update-license-api-prereqs]]
==== {api-prereq-title}

If {es} {security-features} are enabled, you need `manage` cluster privileges to
install the license.

If {es} {security-features} are enabled and you are installing a gold or platinum
license, you must enable TLS on the transport networking layer before you
install the license. See <<configuring-tls>>.

[[update-license-api-desc]]
==== {api-description-title}

You can update your license at runtime without shutting down your nodes.
License updates take effect immediately. If the license you are installing does
Expand All @@ -25,39 +37,29 @@ request with the `acknowledge` parameter set to `true`.
For more information about the different types of licenses, see
https://www.elastic.co/subscriptions.

[float]
==== Query Parameters
[[update-license-api-query-params]]
==== {api-query-parms-title}

`acknowledge`::
(boolean) Specifies whether you acknowledge the license changes. The default
(Optional, boolean)
Specifies whether you acknowledge the license changes. The default
value is `false`.

[float]
==== Request Body
[[update-license-api-request-body]]
==== {api-request-body-title}

`licenses`::
(array) A sequence of one or more JSON documents containing the license
information.


[float]
==== Authorization

If {es} {security-features} are enabled, you need `manage` cluster privileges to
install the license.

If {es} {security-features} are enabled and you are installing a gold or platinum
license, you must enable TLS on the transport networking layer before you
install the license. See <<configuring-tls>>.
(Required, array)
A sequence of one or more JSON documents containing the license information.

[float]
==== Examples
[[update-license-api-example]]
==== {api-examples-title}

The following example updates to a basic license:

[source,console]
------------------------------------------------------------
POST /_license
PUT _license
{
"licenses": [
{
Expand Down Expand Up @@ -133,7 +135,7 @@ To complete the update, you must re-submit the API request and set the

[source,console]
------------------------------------------------------------
POST /_license?acknowledge=true
PUT _license?acknowledge=true
{
"licenses": [
{
Expand Down