License APIs
Federate includes a license manager service and a set of rest commands to register, verify and delete a Siren’s license. By default, the Siren Community license is included.
Without a valid license, Federate will log a message to notify that the current license is invalid whenever a search request is executed.
Put License
The Put License API allows to upload a license to the cluster:
PUT /_siren/license
Let’s assume you have a Siren license named license.sig
. You can upload and register this license in Elasticsearch using the command:
$ curl -XPUT -H 'Content-Type: application/json' -T license.sig 'http://localhost:9200/_siren/license' --- acknowledged: true
Get License
The Get License API allows to retrieve and validate the license:
GET /_siren/license
The response includes the content of the license as well as a summary of the license validation. If the validity check fails, a list of invalid parameters with a cause is provided:
{ "license_content": { "description": "Siren Community License", "issue_date": "2019-01-29", "permissions": { "federate": { "max_concurrent_sessions": "1", "max_nodes": "1" }, "investigate": { "max_dashboards": "12", "max_graph_nodes": "500", "max_virtual_indices": "5" } }, "valid_date": "2020-01-29" }, "license_validation": { "is_valid": false, "invalid_parameters": [ { "parameter": "permissions.federate.max_nodes", "cause": "Too many nodes in the Federate cluster 2 > 1" }, { "parameter": "permissions.federate.max_concurrent_sessions", "cause": "Too many concurrent user sessions in the Federate cluster 5 > 1" } ] } }