start-trial.asciidoc 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[start-trial]]
  4. === Start Trial API
  5. This API starts a 30-day trial license.
  6. [float]
  7. ==== Request
  8. `POST /_license/start_trial`
  9. [float]
  10. ==== Description
  11. The `start trial` API enables you to upgrade from a basic license to a 30-day
  12. trial license, which gives access to the platinum features.
  13. NOTE: You are allowed to initiate a trial license only if your cluster has not
  14. already activated a trial license for the current major product version. For
  15. example, if you have already activated a trial for v6.0, you cannot start a new
  16. trial until v7.0. You can, however, contact `info@elastic.co` to request an
  17. extended trial license.
  18. To check the status of your trial license, use the following API:
  19. <<get-trial-status>>.
  20. For more information about the different types of licenses, 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. {xpack-ref}/security-privileges.html[Security Privileges].
  26. [float]
  27. ==== Examples
  28. The following example starts a 30-day trial license. The acknowledge
  29. parameter is required as you are initiating a license that will expire.
  30. [source,js]
  31. ------------------------------------------------------------
  32. POST /_license/start_trial?acknowledge=true
  33. ------------------------------------------------------------
  34. // CONSOLE
  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