List installed apps in Dynatrace with the AppEngine Registry API, including deactivated, non-runnable, and all app versions when requested.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/registry/v1/apps |
You can use add-fields to include extra fields beyond the default set, and filter to narrow the results. The include-deactivated, include-non-runnable, and include-all-app-versions query parameters control which apps and versions appear in the response. The operation returns 200 OK with the installed apps list.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| add-fields | string | Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields:
| query | Optional |
| include-deactivated | boolean | If | query | Optional |
| include-non-runnable | boolean | If | query | Optional |
| include-all-app-versions | boolean | If If During an update, an app typically has two versions: the current version and the latest version
with | query | Optional |
| filter | string | The filter parameter, as explained here. Filtering is supported on the following fields:
If this parameter is omitted, all apps will be returned. The maximum nesting depth (via parentheses) is 3. The maximum expression length is 256 characters. Fields that are used for filtering are always included in the response, even if they are not in the default set of fields. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | App | OK |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
AppInfoList objectA list of minimal app representations.
| Element | Type | Description |
|---|---|---|
| apps | App | The list of minimal app representations. |
AppInfo objectA minimal representation of an app.
| Element | Type | Description |
|---|---|---|
| id | string | The id of the app |
| name | string | The name of the app |
| version | string | The version of the app |
| description | string | The description of the app |
| manifest | object | The manifest of the app |
| isBuiltin | boolean | Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment. |
| resourceStatus | Resource | The status of the app plus additional details. |
| appIcon | App | Representation of an app icon. |
| isolatedUri | App | Representation of an app's isolated uri. |
| signatureInfo | App | Representation of an app's signature verification. |
| modificationInfo | Modification | Modification information about the app |
| deactivationReasons | Deactivation | Contains the reasons if the app has the status |
| resourceContext | Resource | Additional resource context information |
ResourceStatus objectThe status of the app plus additional details.
| Element | Type | Description |
|---|---|---|
| status | Status | The status of the app.
The element can hold these values
|
| subResourceTypes | Sub | The sub resource types that the app contains. |
| subResourceStatuses | Sub | The statuses of the app's sub resources. |
| pendingOperation | Pending | The pending operation of the app. Only present if the app's
The element can hold these values
|
| operationStateBeforeError | Operation | Details about the state when an error occurred. Only present if the app's
The element can hold these values
|
Status objectThe 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.SubResourceType objectThe 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.SubResourceStatus objectThe status of the sub resource.
| Element | Type | Description |
|---|---|---|
| subResourceType | Sub | The sub resource type.
The element can hold these values
|
| status | Deployment | The deployment status of the app's sub resource:
The element can hold these values
|
| error | Sub | Additional error information that can be present if the sub resource |
DeploymentStatus objectThe 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 typeSubResourceError objectAdditional error information that can be present if the sub resource status is FAILED
| Element | Type | Description |
|---|---|---|
| message | string | The error message. |
| errorCode | string | An error code that can be used determine the nature of an error and why it occurred. |
| errorRef | string | Optional generated unique value to reference this error. |
| constraintViolations | Sub | A list of constraint violations |
SubResourceConstraintViolation objectContains information about a constraint violation caused by invalid input.
| Element | Type | Description |
|---|---|---|
| path | string | The path of the property that caused the constraint violation |
| message | string | The error message |
PendingOperation objectThe 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.OperationStateBeforeError objectDetails 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.AppIcon objectRepresentation of an app icon.
| Element | Type | Description |
|---|---|---|
| href | string | The reference to an app icon |
AppIsolatedUri objectRepresentation of an app's isolated uri.
| Element | Type | Description |
|---|---|---|
| url | string | The URL of an app |
| baseUrl | string | The base URL of an app |
| widgetUrl | string | The base URL for widgets of an app |
AppSignatureInfo objectRepresentation of an app's signature verification.
| Element | Type | Description |
|---|---|---|
| signed | boolean | App is signed and its signature has been verified. |
| publisher | string | The organization name of the app publisher. |
ModificationInfo objectModification information about the app
| Element | Type | Description |
|---|---|---|
| createdBy | string | UserId of the user that created the resource |
| createdAt | string | Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedBy | string | UserId of the user that last modified the resource |
| lastModifiedAt | string | Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
DeactivationReason objectPossible reasons why app has deactivated status
ResourceContext objectAdditional resource context information
| Element | Type | Description |
|---|---|---|
| operations | string[] | Operations that are allowed on the app depending on the user's permissions.
The element can hold these values
|
ErrorEnvelope objectError response for all 4xx and 5xx errors.
| Element | Type | Description |
|---|---|---|
| error | Error | Contains information for 4xx and 5xx errors. |
Error objectContains information for 4xx and 5xx errors.
| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| message | string | The error message |
| details | Error | Contains details for 4xx and 5xx errors. |
| help | string | Additional information related to the error |
| retryAfterSeconds | integer | Seconds to wait until the next retry |
ErrorDetails objectContains details for 4xx and 5xx errors.
| Element | Type | Description |
|---|---|---|
| errorRef | string | Generated unique value for 5xx errors. |
| traceId | string | OpenTelemetry trace id of the trace where error occurs. |
| errorCode | string | An optional error code that contains more detailed error information than the HTTP response code alone. Possible error codes:
The element can hold these values
|
| errorCodeProperties | object | Additional properties related to the provided error code |
| constraintViolations | Constraint | A list of constraint violations |
| missingScopes | string[] | The OAuth scopes the authorization token would need to carry for this request. |
| missingPermissions | string[] | The IAM permissions the authorization token would need to be granted for this request. |
ConstraintViolation objectContains information about a constraint violation caused by invalid input.
| Element | Type | Description |
|---|---|---|
| path | string | The path of the property that caused the constraint violation |
| message | string | The error message |
| errorCode | string | An optional error code that contains more detailed error information. Possible error codes:
The element can hold these values
|
| errorCodeProperties | object | Additional properties related to the provided error code. |
{"apps": [{"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}}