start-basic.asciidoc 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. [role="xpack"]
  2. [[start-basic]]
  3. === Start basic API
  4. ++++
  5. <titleabbrev>Start basic</titleabbrev>
  6. ++++
  7. This API starts an indefinite basic license.
  8. [discrete]
  9. ==== Request
  10. `POST /_license/start_basic`
  11. [discrete]
  12. ==== Description
  13. The `start basic` API enables you to initiate an indefinite basic license, which
  14. gives access to all the basic features. If the basic license does not support
  15. all of the features that are available with your current license, however, you are
  16. notified in the response. You must then re-submit the API request with the
  17. `acknowledge` parameter set to `true`.
  18. To check the status of your basic license, use the following API:
  19. <<get-basic-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. <<security-privileges>>.
  26. [discrete]
  27. ==== Examples
  28. The following example starts a basic license if you do not currently have a license:
  29. [source,console]
  30. ------------------------------------------------------------
  31. POST /_license/start_basic
  32. ------------------------------------------------------------
  33. // TEST[skip:license testing issues]
  34. Example response:
  35. [source,js]
  36. ------------------------------------------------------------
  37. {
  38. "basic_was_started": true,
  39. "acknowledged": true
  40. }
  41. ------------------------------------------------------------
  42. // NOTCONSOLE
  43. The following example starts a basic license if you currently have a license with more
  44. features than a basic license. As you are losing features, you must pass the acknowledge
  45. parameter:
  46. [source,console]
  47. ------------------------------------------------------------
  48. POST /_license/start_basic?acknowledge=true
  49. ------------------------------------------------------------
  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