start-basic.asciidoc 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[start-basic]]
  4. === Start Basic API
  5. This API starts an indefinite basic license.
  6. [float]
  7. ==== Request
  8. `POST _xpack/license/start_basic`
  9. [float]
  10. ==== Description
  11. The `start basic` API enables you to initiate an indefinite basic license, which
  12. gives access to all the basic features. If the basic license does not support
  13. all of the features that are available with your current license, however, you are
  14. notified in the response. You must then re-submit the API request with the
  15. `acknowledge` parameter set to `true`.
  16. To check the status of your basic license, use the following API:
  17. <<get-basic-status>>.
  18. For more information about the different types of licenses, see
  19. https://www.elastic.co/subscriptions.
  20. ==== Authorization
  21. You must have `manage` cluster privileges to use this API.
  22. For more information, see
  23. {xpack-ref}/security-privileges.html[Security Privileges].
  24. [float]
  25. ==== Examples
  26. The following example starts a basic license if you do not currently have a license:
  27. [source,js]
  28. ------------------------------------------------------------
  29. POST _xpack/license/start_basic
  30. ------------------------------------------------------------
  31. // CONSOLE
  32. // TEST[skip:license testing issues]
  33. Example response:
  34. [source,js]
  35. ------------------------------------------------------------
  36. {
  37. "basic_was_started": true,
  38. "acknowledged": true
  39. }
  40. ------------------------------------------------------------
  41. // NOTCONSOLE
  42. The following example starts a basic license if you currently have a license with more
  43. features than a basic license. As you are losing features, you must pass the acknowledge
  44. parameter:
  45. [source,js]
  46. ------------------------------------------------------------
  47. POST _xpack/license/start_basic?acknowledge=true
  48. ------------------------------------------------------------
  49. // CONSOLE
  50. // TEST[skip:license testing issues]
  51. Example response:
  52. [source,js]
  53. ------------------------------------------------------------
  54. {
  55. "basic_was_started": true,
  56. "acknowledged": true
  57. }
  58. ------------------------------------------------------------
  59. // NOTCONSOLE