• Home
  • API
  • Configuration
  • RUM
  • Mobile and custom app
  • Apps
  • POST an app

Mobile and custom app API - POST an app

Creates a new mobile or custom app.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/applications/mobile
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
bodyNewMobileCustomAppConfig

The JSON body of the request. Contains the parameters of the new mobile or custom application.

bodyoptional

Request body objects

The NewMobileCustomAppConfig object

Configuration of a mobile or custom application to be created.

ElementTypeDescriptionRequired
apdexSettingsMobileCustomApdex

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

optional
applicationIdstring

The UUID of the application.

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

optional
applicationTypestring

The type of the application.

The element can hold these values
  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION
required
beaconEndpointTypestring

The type of the beacon endpoint.

The element can hold these values
  • CLUSTER_ACTIVE_GATE
  • ENVIRONMENT_ACTIVE_GATE
  • INSTRUMENTED_WEB_SERVER
optional
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.

optional
iconTypestring

Custom application icon.

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

The element can hold these values
  • AMAZON_ECHO
  • DESKTOP
  • EMBEDDED
  • IOT
  • MICROSOFT_HOLOLENS
  • UFO
  • USERS
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.

json
{
  "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

CodeTypeDescription
201EntityShortRepresentation

Success. The application has been created. The response contains the identifier and name of the new application.

400ErrorEnvelope

Failed. The input is invalid.

409ErrorEnvelope

Failed. The applicationId is already used by another application.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Response body JSON model

json
{
  "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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/applications/mobile/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile/validator
Environment ActiveGatehttps://{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

CodeTypeDescription
204

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

400ErrorEnvelope

Failed. The input is invalid.