Applications API - GET an application

We have a new version of this API—Entity API v2. Check it out!

Gets the parameters of the specified application.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/entity/applications/{meIdentifier}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}

Authentication

To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
meIdentifier string

The Dynatrace entity ID of the required application.

 path required

Response

Response codes

Code Description
200

Success

Response body

The Application object

Element Type Description
entityId string

The Dynatrace entity ID of the required entity.
displayName string

The name of the Dynatrace entity as displayed in the UI.
customizedName string

The customized name of the entity
discoveredName string

The discovered name of the entity
firstSeenTimestamp integer

The timestamp of when the entity was first detected, in UTC milliseconds
lastSeenTimestamp integer

The timestamp of when the entity was last detected, in UTC milliseconds
tags TagInfo[]

The list of entity tags.
fromRelationships object

The list of outgoing calls from the application.
toRelationships object

The list of incoming calls to the application.
managementZones EntityShortRepresentation[]

The management zones that the entity is part of.
applicationType string
ruleAppliedPattern string
applicationMatchTarget string
ruleAppliedMatchType string

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.

The TagInfo object

Tag of a Dynatrace entity.

Element Type Description
context string

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.
key string

The key of the tag.

Custom tags have the tag value here.
value string

The value of the tag.

Not applicable to custom tags.

Example

In this example, the request inquires about the properties of the easyTravel Demo application, which has the ID MOBILE_APPLICATION-752C288D59734C79.

The API token is passed in the Authorization header.

Curl

curl --request GET \
  --url https://mySampleEnv.live.dynatrace.com/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79 \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79

Response body

{
  "entityId": "MOBILE_APPLICATION-752C288D59734C79",
  "displayName": "easyTravel Demo",
  "customizedName": "easyTravel Demo",
  "discoveredName": "752c288d-5973-4c79-b7d1-3a49d4d42ea0",
  "firstSeenTimestamp": 1469613941393,
  "lastSeenTimestamp": 1538656560201,
  "tags": [
    {
      "context": "CONTEXTLESS",
      "key": "portal"
    },
    {
      "context": "CONTEXTLESS",
      "key": "easyTravel"
    }
  ],
  "fromRelationships": {
    "calls": [
      "SERVICE-ED0B103392AC86BF"
    ]
  },
  "toRelationships": {},
  "mobileOsFamily": [
    "ANDROID",
    "IOS",
    "WINDOWS"
  ],
  "managementZones": [
    {
      "id": "-6239538939987181652",
      "name": "allTypes"
    },
    {
      "id": "6518151499932123858",
      "name": "mobile app name exists"
    },
    {
      "id": "-4085081632192243904",
      "name": "easyTravel"
    }
  ]
}

Response code

200