get-trial-status.asciidoc 1.5 KB

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