IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« APM UI storage explorer user APM UI settings »

› › › ›

APM UI API user

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

APM UI API user

edit

Central configuration API

edit

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

Assign the following Kibana feature privileges:

Type Privilege Purpose

Kibana

all on the APM and User Experience feature

Allow all access to the APM and User Experience apps

Type	Privilege	Purpose
Kibana	`all` on the APM and User Experience feature	Allow all access to the APM and User Experience apps

Central configuration API reader

edit

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

Assign the following Kibana feature privileges:

Type Privilege Purpose

Kibana

read on the APM and User Experience feature

Allow read access to the APM and User Experience apps

Type	Privilege	Purpose
Kibana	`read` on the APM and User Experience feature	Allow read access to the APM and User Experience apps

Annotation API

edit

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

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

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 APM and User Experience apps

Type	Privilege	Purpose
Kibana	`all` on the APM and User Experience feature	Allow all access to the APM and User Experience apps

« APM UI storage explorer user APM UI settings »