get-trial-status.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[get-trial-status]]
  4. === Get Trial Status API
  5. This API enables you to check the status of your trial license.
  6. [float]
  7. ==== Request
  8. `GET _xpack/license/trial_status`
  9. [float]
  10. ==== Description
  11. If you want to try the features that are included in a platinum license, you can
  12. start a 30-day trial.
  13. NOTE: You are allowed to initiate a trial license only if your cluster has not
  14. already activated a trial license for the current major product version. For
  15. example, if you have already activated a trial for v6.0, you cannot start a new
  16. trial until v7.0. You can, however, contact `info@elastic.co` to request an
  17. extended trial license.
  18. For more information about the different types of licenses, see
  19. https://www.elastic.co/subscriptions.
  20. ==== Authorization
  21. You must have `monitor` cluster privileges to use this API.
  22. For more information, see
  23. {xpack-ref}/security-privileges.html[Security Privileges].
  24. [float]
  25. ==== Examples
  26. The following example checks whether you are eligible to start a trial:
  27. [source,js]
  28. ------------------------------------------------------------
  29. GET _xpack/license/trial_status
  30. ------------------------------------------------------------
  31. // CONSOLE
  32. Example response:
  33. [source,js]
  34. ------------------------------------------------------------
  35. {
  36. "eligible_to_start_trial": true
  37. }
  38. ------------------------------------------------------------
  39. // TESTRESPONSE[s/"eligible_to_start_trial": true/"eligible_to_start_trial": $body.eligible_to_start_trial/]