get-trial-status.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. [role="xpack"]
  2. [[get-trial-status]]
  3. === Get trial status API
  4. ++++
  5. <titleabbrev>Get trial status</titleabbrev>
  6. ++++
  7. Enables you to check the status of your trial.
  8. [discrete]
  9. ==== Request
  10. `GET /_license/trial_status`
  11. [discrete]
  12. ==== Description
  13. If you want to try all the subscription features, you can start a 30-day trial.
  14. NOTE: You are allowed to initiate a trial only if your cluster has not
  15. already activated a trial for the current major product version. For example, if
  16. you have already activated a trial for v6.0, you cannot start a new trial until
  17. v7.0. You can, however, request an extended trial at {extendtrial}.
  18. For more information about features and subscriptions, 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. <<security-privileges>>.
  24. [discrete]
  25. ==== Examples
  26. The following example checks whether you are eligible to start a trial:
  27. [source,console]
  28. ------------------------------------------------------------
  29. GET /_license/trial_status
  30. ------------------------------------------------------------
  31. Example response:
  32. [source,console-result]
  33. ------------------------------------------------------------
  34. {
  35. "eligible_to_start_trial": true
  36. }
  37. ------------------------------------------------------------
  38. // TESTRESPONSE[s/"eligible_to_start_trial": true/"eligible_to_start_trial": $body.eligible_to_start_trial/]