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}

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 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.

The applicationType element can hold these values.
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`.

The iconType element can hold these values.
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.

The beaconEndpointType element can hold these values.
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

Possible values

Possible values for the beaconEndpointType element in the MobileCustomAppConfig object:

  • CLUSTER_ACTIVE_GATE
  • ENVIRONMENT_ACTIVE_GATE
  • INSTRUMENTED_WEB_SERVER

Possible values for the iconType element in the MobileCustomAppConfig object:

  • AMAZON_ECHO
  • DESKTOP
  • EMBEDDED
  • IOT
  • MICROSOFT_HOLOLENS
  • UFO
  • USERS

Possible values for the applicationType element in the MobileCustomAppConfig object:

  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION

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

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.