Applications API - GET an application

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}

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 format

Response parameters JSON model

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.
ruleAppliedMatchType	string	The ruleAppliedMatchType element can hold these values.
ruleAppliedPattern	string
applicationType	string	The applicationType element can hold these values.
applicationMatchTarget	string	The applicationMatchTarget element can hold these values.
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.

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

Element	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The context element can hold these values.
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.

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

Custom tags use the CONTEXTLESS value.

The context element can hold these values.

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.

    
{
  "entityId": "string",
  "displayName": "string",
  "customizedName": "string",
  "discoveredName": "string",
  "firstSeenTimestamp": 0,
  "lastSeenTimestamp": 0,
  "tags": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ],
  "fromRelationships": "object",
  "toRelationships": "object",
  "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS",
  "ruleAppliedPattern": "string",
  "applicationType": "AGENTLESS_MONITORING",
  "applicationMatchTarget": "DOMAIN",
  "managementZones": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity",
      "description": "Dynatrace entity for the REST API example\n"
    }
  ]
}

Possible values

Possible values for the applicationMatchTarget element in the Application object:

DOMAIN
URL

Possible values for the applicationType element in the Application object:

AGENTLESS_MONITORING
AMP
AUTO_INJECTED
DEFAULT
SAAS_VENDOR

Possible values for the ruleAppliedMatchType element in the Application object:

ALL_URLS_AND_DOMAINS
CONTAINS
ENDS
EQUALS
MATCHES
STARTS

Possible values for the context element in the TagInfo object:

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

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