Adding the Siren Federate Plugin to an Elasticsearch Service

1. Adding the Siren Federate Plugin to an Elasticsearch Service

1.1 Prerequisites

  1. You will require an Elastic Cloud account that has been authorized to install custom plugins. At the time of publication, this is the Gold service level or above. NOTE : On occasion, even the correct service level might not allow this configuration. If you experience any issues, open a ticket with Elasticsearch Support to get the adequate permission.

  2. Download the latest Siren Federate plugin. Please confirm that the Siren Federate version is compatible with the Elasticsearch version that is running on Elastic Cloud. For our full compatibility matrix, go to and see the Setting up Siren Investigate topic, where there is a section on Version compatibility.

IMPORTANT: If you are using a recently released version of Elasticsearch Service (ESS), it is possible the compatible Federate plugin is not yet available. Siren Federate releases are available soon after Elasticsearch releases, so contact our Support team to get the release date for your deployment planning. Also, for this reason, we recommend that you configure your ESS implementation to upgrade on demand, not as an automated process.

1.2 Configuration Steps

  1. Login to your ESS console and click Manage this deployment.


A screen displays your deployment details.


  1. In the Instances section of the screen, the master node instance of Elasticsearch is displayed. In the top-right corner of on the node, click the vertical ellipsis icon, and click Edit configuration.

  1. On the Edit console, select Features.

  1. Select Extensions.

  1. If this is your first time installing a plugin, click Upload extension.


  1. In the Create extension form, for the Version field, supply the version of Siren Federate. HINT : This is the first number before the dash in the name of the zipped file. For example, for “” enter “7.15.2”.

  2. Select An installable plugin and select the downloaded zip to upload.

  3. Click Create extension.The process takes several minutes. If it takes more than a few minutes, or if ESS returns an error, this might be the case mentioned above where ESS has not properly enabled the capability.


  1. After the extension is created, you are returned to the Extensions screen.You can now enable the plugin.


  1. Return to the Edit deployments screen and click Edit user settings and plugins on the right side of the screen.


This opens a large dialog called Elasticsearch plugins and settings.

  1. Click the Plugins tab and select the Siren Federate plugin from the list.

  2. Hit the Back button (you will save this setting from the main Edit page).


  1. At the bottom of the main Edit page, click Save.You are now ready to use the Siren Federate plugin.
1 Like