Get license and feature status

GET /v1/features/enterprise

This endpoint reports the current status of the Enterprise Edition license and lists all Enterprise features currently in use. Use this endpoint to monitor license compliance and detect if any Enterprise features are active without a valid license.

Responses

  • 200 application/json

    The status of the Enterprise Edition license and details about Enterprise features that are in-use in the cluster.

    Hide response attributes Show response attributes object
    • license_status string

      The current status of the Enterprise Edition license.

      Values are valid, expired, or not_present.

    • violation boolean

      Whether there is a violation. This will be true if the license status is not 'valid' and one or more Enterprise features are enabled.

    • features array[object]

      A list of Enterprise features in use.

      Information about an Enterprise feature and whether it is enabled in the cluster.

      Hide features attributes Show features attributes object
      • name string

        The name of the Enterprise feature such as tiered_storage.

      • enabled boolean

        Whether the feature is currently enabled (true) or not (false).

GET /v1/features/enterprise
curl \
 --request GET 'http://localhost:9644/v1/features/enterprise'
Response examples (200)
{
  "license_status": "valid",
  "violation": true,
  "features": [
    {
      "name": "string",
      "enabled": true
    }
  ]
}