Applications API - GET an application

  • Reference
  • Deprecated

This API is deprecated. Use the Monitored entities API instead.

Gets the parameters of the specified application.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/entity/applications/{meIdentifier}
GETEnvironment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
meIdentifierstring

The Dynatrace entity ID of the required application.

pathRequired

Response

Response codes

CodeTypeDescription
200Application

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The Application object

ElementTypeDescription
applicationMatchTargetstring-
The element can hold these values
  • DOMAIN
  • URL
applicationTypestring-
The element can hold these values
  • AGENTLESS_MONITORING
  • AUTO_INJECTED
  • DEFAULT
  • SAAS_VENDOR
customizedNamestring

The customized name of the entity

discoveredNamestring

The discovered name of the entity

displayNamestring

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

entityIdstring

The Dynatrace entity ID of the required entity.

firstSeenTimestampinteger

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

fromRelationshipsobject

The list of outgoing calls from the application.

lastSeenTimestampinteger

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

managementZonesEntityShortRepresentation[]

The management zones that the entity is part of.

ruleAppliedMatchTypestring-
The element can hold these values
  • ALL_URLS_AND_DOMAINS
  • CONTAINS
  • ENDS
  • EQUALS
  • MATCHES
  • STARTS
ruleAppliedPatternstring-
tagsTagInfo[]

The list of entity tags.

toRelationshipsobject

The list of incoming calls to the application.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
descriptionstring

A short description of the Dynatrace entity.

idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

The TagInfo object

Tag of a Dynatrace entity.

ElementTypeDescription
contextstring

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
keystring

The key of the tag.

Custom tags have the tag value here.

valuestring

The value of the tag.

Not applicable to custom tags.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "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"
    ]
  }
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "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