start-trial.asciidoc 1.5 KB

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