Web application configuration API - POST a key user action

Adds a user action to the list of key user actions in the specified application.

The request consumes and produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/keyUserActions
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/keyUserActions
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/web/{id}/keyUserActions


To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
id string

The ID of the required web application.

path required
body KeyUserAction

The JSON body of the request. Contains the action to be marked as a key user action.

body optional

Body format

The KeyUserAction object

Configuration of the key user action.

Element Type Description Required
name string

The name of the action.

actionType string

The type of the action.

domain string

The domain where the action is performed.



Response codes

Code Description

Success. The action has been marked as a key user action. The response contains its ID.


Failed. The input is invalid.

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.