Get the trial status Generally available; Added in 6.1.0

GET /_license/trial_status
Api key auth Basic auth Bearer auth

Required authorization

  • Cluster privileges: monitor

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • eligible_to_start_trial boolean Required
GET /_license/trial_status 
curl \
 --request GET 'http://api.example.com/_license/trial_status' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET /_license/trial_status`. 
{
  "eligible_to_start_trial": true
}