Try it free

Get an app

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Get an installed app in Dynatrace with the AppEngine Registry API, including the latest version or current version and optional extra fields.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/registry/v1/apps/{id}

Overview

You provide the app id path parameter to identify the app, and add-fields to request extra fields beyond the default set. The latest-app-version query parameter controls whether you receive the latest version or the current version during an update. The operation returns 200 OK with the app details.

Authentication

To execute this request, you need a platform token or OAuth access token with app-engine:apps:run scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The unique identifier for the app

pathRequired
add-fieldsstring

Comma-separated list of field names that are added to the default set of fields.

You can include the following additional fields:

  • resourceContext
  • resourceStatus.subResourceTypes
  • resourceStatus.subResourceStatuses
  • manifest
  • any top-level manifest field to include a part of the manifest, for example, manifest.scopes or manifest.intents
  • isBuiltin
  • isolatedUri
  • deactivationReasons
queryOptional
latest-app-versionboolean

If true, the latest version of the app is returned.

If false, the current version of the app is returned.

During an update, an app typically has two versions: the current version and the latest version with status=PENDING.

queryOptional

Response

Response codes

CodeTypeDescription
200AppInfo

OK

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The AppInfo object

A minimal representation of an app.

ElementTypeDescription
idstring

The id of the app

namestring

The name of the app

versionstring

The version of the app

descriptionstring

The description of the app

manifestobject

The manifest of the app

isBuiltinboolean

Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment.

resourceStatusResourceStatus

The status of the app plus additional details.

appIconAppIcon

Representation of an app icon.

isolatedUriAppIsolatedUri

Representation of an app's isolated uri.

signatureInfoAppSignatureInfo

Representation of an app's signature verification.

modificationInfoModificationInfo

Modification information about the app

deactivationReasonsDeactivationReason[]

Contains the reasons if the app has the status DEACTIVATED

resourceContextResourceContext

Additional resource context information

The ResourceStatus object

The status of the app plus additional details.

ElementTypeDescription
statusStatus

The status of the app.

  • OK: The app is fully installed and running.
  • PENDING: The app is currently being installed, updated or deleted.
  • PENDING_DELETION: A new version of the app was successfully installed and this version is scheduled for deletion.
  • DEACTIVATED: The app is deactivated and cannot be executed.
  • ERROR: The app failed with an error.
The element can hold these values
  • OK
  • PENDING
  • PENDING_DELETION
  • DEACTIVATED
  • ERROR
subResourceTypesSubResourceType[]

The sub resource types that the app contains.

subResourceStatusesSubResourceStatus[]

The statuses of the app's sub resources.

pendingOperationPendingOperation

The pending operation of the app. Only present if the app's status is PENDING.

  • INSTALL: The app is currently being installed.
  • UPDATE: The app is currently being updated.
  • DELETE: The app is currently being deleted.
The element can hold these values
  • INSTALL
  • UPDATE
  • DELETE
operationStateBeforeErrorOperationStateBeforeError

Details about the state when an error occurred. Only present if the app's status is ERROR.

  • PENDING_INSTALL: The error occurred while installing the app.
  • PENDING_UPDATE: The error occurred while updating the app.
  • PENDING_DELETE: The error occurred while deleting the app.
  • OK: At least one sub resource failed while the app was already running.
The element can hold these values
  • PENDING_INSTALL
  • PENDING_UPDATE
  • PENDING_DELETE
  • OK

The Status object

The status of the app.

  • OK: The app is fully installed and running.
  • PENDING: The app is currently being installed, updated or deleted.
  • PENDING_DELETION: A new version of the app was successfully installed and this version is scheduled for deletion.
  • DEACTIVATED: The app is deactivated and cannot be executed.
  • ERROR: The app failed with an error.

The SubResourceType object

The sub resource type.

  • FUNCTIONS: app functions.
  • FILES: static files of an app.
  • SETTINGS_SCHEMAS: settings schemas of an app.
  • DOCUMENTS: documents, e.g. templates, that are part of an app bundle.

