start-trial.asciidoc 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[start-trial]]
  4. === Start trial API
  5. ++++
  6. <titleabbrev>Start trial</titleabbrev>
  7. ++++
  8. This API starts a 30-day trial license.
  9. [float]
  10. ==== Request
  11. `POST /_license/start_trial`
  12. [float]
  13. ==== Description
  14. The `start trial` API enables you to upgrade from a basic license to a 30-day
  15. trial license, which gives access to the platinum features.
  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. To check the status of your trial license, use the following API:
  22. <<get-trial-status>>.
  23. For more information about the different types of licenses, see
  24. https://www.elastic.co/subscriptions.
  25. ==== Authorization
  26. You must have `manage` cluster privileges to use this API.
  27. For more information, see
  28. {xpack-ref}/security-privileges.html[Security Privileges].
  29. [float]
  30. ==== Examples
  31. The following example starts a 30-day trial license. The acknowledge
  32. parameter is required as you are initiating a license that will expire.
  33. [source,js]
  34. ------------------------------------------------------------
  35. POST /_license/start_trial?acknowledge=true
  36. ------------------------------------------------------------
  37. // CONSOLE
  38. // TEST[skip:license testing issues]
  39. Example response:
  40. [source,js]
  41. ------------------------------------------------------------
  42. {
  43. "trial_was_started": true,
  44. "acknowledged": true
  45. }
  46. ------------------------------------------------------------
  47. // NOTCONSOLE