Mobile and custom app API - POST an app
Creates a new mobile or custom app.
The request consumes and produces an application/json
payload.
POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/mobile |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/mobile |
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 |
---|---|---|---|---|
body | New | The JSON body of the request. Contains the parameters of the new mobile or custom application. | body | optional |
Request body objects
The NewMobileCustomAppConfig
object
Configuration of a mobile or custom application to be created.
Element | Type | Description | Required |
---|---|---|---|
apdexSettings | Mobile | Apdex configuration of a mobile or custom application. A duration less than the tolerable threshold is considered satisfied. | optional |
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. | required |
beaconEndpointType | string | The type of the beacon endpoint. | optional |
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. | optional |
iconType | string | Custom application icon. Mobile apps always use the mobile device icon, so this icon can only be set for custom apps. | 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.
{
"apdexSettings": {
"frustratedOnError": true,
"frustratingThreshold": 1,
"toleratedThreshold": 1
},
"applicationId": "string",
"applicationType": "CUSTOM_APPLICATION",
"beaconEndpointType": "CLUSTER_ACTIVE_GATE",
"beaconEndpointUrl": "string",
"costControlUserSessionPercentage": 1,
"iconType": "AMAZON_ECHO",
"name": "string",
"optInModeEnabled": true,
"sessionReplayEnabled": true,
"sessionReplayOnCrashEnabled": true
}
Response
Response codes
Code | Type | Description |
---|---|---|
201 | Entity | Success. The application has been created. The response contains the identifier and name of the new application. |
400 | ErrorEnvelope | Failed. The input is invalid. |
409 | ErrorEnvelope | Failed. The applicationId is already used by another application. |
Response body objects
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
description | string | A short description of the Dynatrace entity. |
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. |
Response body JSON model
{
"description": "Dynatrace entity for the REST API example",
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity"
}
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/validator |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile/validator | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/mobile/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. |