The SubResourceStatus object

The status of the sub resource.

ElementTypeDescription
subResourceTypeSubResourceType

The sub resource type.

  • FUNCTIONS: app functions.
  • FILES: static files of an app.
  • SETTINGS_SCHEMAS: settings schemas of an app.
  • DOCUMENTS: documents, e.g. templates, that are part of an app bundle.
The element can hold these values
  • FUNCTIONS
  • FILES
  • SETTINGS_SCHEMAS
  • DOCUMENTS
statusDeploymentStatus

The deployment status of the app's sub resource:

  • SCHEDULED: Only the uploaded app bundle is persisted.
  • DEPLOYING: The app's sub resources are currently being deployed.
  • DEPLOYED: The app's sub resources were successfully deployed.
  • FAILED: The deployment of the app's sub resources failed.
  • NO_RESOURCES: The app bundle does not contain any sub resources of this type
The element can hold these values
  • SCHEDULED
  • DEPLOYING
  • DEPLOYED
  • FAILED
  • NO_RESOURCES
errorSubResourceError

Additional error information that can be present if the sub resource status is FAILED

The DeploymentStatus object

The deployment status of the app's sub resource:

  • SCHEDULED: Only the uploaded app bundle is persisted.
  • DEPLOYING: The app's sub resources are currently being deployed.
  • DEPLOYED: The app's sub resources were successfully deployed.
  • FAILED: The deployment of the app's sub resources failed.
  • NO_RESOURCES: The app bundle does not contain any sub resources of this type

The SubResourceError object

Additional error information that can be present if the sub resource status is FAILED

ElementTypeDescription
messagestring

The error message.

errorCodestring

An error code that can be used determine the nature of an error and why it occurred.

errorRefstring

Optional generated unique value to reference this error.

constraintViolationsSubResourceConstraintViolation[]

A list of constraint violations

The SubResourceConstraintViolation object

Contains information about a constraint violation caused by invalid input.

ElementTypeDescription
pathstring

The path of the property that caused the constraint violation

messagestring

The error message

The PendingOperation object

The pending operation of the app. Only present if the app's status is PENDING.

  • INSTALL: The app is currently being installed.
  • UPDATE: The app is currently being updated.
  • DELETE: The app is currently being deleted.

The OperationStateBeforeError object

Details about the state when an error occurred. Only present if the app's status is ERROR.

  • PENDING_INSTALL: The error occurred while installing the app.
  • PENDING_UPDATE: The error occurred while updating the app.
  • PENDING_DELETE: The error occurred while deleting the app.
  • OK: At least one sub resource failed while the app was already running.

The AppIcon object

Representation of an app icon.

ElementTypeDescription
hrefstring

The reference to an app icon

The AppIsolatedUri object

Representation of an app's isolated uri.

ElementTypeDescription
urlstring

The URL of an app

baseUrlstring

The base URL of an app

widgetUrlstring

The base URL for widgets of an app

The AppSignatureInfo object

Representation of an app's signature verification.

ElementTypeDescription
signedboolean

App is signed and its signature has been verified.

publisherstring

The organization name of the app publisher.

The ModificationInfo object

Modification information about the app

ElementTypeDescription
createdBystring

UserId of the user that created the resource

createdAtstring

Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

lastModifiedBystring

UserId of the user that last modified the resource

lastModifiedAtstring

Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

The DeactivationReason object

Possible reasons why app has deactivated status

The ResourceContext object

Additional resource context information

ElementTypeDescription
operationsstring[]

Operations that are allowed on the app depending on the user's permissions.

  • run: user is allowed to run the app.
  • update: user is allowed to update the app.
  • uninstall: user is allowed to uninstall the app.
The element can hold these values
  • run
  • update
  • uninstall

The ErrorEnvelope object

Error response for all 4xx and 5xx errors.

ElementTypeDescription
errorError

