start-trial.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. [role="xpack"]
  2. [[start-trial]]
  3. === Start trial API
  4. ++++
  5. <titleabbrev>Start trial</titleabbrev>
  6. ++++
  7. Starts a 30-day trial.
  8. [discrete]
  9. ==== Request
  10. `POST /_license/start_trial`
  11. [discrete]
  12. ==== Description
  13. The `start trial` API enables you to start a 30-day trial, which gives access to
  14. all subscription features.
  15. NOTE: You are allowed to initiate a trial only if your cluster has not already
  16. activated a trial for the current major product version. For example, if you
  17. have already activated a trial for v6.0, you cannot start a new trial until v7.0.
  18. You can, however, request an extended trial at {extendtrial}.
  19. To check the status of your trial, use <<get-trial-status>>.
  20. For more information about features and subscriptions, see
  21. https://www.elastic.co/subscriptions.
  22. ==== Authorization
  23. You must have `manage` cluster privileges to use this API.
  24. For more information, see
  25. <<security-privileges>>.
  26. [discrete]
  27. ==== Examples
  28. The following example starts a 30-day trial. The acknowledge parameter is
  29. required as you are initiating a license that will expire.
  30. [source,console]
  31. ------------------------------------------------------------
  32. POST /_license/start_trial?acknowledge=true
  33. ------------------------------------------------------------
  34. // TEST[skip:license testing issues]
  35. Example response:
  36. [source,js]
  37. ------------------------------------------------------------
  38. {
  39. "trial_was_started": true,
  40. "acknowledged": true
  41. }
  42. ------------------------------------------------------------
  43. // NOTCONSOLE