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 an access token with Access problem and event feed, metrics, and topology (DataExport) scope. 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 | Type | Description |
|---|---|---|
| 200 | Application | Success |
Response body objects
The Application object
| Element | Type | Description |
|---|---|---|
| entityId | string | The Dynatrace entity ID of the required entity. Can be |
| displayName | string | The name of the Dynatrace entity as displayed in the UI. Can be |
| customizedName | string | The customized name of the entity Can be |
| discoveredName | string | The discovered name of the entity Can be |
| firstSeenTimestamp | integer | The timestamp of when the entity was first detected, in UTC milliseconds Can be |
| lastSeenTimestamp | integer | The timestamp of when the entity was last detected, in UTC milliseconds Can be |
| tags | Tag | The list of entity tags. Can be |
| fromRelationships | object | The list of outgoing calls from the application. Can be |
| toRelationships | object | The list of incoming calls to the application. Can be |
| ruleAppliedPattern | string | - Can be |
| managementZones | Entity | The management zones that the entity is part of. Can be |
| ruleAppliedMatchType | string | - Can be |
| applicationMatchTarget | string | - Can be |
| applicationType | string | - Can be |
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 |
| 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. Can be |
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. Can be |
| description | string | A short description of the Dynatrace entity. Can be |
Response body JSON model
{
"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"
]
},
"ruleAppliedPattern": "string",
"managementZones": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}
],
"ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS",
"applicationMatchTarget": "DOMAIN",
"applicationType": "AGENTLESS_MONITORING"
}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-752C288D59734C79Response 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