Type to search.

Applications UI API user

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Users can list, search, create, update, and delete central configurations via the Applications UI API.

  1. Assign the following Kibana feature privileges:

    Type Privilege Purpose
    Kibana all on the APM and User Experience feature Allow all access to the Applications and User Experience UIs

Sometimes a user only needs to list and search central configurations via the Applications UI API.

  1. Assign the following Kibana feature privileges:

    Type Privilege Purpose
    Kibana read on the APM and User Experience feature Allow read access to the Applications and User Experience UIs

Users can use the annotation API to create annotations on their APM data.

  1. Create a new role, named something like annotation_role, and assign the following privileges:

    Type Privilege Purpose
    Index manage on observability-annotations index Check if the observability-annotations index exists
    Index read on observability-annotations index Read the observability-annotations index
    Index create_index on observability-annotations index Create the observability-annotations index
    Index create_doc on observability-annotations index Create new annotations in the observability-annotations index
  2. Assign the annotation_role created previously, and the following Kibana feature privileges to any annotation API users:

    Type Privilege Purpose
    Kibana all on the APM and User Experience feature Allow all access to the Applications and User Experience UIs