Search installed app actions in Dynatrace with the AppEngine Registry API using whitespace-separated query terms to find matching actions.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/registry/v1/apps:search-actions |
You pass the query parameter as a whitespace-separated list of search terms. An action matches only when each search term is found according to the search rules. The operation returns 200 OK with matching actions from installed apps.
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 |
|---|---|---|---|---|
| query | string | A whitespace separated list of search terms. For an action to match, each search term must be contained in either: app name, app description, action name, action title or action description. Search terms are case insensitive and each additional search term restricts actions further. Maximum length is 256 characters. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Search | OK |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SearchAppActionList object| Element | Type | Description |
|---|---|---|
| apps | Search | List of apps with actions. Apps are sorted by name in ascending order. |
| totalCount | integer | Total actions count. |
SearchAppAction object| Element | Type | Description |
|---|---|---|
| id | string | App id |
| name | string | App name |
| actions | object[] | Action of an app. |
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": "my.example.appid","name": "Example app","actions": [{"name": "example-action","description": "Description of an example action."}]}],"totalCount": 1}
{"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}}