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 | ManagedDynatrace for Government | 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}: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
| 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 |
Request body objects
The MobileCustomAppConfig object
Configuration of an existing mobile or custom application.
| Element | Type | Description | Required |
|---|---|---|---|
| apdexSettings | MobileCustomApdex | Apdex configuration of a mobile or custom application. A duration less than the tolerable threshold is considered satisfied. | required |
| applicationId | string | The UUID of the application. It is used only by OneAgent to send data to Dynatrace. | optional |
| applicationType | string | The type of the application.
| 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 | optional |
| costControlUserSessionPercentage | integer | The percentage of user sessions to be analyzed. | 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 |
| identifier | string | The Dynatrace entity ID of the application. | optional |
| name | string | The name of the application. | required |
| optInModeEnabled | boolean | The opt-in mode is enabled ( This value is only applicable to mobile and not to custom apps. | optional |
| sessionReplayEnabled | boolean | The session replay is enabled ( | optional |
| sessionReplayOnCrashEnabled | boolean | Deprecated. Please use | 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 |
|---|---|---|---|
| frustratedOnError | boolean | Apdex error condition: if | required |
| frustratingThreshold | integer | Apdex frustrated threshold, in milliseconds: a duration greater than or equal to this value is considered frustrated. | required |
| toleratedThreshold | integer | 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.
1{2 "apdexSettings": {3 "frustratedOnError": true,4 "frustratingThreshold": 1,5 "toleratedThreshold": 16 },7 "applicationId": "string",8 "applicationType": "CUSTOM_APPLICATION",9 "beaconEndpointType": "CLUSTER_ACTIVE_GATE",10 "beaconEndpointUrl": "string",11 "costControlUserSessionPercentage": 1,12 "iconType": "AMAZON_ECHO",13 "identifier": "string",14 "name": "string",15 "optInModeEnabled": true,16 "sessionReplayEnabled": true,17 "sessionReplayOnCrashEnabled": true18}
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The application has been updated. Response doesn't have a body. |
| 400 | ErrorEnvelope | 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.
| POST | ManagedDynatrace for Government | 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}: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
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The submitted configuration is valid. Response doesn't have a body. |
| 400 | ErrorEnvelope | Failed. The input is invalid. |