Mobile and custom app API - PUT an app

Updates the specified mobile or custom app.

The request consumes and produces an application/json payload.

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

Authentication

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.

Parameters

Parameter Type Description In Required
id string

The ID of the application to be updated.

path required
body MobileCustomAppConfig

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

Do not set the identifier in the body.

body optional

Body format

The MobileCustomAppConfig object

Configuration of an existing mobile or custom application.

Element Type Description Required
name string

The name of the application.

required
iconType string

Custom application icon.

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

optional
costControlUserSessionPercentage integer

The percentage of user sessions to be analyzed.

required
apdexSettings MobileCustomApdex required
optInModeEnabled boolean

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

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

optional
sessionReplayEnabled boolean

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

optional
sessionReplayOnCrashEnabled boolean

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

optional
beaconEndpointType string

The type of the beacon endpoint.

required
beaconEndpointUrl string

The URL of the beacon endpoint.

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

optional

The MobileCustomApdex object

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

Element Type Description Required
toleratedThreshold integer

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

required
frustratingThreshold integer

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

required
frustratedOnError boolean

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

required

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

404

Failed. The specified entity doesn't exist.

Response body

A successful request doesn't return any content.

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.

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

Authentication

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.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.