Grant privileges and roles needed for setupedit

Setting up Heartbeat is an admin-level task that requires extra privileges. As a best practice, grant the setup role to administrators only, and use a more restrictive role for event publishing.

Administrators who set up Heartbeat typically need to load mappings, dashboards, and other objects used to index data into Elasticsearch and visualize it in Kibana.

To grant users the required privileges:

  1. Create a setup role, called something like heartbeat_setup, that has the following privileges:

    Type Privilege Purpose



    Retrieve cluster details (e.g. version)



    Set up and manage index lifecycle management (ILM) policy


    manage on heartbeat-* indices

    Set up aliases used by ILM


    write on heartbeat-* indices

    Write Heartbeat indices in order to index, update, and delete documents

    Omit any privileges that aren’t relevant in your environment.

    These instructions assume that you are using the default name for Heartbeat indices. If heartbeat-* is not listed, or you are using a custom name, enter it manually and modify the privileges to match your index naming pattern.

  2. Assign the setup role, along with the following built-in roles, to users who need to set up Heartbeat:

    Role Purpose


    Load dependencies, such as example dashboards, if available, into Kibana


    Set up index templates and, if available, ingest pipelines

    Omit any roles that aren’t relevant in your environment.