Contains information for 4xx and 5xx errors.

The Error object

Contains information for 4xx and 5xx errors.

ElementTypeDescription
codeinteger

The HTTP status code

messagestring

The error message

detailsErrorDetails

Contains details for 4xx and 5xx errors.

helpstring

Additional information related to the error

retryAfterSecondsinteger

Seconds to wait until the next retry

The ErrorDetails object

Contains details for 4xx and 5xx errors.

ElementTypeDescription
errorRefstring

Generated unique value for 5xx errors.

traceIdstring

OpenTelemetry trace id of the trace where error occurs.

errorCodestring

An optional error code that contains more detailed error information than the HTTP response code alone.

Possible error codes:

  • MaxNumberOfInstalledAppsExceeded: The app bundle couldn't be uploaded because the max number of apps was exceeded. Learn more: https://dt-url.net/upgrade-license
The element can hold these values
  • MaxNumberOfInstalledAppsExceeded
errorCodePropertiesobject

Additional properties related to the provided error code

constraintViolationsConstraintViolation[]

A list of constraint violations

missingScopesstring[]

The OAuth scopes the authorization token would need to carry for this request.

missingPermissionsstring[]

The IAM permissions the authorization token would need to be granted for this request.

The ConstraintViolation object

Contains information about a constraint violation caused by invalid input.

ElementTypeDescription
pathstring

The path of the property that caused the constraint violation

messagestring

The error message

errorCodestring

An optional error code that contains more detailed error information.

Possible error codes:

  • DependencyVersionIncompatible: The app's manifest contains a dependency with an incompatible version.
  • DependencyUnknown: The app's manifest contains a dependency that is unknown.
The element can hold these values
  • DependencyVersionIncompatible
  • DependencyUnknown
errorCodePropertiesobject

Additional properties related to the provided error code.

Response body JSON models

{
  "id": "string",
  "name": "string",
  "version": "string",
  "description": "string",
  "manifest": {},
  "isBuiltin": true,
  "resourceStatus": {
    "status": "OK",
    "subResourceTypes": [
      "FUNCTIONS"
    ],
    "subResourceStatuses": [
      {
        "subResourceType": "FUNCTIONS",
        "status": "SCHEDULED",
        "error": {
          "message": "string",
          "errorCode": "string",
          "errorRef": "string",
          "constraintViolations": [
            {
              "path": "string",
              "message": "string"
            }
          ]
        }
      }
    ],
    "pendingOperation": "INSTALL",
    "operationStateBeforeError": "PENDING_INSTALL"
  },
  "appIcon": {
    "href": "string"
  },
  "isolatedUri": {
    "url": "string",
    "baseUrl": "string",
    "widgetUrl": "string"
  },
  "signatureInfo": {
    "signed": true,
    "publisher": "string"
  },
  "modificationInfo": {
    "createdBy": "string",
    "createdAt": "string",
    "lastModifiedBy": "string",
    "lastModifiedAt": "string"
  },
  "deactivationReasons": [
    "CapabilityAppEngineFunctionsSmallDisabled"
  ],
  "resourceContext": {
    "operations": [
      "run"
    ]
  }
}
{
  "error": {
    "code": 1,
    "message": "string",
    "details": {
      "errorRef": "string",
      "traceId": "string",
      "errorCode": "MaxNumberOfInstalledAppsExceeded",
      "errorCodeProperties": {
        "appLimit": "3"
      },
      "constraintViolations": [
        {
          "path": "string",
          "message": "string",
          "errorCode": "DependencyVersionIncompatible",
          "errorCodeProperties": {
            "dependency": "/platform/storage/query/v1",
            "availableVersion": "1.2.0",
            "incompatibleVersion": "1.1.0"
          }
        }
      ],
      "missingScopes": [
        "string"
      ],
      "missingPermissions": [
        "string"
      ]
    },
    "help": "string",
    "retryAfterSeconds": 1
  }
}
Related tags
Platform APIDynatrace Platform