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
  • Managed 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

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
body MobileCustomAppConfig

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

body optional

Body format

The MobileCustomAppConfig object

Configuration of a mobile or custom application.

Element Type Description Required
identifier string

The Dynatrace entity ID of the application.

optional
name string

The name of the application.

required
applicationType string

The type of the application.

optional
applicationId string

The UUID of the application.

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

optional
iconType string

The icon of the custom application.

Mobile applications always use the mobile phone icon`.

optional
costControlUserSessionPercentage integer

The percentage of user sessions to be analyzed.

optional
apdexSettings MobileCustomApdex optional
optInModeEnabled boolean

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

optional
sessionReplayOnCrashEnabled boolean

The session replay on crash is enabled (true) or disabled (false).

optional
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 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
201

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

400

Failed. The input is invalid.

409

Failed. The applicationId is already used by another application.

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the 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
  • Managed 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

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.