Applications API - GET an application

This API is deprecated. Use the Monitored entities API instead. You can find more information about switching to the new API in the migration guide.

Gets the parameters of the specified application.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/applications/{meIdentifier}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}

Authentication

To execute this request, you need an access token with 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

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The Application object

Element
Type
Description
applicationMatchTarget
string
-
  • DOMAIN
  • URL
applicationType
string
-
  • AGENTLESS_MONITORING
  • AMP
  • AUTO_INJECTED
  • DEFAULT
  • SAAS_VENDOR
customizedName
string

The customized name of the entity

discoveredName
string

The discovered name of the entity

displayName
string

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

entityId
string

The Dynatrace entity ID of the required entity.

firstSeenTimestamp
integer

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

fromRelationships
object

The list of outgoing calls from the application.

lastSeenTimestamp
integer

The timestamp of when the entity was last detected, in UTC milliseconds

managementZones

The management zones that the entity is part of.

ruleAppliedMatchType
string
-
  • ALL_URLS_AND_DOMAINS
  • CONTAINS
  • ENDS
  • EQUALS
  • MATCHES
  • STARTS
ruleAppliedPattern
string
-
tags

The list of entity tags.

toRelationships
object

The list of incoming calls to the application.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

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

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
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.

Response body JSON model

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

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

Related topics