get-trial-status.asciidoc 1.4 KB

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