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

Response

Response codes

Code	Type	Description
200	Application	Success

Response body objects

The `Application` object

Element	Type	Description	Required
entityId	string	The Dynatrace entity ID of the required entity.	optional
displayName	string	The name of the Dynatrace entity as displayed in the UI.	optional
customizedName	string	The customized name of the entity	optional
discoveredName	string	The discovered name of the entity	optional
firstSeenTimestamp	integer	The timestamp of when the entity was first detected, in UTC milliseconds	optional
lastSeenTimestamp	integer	The timestamp of when the entity was last detected, in UTC milliseconds	optional
tags	TagInfo[]	The list of entity tags.	optional
fromRelationships	object	The list of outgoing calls from the application.	optional
toRelationships	object	The list of incoming calls to the application.	optional
managementZones	EntityShortRepresentation[]	The management zones that the entity is part of.	optional
applicationType	string	- The element can hold these values `AGENTLESS_MONITORING` `AMP` `AUTO_INJECTED` `DEFAULT` `SAAS_VENDOR`	optional
ruleAppliedPattern	string	-	optional
applicationMatchTarget	string	- The element can hold these values `DOMAIN` `URL`	optional
ruleAppliedMatchType	string	- The element can hold these values `ALL_URLS_AND_DOMAINS` `CONTAINS` `ENDS` `EQUALS` `MATCHES` `STARTS`	optional

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description Required

context

string

Element	Type	Description	Required
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`	required
key	string	The key of the tag. Custom tags have the tag value here.	required
value	string	The value of the tag. Not applicable to custom tags.	optional

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

Custom tags use the CONTEXTLESS value.

The element can hold these values

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

required

key

string

The key of the tag.

Custom tags have the tag value here.

required

value

string

The value of the tag.

Not applicable to custom tags.

optional

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
id	string	The ID of the Dynatrace entity.	required
name	string	The name of the Dynatrace entity.	optional
description	string	A short description of the Dynatrace entity.	optional

Response body JSON model

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

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

bash
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

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

Response body

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

Applications API - GET an application

Authentication

Parameters

Response

Response codes

Response body objects

The Application object

The TagInfo object

The EntityShortRepresentation object

Response body JSON model

Example

Curl

Request URL

Response body

Response code

The `Application` object

The `TagInfo` object

The `EntityShortRepresentation` object