Mobile and custom app API - PUT an app

  • Reference
  • Published Nov 05, 2020

Updates the specified mobile or custom app.

The request consumes and produces an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/mobile/{id}

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The UUID of the required mobile or custom application. It can be found in the Instrumentation Wizard of your app.

pathrequired
bodyMobileCustomAppConfig

The JSON body of the request. Contains updated configuration of the mobile or custom application.

Do not set the identifier in the body.

bodyoptional

Request body objects

The MobileCustomAppConfig object

Configuration of an existing mobile or custom application.

ElementTypeDescriptionRequired
apdexSettingsMobileCustomApdex

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

required
applicationIdstring

The UUID of the application.

It is used only by OneAgent to send data to Dynatrace.

optional
applicationTypestring

The type of the application.

  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION
optional
beaconEndpointTypestring

The type of the beacon endpoint.

  • CLUSTER_ACTIVE_GATE
  • ENVIRONMENT_ACTIVE_GATE
  • INSTRUMENTED_WEB_SERVER
required
beaconEndpointUrlstring

The URL of the beacon endpoint.

Only applicable when the beaconEndpointType is set to ENVIRONMENT_ACTIVE_GATE or INSTRUMENTED_WEB_SERVER.

optional
costControlUserSessionPercentageinteger

The percentage of user sessions to be analyzed.

required
iconTypestring

Custom application icon.

Mobile apps always use the mobile device icon, so this icon can only be set for custom apps.

  • AMAZON_ECHO
  • DESKTOP
  • EMBEDDED
  • IOT
  • MICROSOFT_HOLOLENS
  • UFO
  • USERS
optional
identifierstring

The Dynatrace entity ID of the application.

optional
namestring

The name of the application.

required
optInModeEnabledboolean

The opt-in mode is enabled (true) or disabled (false).

This value is only applicable to mobile and not to custom apps.

optional
sessionReplayEnabledboolean

The session replay is enabled (true) or disabled (false). This value is only applicable to mobile and not to custom apps.

optional
sessionReplayOnCrashEnabledboolean

Deprecated. Please use sessionReplayEnabled to enable or disable session replay for mobile apps.

optional

The MobileCustomApdex object

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

ElementTypeDescriptionRequired
frustratedOnErrorboolean

Apdex error condition: if true the user session is considered frustrated when an error is reported.

required
frustratingThresholdinteger

Apdex frustrated threshold, in milliseconds: a duration greater than or equal to this value is considered frustrated.

required
toleratedThresholdinteger

Apdex tolerable threshold, in milliseconds: a duration greater than or equal to this value is considered tolerable.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "apdexSettings": {
    "frustratedOnError": true,
    "frustratingThreshold": 1,
    "toleratedThreshold": 1
  },
  "applicationId": "string",
  "applicationType": "CUSTOM_APPLICATION",
  "beaconEndpointType": "CLUSTER_ACTIVE_GATE",
  "beaconEndpointUrl": "string",
  "costControlUserSessionPercentage": 1,
  "iconType": "AMAZON_ECHO",
  "identifier": "string",
  "name": "string",
  "optInModeEnabled": true,
  "sessionReplayEnabled": true,
  "sessionReplayOnCrashEnabled": true
}

Response

Response codes

CodeTypeDescription
204-

Success. The application has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

404-

Failed. The specified entity doesn't exist.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile/{id}/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/mobile/{id}/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

Success. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.