start-basic.asciidoc 2.0 KB

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