@dynatrace-sdk/client-classic-environment-v2 4.2.1 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +1271 -355
- package/cjs/index.js +384 -20
- package/esm/index.js +384 -20
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +23 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/rum-manual-insertion-tags-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +7 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +6 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/authentication-dto-input-type.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/authentication-dto-type.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/authentication-dto.d.ts +24 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/base-wait-condition-dto-type.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/base-wait-condition-dto.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/browser-permissions-dto.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/chromium-startup-flags-dto-autoplay-policy.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/chromium-startup-flags-dto-disable-features.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/chromium-startup-flags-dto.d.ts +42 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/client-certificate-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cookie-step-dto.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-list.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/enriched-management-zone-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/enriched-tag-dto.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-event-type.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/filtered-requests-dto-mode.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filtered-requests-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/framework-options-dto.d.ts +37 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/history-modification-info.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ignored-error-codes-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +59 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/interaction-step-dto.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/java-script-agent-settings-dto.d.ts +44 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/java-script-step-dto.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics-load-action-kpm.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics-xhr-action-kpm.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/key-strokes-step-dto.d.ts +34 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/keystrokes-input-dto-type.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/keystrokes-input-dto.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/locator-dto-type.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/locator-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-property-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/navigate-step-dto.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-throttling-dto.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/plain-authentication-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/plain-keystrokes-input-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-fips-mode.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/proxy-dto.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-filter-dto-type.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-filter-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-header-options-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/secure-authentication-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/secure-keystrokes-input-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/select-option-step-dto.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/selection-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-configuration-dto.d.ts +85 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-request-type.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-request.d.ts +65 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-response-type.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-response.d.ts +77 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-step-dto-type.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-step-dto.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-cookie-dto.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-request-type.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-request.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-response-type.d.ts +1 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-response.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/target-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/test-device-dto.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/time-wait-condition-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/timeout-settings-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/validation-rule-dto-type.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/validation-rule-dto.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/validation-wait-condition-dto.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/visually-complete-options-dto.d.ts +25 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/5.1.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -2466,6 +2466,65 @@ const data =
|
|
|
2466
2466
|
|
|
2467
2467
|
|
|
2468
2468
|
|
|
2469
|
+
</div>
|
|
2470
|
+
|
|
2471
|
+
|
|
2472
|
+
<a name="getcredentialsdetailslist"></a>
|
|
2473
|
+
### getCredentialsDetailsList
|
|
2474
|
+
|
|
2475
|
+
<div class="padding-bottom--md">
|
|
2476
|
+
<strong>credentialVaultClient.getCredentialsDetailsList(config): Promise<<a href="#credentialsdetailslist">CredentialsDetailsList</a>></strong>
|
|
2477
|
+
|
|
2478
|
+
<div class="padding-left--md">
|
|
2479
|
+
|
|
2480
|
+
Gets the details of the specified credentials sets.
|
|
2481
|
+
|
|
2482
|
+
The credentials set including username/certificate, password or token is included in the response.
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
</div>
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
#### Parameters
|
|
2490
|
+
|
|
2491
|
+
| Name | Type | Description |
|
|
2492
|
+
| --- | --- | --- |
|
|
2493
|
+
|config.ids|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The list of Dynatrace entity IDs of the required credentials sets (separated by commas). |
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
#### Returns
|
|
2499
|
+
|
|
2500
|
+
| Return type | Status code | Description |
|
|
2501
|
+
|---|---|---|
|
|
2502
|
+
|[CredentialsDetailsList](#credentialsdetailslist)|200|Success. The response contains the details of the credentials sets.|
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
#### Throws
|
|
2506
|
+
|
|
2507
|
+
| Error Type | Error Message |
|
|
2508
|
+
|---|---|
|
|
2509
|
+
|ErrorEnvelopeError|Failed. The input is invalid. E.g. Requested credentials with unsupported scope. Only SYNTHETIC and APP_ENGINE scope are supported. | Failed. Requested credentials belong to another user. | Client side error. | Server side error.|
|
|
2510
|
+
|
|
2511
|
+
|
|
2512
|
+
<details>
|
|
2513
|
+
<summary>
|
|
2514
|
+
Code example
|
|
2515
|
+
</summary>
|
|
2516
|
+
|
|
2517
|
+
```ts
|
|
2518
|
+
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2519
|
+
|
|
2520
|
+
const data =
|
|
2521
|
+
await credentialVaultClient.getCredentialsDetailsList();
|
|
2522
|
+
```
|
|
2523
|
+
|
|
2524
|
+
</details>
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2469
2528
|
</div>
|
|
2470
2529
|
|
|
2471
2530
|
|
|
@@ -2473,7 +2532,7 @@ const data =
|
|
|
2473
2532
|
### listCredentials
|
|
2474
2533
|
|
|
2475
2534
|
<div class="padding-bottom--md">
|
|
2476
|
-
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist">CredentialsList</a>></strong>
|
|
2535
|
+
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist" target="_blank" rel="noopener noreferrer">CredentialsList</a>></strong>
|
|
2477
2536
|
|
|
2478
2537
|
<div class="padding-left--md">
|
|
2479
2538
|
|
|
@@ -2602,7 +2661,7 @@ const data = await credentialVaultClient.removeCredentials({
|
|
|
2602
2661
|
### updateCredentials
|
|
2603
2662
|
|
|
2604
2663
|
<div class="padding-bottom--md">
|
|
2605
|
-
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid"
|
|
2664
|
+
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid">CredentialsId</a>></strong>
|
|
2606
2665
|
|
|
2607
2666
|
<div class="padding-left--md">
|
|
2608
2667
|
|
|
@@ -2622,7 +2681,7 @@ The body must not provide an ID. The ID should be provided in the path.
|
|
|
2622
2681
|
|
|
2623
2682
|
| Name | Type | Description |
|
|
2624
2683
|
| --- | --- | --- |
|
|
2625
|
-
|config.body<sup>*required</sup>|<a href="#credentials">Credentials</a>| |
|
|
2684
|
+
|config.body<sup>*required</sup>|<a href="#credentials" target="_blank" rel="noopener noreferrer">Credentials</a>| |
|
|
2626
2685
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the credentials set to be updated. |
|
|
2627
2686
|
|
|
2628
2687
|
|
|
@@ -2678,7 +2737,7 @@ import { davisSecurityAdvisorClient } from '@dynatrace-sdk/client-classic-enviro
|
|
|
2678
2737
|
### getAdviceForSecurityProblems
|
|
2679
2738
|
|
|
2680
2739
|
<div class="padding-bottom--md">
|
|
2681
|
-
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist"
|
|
2740
|
+
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist">DavisSecurityAdviceList</a>></strong>
|
|
2682
2741
|
|
|
2683
2742
|
<div class="padding-left--md">
|
|
2684
2743
|
|
|
@@ -2752,7 +2811,7 @@ import { eventsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
2752
2811
|
### createEvent
|
|
2753
2812
|
|
|
2754
2813
|
<div class="padding-bottom--md">
|
|
2755
|
-
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults">EventIngestResults</a>></strong>
|
|
2814
|
+
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults" target="_blank" rel="noopener noreferrer">EventIngestResults</a>></strong>
|
|
2756
2815
|
|
|
2757
2816
|
<div class="padding-left--md">
|
|
2758
2817
|
|
|
@@ -2780,7 +2839,7 @@ The ingestion of custom events is subject to licensing (see [licensing documenta
|
|
|
2780
2839
|
|
|
2781
2840
|
| Name | Type |
|
|
2782
2841
|
| --- | --- |
|
|
2783
|
-
|config.body<sup>*required</sup>|<a href="#eventingest"
|
|
2842
|
+
|config.body<sup>*required</sup>|<a href="#eventingest">EventIngest</a>|
|
|
2784
2843
|
|
|
2785
2844
|
|
|
2786
2845
|
|
|
@@ -2823,7 +2882,7 @@ const data = await eventsClient.createEvent({
|
|
|
2823
2882
|
### getEvent
|
|
2824
2883
|
|
|
2825
2884
|
<div class="padding-bottom--md">
|
|
2826
|
-
<strong>eventsClient.getEvent(config): Promise<<a href="#event">Event</a>></strong>
|
|
2885
|
+
<strong>eventsClient.getEvent(config): Promise<<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>></strong>
|
|
2827
2886
|
|
|
2828
2887
|
<div class="padding-left--md">
|
|
2829
2888
|
|
|
@@ -2884,7 +2943,7 @@ const data = await eventsClient.getEvent({
|
|
|
2884
2943
|
### getEventProperties
|
|
2885
2944
|
|
|
2886
2945
|
<div class="padding-bottom--md">
|
|
2887
|
-
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist"
|
|
2946
|
+
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist">EventPropertiesList</a>></strong>
|
|
2888
2947
|
|
|
2889
2948
|
<div class="padding-left--md">
|
|
2890
2949
|
|
|
@@ -2944,7 +3003,7 @@ const data = await eventsClient.getEventProperties();
|
|
|
2944
3003
|
### getEventProperty
|
|
2945
3004
|
|
|
2946
3005
|
<div class="padding-bottom--md">
|
|
2947
|
-
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails">EventPropertyDetails</a>></strong>
|
|
3006
|
+
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>></strong>
|
|
2948
3007
|
|
|
2949
3008
|
<div class="padding-left--md">
|
|
2950
3009
|
|
|
@@ -3005,7 +3064,7 @@ const data = await eventsClient.getEventProperty({
|
|
|
3005
3064
|
### getEventType
|
|
3006
3065
|
|
|
3007
3066
|
<div class="padding-bottom--md">
|
|
3008
|
-
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype"
|
|
3067
|
+
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype">EventType</a>></strong>
|
|
3009
3068
|
|
|
3010
3069
|
<div class="padding-left--md">
|
|
3011
3070
|
|
|
@@ -3066,7 +3125,7 @@ const data = await eventsClient.getEventType({
|
|
|
3066
3125
|
### getEventTypes
|
|
3067
3126
|
|
|
3068
3127
|
<div class="padding-bottom--md">
|
|
3069
|
-
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist">EventTypeList</a>></strong>
|
|
3128
|
+
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist" target="_blank" rel="noopener noreferrer">EventTypeList</a>></strong>
|
|
3070
3129
|
|
|
3071
3130
|
<div class="padding-left--md">
|
|
3072
3131
|
|
|
@@ -3126,7 +3185,7 @@ const data = await eventsClient.getEventTypes();
|
|
|
3126
3185
|
### getEvents
|
|
3127
3186
|
|
|
3128
3187
|
<div class="padding-bottom--md">
|
|
3129
|
-
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist"
|
|
3188
|
+
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist">EventList</a>></strong>
|
|
3130
3189
|
|
|
3131
3190
|
<div class="padding-left--md">
|
|
3132
3191
|
|
|
@@ -3144,7 +3203,7 @@ Lists events within the specified timeframe
|
|
|
3144
3203
|
|
|
3145
3204
|
| Name | Type | Description |
|
|
3146
3205
|
| --- | --- | --- |
|
|
3147
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
3206
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The number of entities that can be selected is limited to 10000.</p> |
|
|
3148
3207
|
|config.eventSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only events matching the specified criteria are included in the response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Event ID: <code>eventId("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w" target="_blank" rel="noopener noreferrer" >GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code>. Only properties with the <strong>filterable</strong> property set to <code>true</code> can be used. You can check event properties via the <a href="https://dt-url.net/es03nwo" target="_blank" rel="noopener noreferrer" >GET event properties</a> call.</li> </ul> <p>To set several criteria, separate them with commas (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
3149
3208
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
3150
3209
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
@@ -3196,7 +3255,7 @@ import { extensions_2_0Client } from '@dynatrace-sdk/client-classic-environment-
|
|
|
3196
3255
|
### activateExtensionEnvironmentConfiguration
|
|
3197
3256
|
|
|
3198
3257
|
<div class="padding-bottom--md">
|
|
3199
|
-
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3258
|
+
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3200
3259
|
|
|
3201
3260
|
<div class="padding-left--md">
|
|
3202
3261
|
|
|
@@ -3216,7 +3275,7 @@ Activates the environment configuration from the specified version of the extens
|
|
|
3216
3275
|
|
|
3217
3276
|
| Name | Type | Description |
|
|
3218
3277
|
| --- | --- | --- |
|
|
3219
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion"
|
|
3278
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
3220
3279
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3221
3280
|
|
|
3222
3281
|
|
|
@@ -3261,7 +3320,7 @@ const data =
|
|
|
3261
3320
|
### createMonitoringConfiguration
|
|
3262
3321
|
|
|
3263
3322
|
<div class="padding-bottom--md">
|
|
3264
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
3323
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse" target="_blank" rel="noopener noreferrer">MonitoringConfigurationResponse</a>>></strong>
|
|
3265
3324
|
|
|
3266
3325
|
<div class="padding-left--md">
|
|
3267
3326
|
|
|
@@ -3281,7 +3340,7 @@ Creates new monitoring configuration for the specified extension 2.0
|
|
|
3281
3340
|
|
|
3282
3341
|
| Name | Type | Description |
|
|
3283
3342
|
| --- | --- | --- |
|
|
3284
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto"
|
|
3343
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
3285
3344
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3286
3345
|
|
|
3287
3346
|
|
|
@@ -3325,7 +3384,7 @@ const data =
|
|
|
3325
3384
|
</div>
|
|
3326
3385
|
|
|
3327
3386
|
<div class="padding-bottom--md">
|
|
3328
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse"
|
|
3387
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope" target="_blank" rel="noopener noreferrer">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
3329
3388
|
|
|
3330
3389
|
<div class="padding-left--md">
|
|
3331
3390
|
|
|
@@ -3340,7 +3399,7 @@ const data =
|
|
|
3340
3399
|
|
|
3341
3400
|
| Name | Type | Description |
|
|
3342
3401
|
| --- | --- | --- |
|
|
3343
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
3402
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto" target="_blank" rel="noopener noreferrer">MonitoringConfigurationDto</a>>| |
|
|
3344
3403
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3345
3404
|
|
|
3346
3405
|
|
|
@@ -3364,7 +3423,7 @@ const data =
|
|
|
3364
3423
|
### deleteEnvironmentConfiguration
|
|
3365
3424
|
|
|
3366
3425
|
<div class="padding-bottom--md">
|
|
3367
|
-
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
3426
|
+
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3368
3427
|
|
|
3369
3428
|
<div class="padding-left--md">
|
|
3370
3429
|
|
|
@@ -3428,7 +3487,7 @@ const data =
|
|
|
3428
3487
|
### executeExtensionMonitoringConfigurationActions
|
|
3429
3488
|
|
|
3430
3489
|
<div class="padding-bottom--md">
|
|
3431
|
-
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse">ExecuteActionsResponse</a>></strong>
|
|
3490
|
+
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse" target="_blank" rel="noopener noreferrer">ExecuteActionsResponse</a>></strong>
|
|
3432
3491
|
|
|
3433
3492
|
<div class="padding-left--md">
|
|
3434
3493
|
|
|
@@ -3448,7 +3507,7 @@ Executes Data Source action of Active Gate or Host
|
|
|
3448
3507
|
|
|
3449
3508
|
| Name | Type | Description |
|
|
3450
3509
|
| --- | --- | --- |
|
|
3451
|
-
|config.body<sup>*required</sup>|<a href="#executeactionsdto"
|
|
3510
|
+
|config.body<sup>*required</sup>|<a href="#executeactionsdto">ExecuteActionsDto</a>| |
|
|
3452
3511
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
3453
3512
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3454
3513
|
|
|
@@ -3498,7 +3557,7 @@ const data =
|
|
|
3498
3557
|
### extensionConfigurationSchema
|
|
3499
3558
|
|
|
3500
3559
|
<div class="padding-bottom--md">
|
|
3501
|
-
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto">SchemaDefinitionRestDto</a>></strong>
|
|
3560
|
+
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDto</a>></strong>
|
|
3502
3561
|
|
|
3503
3562
|
<div class="padding-left--md">
|
|
3504
3563
|
|
|
@@ -3568,7 +3627,7 @@ const data =
|
|
|
3568
3627
|
### extensionDetails
|
|
3569
3628
|
|
|
3570
3629
|
<div class="padding-bottom--md">
|
|
3571
|
-
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension"
|
|
3630
|
+
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
3572
3631
|
|
|
3573
3632
|
<div class="padding-left--md">
|
|
3574
3633
|
|
|
@@ -3670,7 +3729,7 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
3670
3729
|
### extensionMonitoringConfigurations
|
|
3671
3730
|
|
|
3672
3731
|
<div class="padding-bottom--md">
|
|
3673
|
-
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
3732
|
+
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
3674
3733
|
|
|
3675
3734
|
<div class="padding-left--md">
|
|
3676
3735
|
|
|
@@ -3738,7 +3797,7 @@ const data =
|
|
|
3738
3797
|
### getActiveEnvironmentConfiguration
|
|
3739
3798
|
|
|
3740
3799
|
<div class="padding-bottom--md">
|
|
3741
|
-
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
3800
|
+
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3742
3801
|
|
|
3743
3802
|
<div class="padding-left--md">
|
|
3744
3803
|
|
|
@@ -3802,7 +3861,7 @@ const data =
|
|
|
3802
3861
|
### getActiveGateGroupsInfo
|
|
3803
3862
|
|
|
3804
3863
|
<div class="padding-bottom--md">
|
|
3805
|
-
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto">ActiveGateGroupsInfoDto</a>></strong>
|
|
3864
|
+
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto" target="_blank" rel="noopener noreferrer">ActiveGateGroupsInfoDto</a>></strong>
|
|
3806
3865
|
|
|
3807
3866
|
<div class="padding-left--md">
|
|
3808
3867
|
|
|
@@ -3868,7 +3927,7 @@ const data =
|
|
|
3868
3927
|
### getAlertTemplate
|
|
3869
3928
|
|
|
3870
3929
|
<div class="padding-bottom--md">
|
|
3871
|
-
<strong>extensions_2_0Client.getAlertTemplate(config): Promise<<a href="#alerttemplatedto"
|
|
3930
|
+
<strong>extensions_2_0Client.getAlertTemplate(config): Promise<<a href="#alerttemplatedto">AlertTemplateDto</a>></strong>
|
|
3872
3931
|
|
|
3873
3932
|
<div class="padding-left--md">
|
|
3874
3933
|
|
|
@@ -3933,7 +3992,7 @@ const data = await extensions_2_0Client.getAlertTemplate({
|
|
|
3933
3992
|
### getEnvironmentConfigurationAssetsInfo
|
|
3934
3993
|
|
|
3935
3994
|
<div class="padding-bottom--md">
|
|
3936
|
-
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto">ExtensionAssetsDto</a>></strong>
|
|
3995
|
+
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto" target="_blank" rel="noopener noreferrer">ExtensionAssetsDto</a>></strong>
|
|
3937
3996
|
|
|
3938
3997
|
<div class="padding-left--md">
|
|
3939
3998
|
|
|
@@ -3999,7 +4058,7 @@ const data =
|
|
|
3999
4058
|
> ⚠️ **Deprecated**
|
|
4000
4059
|
|
|
4001
4060
|
<div class="padding-bottom--md">
|
|
4002
|
-
<strong>extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<<a href="#extensioneventslist"
|
|
4061
|
+
<strong>extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<<a href="#extensioneventslist">ExtensionEventsList</a>></strong>
|
|
4003
4062
|
|
|
4004
4063
|
<div class="padding-left--md">
|
|
4005
4064
|
|
|
@@ -4069,7 +4128,7 @@ const data =
|
|
|
4069
4128
|
> ⚠️ **Deprecated**
|
|
4070
4129
|
|
|
4071
4130
|
<div class="padding-bottom--md">
|
|
4072
|
-
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<<a href="#extensioneventslist">ExtensionEventsList</a>></strong>
|
|
4131
|
+
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<<a href="#extensioneventslist" target="_blank" rel="noopener noreferrer">ExtensionEventsList</a>></strong>
|
|
4073
4132
|
|
|
4074
4133
|
<div class="padding-left--md">
|
|
4075
4134
|
|
|
@@ -4141,7 +4200,7 @@ const data =
|
|
|
4141
4200
|
### getExtensionMonitoringConfigurationStatus
|
|
4142
4201
|
|
|
4143
4202
|
<div class="padding-bottom--md">
|
|
4144
|
-
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto"
|
|
4203
|
+
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto">ExtensionStatusDto</a>></strong>
|
|
4145
4204
|
|
|
4146
4205
|
<div class="padding-left--md">
|
|
4147
4206
|
|
|
@@ -4206,7 +4265,7 @@ const data =
|
|
|
4206
4265
|
### getExtensionStatus
|
|
4207
4266
|
|
|
4208
4267
|
<div class="padding-bottom--md">
|
|
4209
|
-
<strong>extensions_2_0Client.getExtensionStatus(config): Promise<Array<<a href="#extensionstatuswithiddto">ExtensionStatusWithIdDto</a>>></strong>
|
|
4268
|
+
<strong>extensions_2_0Client.getExtensionStatus(config): Promise<Array<<a href="#extensionstatuswithiddto" target="_blank" rel="noopener noreferrer">ExtensionStatusWithIdDto</a>>></strong>
|
|
4210
4269
|
|
|
4211
4270
|
<div class="padding-left--md">
|
|
4212
4271
|
|
|
@@ -4334,7 +4393,7 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
4334
4393
|
### installExtension
|
|
4335
4394
|
|
|
4336
4395
|
<div class="padding-bottom--md">
|
|
4337
|
-
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto"
|
|
4396
|
+
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto">RegisteredExtensionResultDto</a>></strong>
|
|
4338
4397
|
|
|
4339
4398
|
<div class="padding-left--md">
|
|
4340
4399
|
|
|
@@ -4398,7 +4457,7 @@ const data = await extensions_2_0Client.installExtension({
|
|
|
4398
4457
|
### listExtensionInfos
|
|
4399
4458
|
|
|
4400
4459
|
<div class="padding-bottom--md">
|
|
4401
|
-
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist">ExtensionInfoList</a>></strong>
|
|
4460
|
+
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist" target="_blank" rel="noopener noreferrer">ExtensionInfoList</a>></strong>
|
|
4402
4461
|
|
|
4403
4462
|
<div class="padding-left--md">
|
|
4404
4463
|
|
|
@@ -4462,7 +4521,7 @@ const data =
|
|
|
4462
4521
|
### listExtensionVersions
|
|
4463
4522
|
|
|
4464
4523
|
<div class="padding-bottom--md">
|
|
4465
|
-
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist"
|
|
4524
|
+
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
4466
4525
|
|
|
4467
4526
|
<div class="padding-left--md">
|
|
4468
4527
|
|
|
@@ -4528,7 +4587,7 @@ const data =
|
|
|
4528
4587
|
### listExtensions
|
|
4529
4588
|
|
|
4530
4589
|
<div class="padding-bottom--md">
|
|
4531
|
-
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
4590
|
+
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist" target="_blank" rel="noopener noreferrer">ExtensionList</a>></strong>
|
|
4532
4591
|
|
|
4533
4592
|
<div class="padding-left--md">
|
|
4534
4593
|
|
|
@@ -4591,7 +4650,7 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
4591
4650
|
### listSchemaFiles
|
|
4592
4651
|
|
|
4593
4652
|
<div class="padding-bottom--md">
|
|
4594
|
-
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles"
|
|
4653
|
+
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles">SchemaFiles</a>></strong>
|
|
4595
4654
|
|
|
4596
4655
|
<div class="padding-left--md">
|
|
4597
4656
|
|
|
@@ -4690,7 +4749,7 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
4690
4749
|
### listSchemas
|
|
4691
4750
|
|
|
4692
4751
|
<div class="padding-bottom--md">
|
|
4693
|
-
<strong>extensions_2_0Client.listSchemas(config): Promise<<a href="#schemaslist">SchemasList</a>></strong>
|
|
4752
|
+
<strong>extensions_2_0Client.listSchemas(config): Promise<<a href="#schemaslist" target="_blank" rel="noopener noreferrer">SchemasList</a>></strong>
|
|
4694
4753
|
|
|
4695
4754
|
<div class="padding-left--md">
|
|
4696
4755
|
|
|
@@ -4743,7 +4802,7 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
4743
4802
|
### monitoringConfigurationAudit
|
|
4744
4803
|
|
|
4745
4804
|
<div class="padding-bottom--md">
|
|
4746
|
-
<strong>extensions_2_0Client.monitoringConfigurationAudit(config): Promise<<a href="#auditlog"
|
|
4805
|
+
<strong>extensions_2_0Client.monitoringConfigurationAudit(config): Promise<<a href="#auditlog">AuditLog</a>></strong>
|
|
4747
4806
|
|
|
4748
4807
|
<div class="padding-left--md">
|
|
4749
4808
|
|
|
@@ -4814,7 +4873,7 @@ const data =
|
|
|
4814
4873
|
### monitoringConfigurationDetails
|
|
4815
4874
|
|
|
4816
4875
|
<div class="padding-bottom--md">
|
|
4817
|
-
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>></strong>
|
|
4876
|
+
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfiguration</a>></strong>
|
|
4818
4877
|
|
|
4819
4878
|
<div class="padding-left--md">
|
|
4820
4879
|
|
|
@@ -4879,7 +4938,7 @@ const data =
|
|
|
4879
4938
|
### removeExtension
|
|
4880
4939
|
|
|
4881
4940
|
<div class="padding-bottom--md">
|
|
4882
|
-
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension"
|
|
4941
|
+
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
4883
4942
|
|
|
4884
4943
|
<div class="padding-left--md">
|
|
4885
4944
|
|
|
@@ -5010,7 +5069,7 @@ const data =
|
|
|
5010
5069
|
### updateExtensionEnvironmentConfiguration
|
|
5011
5070
|
|
|
5012
5071
|
<div class="padding-bottom--md">
|
|
5013
|
-
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
5072
|
+
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
5014
5073
|
|
|
5015
5074
|
<div class="padding-left--md">
|
|
5016
5075
|
|
|
@@ -5030,7 +5089,7 @@ Updates the active environment configuration version of the extension 2.0
|
|
|
5030
5089
|
|
|
5031
5090
|
| Name | Type | Description |
|
|
5032
5091
|
| --- | --- | --- |
|
|
5033
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion"
|
|
5092
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
5034
5093
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
5035
5094
|
|
|
5036
5095
|
|
|
@@ -5075,7 +5134,7 @@ const data =
|
|
|
5075
5134
|
### updateMonitoringConfiguration
|
|
5076
5135
|
|
|
5077
5136
|
<div class="padding-bottom--md">
|
|
5078
|
-
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>></strong>
|
|
5137
|
+
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse" target="_blank" rel="noopener noreferrer">MonitoringConfigurationResponse</a>></strong>
|
|
5079
5138
|
|
|
5080
5139
|
<div class="padding-left--md">
|
|
5081
5140
|
|
|
@@ -5095,7 +5154,7 @@ Updates the specified monitoring configuration
|
|
|
5095
5154
|
|
|
5096
5155
|
| Name | Type | Description |
|
|
5097
5156
|
| --- | --- | --- |
|
|
5098
|
-
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto"
|
|
5157
|
+
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto">MonitoringConfigurationUpdateDto</a>| |
|
|
5099
5158
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
5100
5159
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
5101
5160
|
|
|
@@ -5143,7 +5202,7 @@ const data =
|
|
|
5143
5202
|
### uploadExtension
|
|
5144
5203
|
|
|
5145
5204
|
<div class="padding-bottom--md">
|
|
5146
|
-
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto">ExtensionUploadResponseDto</a>></strong>
|
|
5205
|
+
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto" target="_blank" rel="noopener noreferrer">ExtensionUploadResponseDto</a>></strong>
|
|
5147
5206
|
|
|
5148
5207
|
<div class="padding-left--md">
|
|
5149
5208
|
|
|
@@ -5214,7 +5273,7 @@ import { logsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
5214
5273
|
### exportLogRecords
|
|
5215
5274
|
|
|
5216
5275
|
<div class="padding-bottom--md">
|
|
5217
|
-
<strong>logsClient.exportLogRecords(config): Promise<<a href="#exportedlogrecordlist"
|
|
5276
|
+
<strong>logsClient.exportLogRecords(config): Promise<<a href="#exportedlogrecordlist">ExportedLogRecordList</a>></strong>
|
|
5218
5277
|
|
|
5219
5278
|
<div class="padding-left--md">
|
|
5220
5279
|
|
|
@@ -5291,7 +5350,7 @@ const data = await logsClient.exportLogRecords();
|
|
|
5291
5350
|
### getLogHistogramData
|
|
5292
5351
|
|
|
5293
5352
|
<div class="padding-bottom--md">
|
|
5294
|
-
<strong>logsClient.getLogHistogramData(config): Promise<<a href="#aggregatedlog">AggregatedLog</a>></strong>
|
|
5353
|
+
<strong>logsClient.getLogHistogramData(config): Promise<<a href="#aggregatedlog" target="_blank" rel="noopener noreferrer">AggregatedLog</a>></strong>
|
|
5295
5354
|
|
|
5296
5355
|
<div class="padding-left--md">
|
|
5297
5356
|
|
|
@@ -5378,7 +5437,7 @@ const data = await logsClient.getLogHistogramData();
|
|
|
5378
5437
|
### getLogRecords
|
|
5379
5438
|
|
|
5380
5439
|
<div class="padding-bottom--md">
|
|
5381
|
-
<strong>logsClient.getLogRecords(config): Promise<<a href="#logrecordslist"
|
|
5440
|
+
<strong>logsClient.getLogRecords(config): Promise<<a href="#logrecordslist">LogRecordsList</a>></strong>
|
|
5382
5441
|
|
|
5383
5442
|
<div class="padding-left--md">
|
|
5384
5443
|
|
|
@@ -5465,7 +5524,7 @@ const data = await logsClient.getLogRecords();
|
|
|
5465
5524
|
### storeLog
|
|
5466
5525
|
|
|
5467
5526
|
<div class="padding-bottom--md">
|
|
5468
|
-
<strong>logsClient.storeLog(config): Promise<void | <a href="#successenvelope">SuccessEnvelope</a>></strong>
|
|
5527
|
+
<strong>logsClient.storeLog(config): Promise<void | <a href="#successenvelope" target="_blank" rel="noopener noreferrer">SuccessEnvelope</a>></strong>
|
|
5469
5528
|
|
|
5470
5529
|
<div class="padding-left--md">
|
|
5471
5530
|
|
|
@@ -5509,10 +5568,11 @@ It is recommended to use an exponential backoff strategy for retrying requests.
|
|
|
5509
5568
|
|
|
5510
5569
|
#### Parameters
|
|
5511
5570
|
|
|
5512
|
-
| Name | Type |
|
|
5513
|
-
| --- | --- |
|
|
5514
|
-
|config.body<sup>*required</sup>|LogMessageJson | LogMessagePlain|
|
|
5515
|
-
|config.type<sup>*required</sup>|"application/json" | "application/json; charset=utf-8" | "application/jsonl" | "application/jsonl; charset=utf-8" | "application/jsonlines" | "application/jsonlines+json" | "application/jsonlines+json; charset=utf-8" | "application/jsonlines; charset=utf-8" | "application/x-jsonlines" | "application/x-jsonlines; charset=utf-8" | "application/x-ndjson" | "application/x-ndjson; charset=utf-8" | "text/plain; charset=utf-8"|
|
|
5571
|
+
| Name | Type | Description |
|
|
5572
|
+
| --- | --- | --- |
|
|
5573
|
+
|config.body<sup>*required</sup>|LogMessageJson | LogMessagePlain| |
|
|
5574
|
+
|config.type<sup>*required</sup>|"application/json" | "application/json; charset=utf-8" | "application/jsonl" | "application/jsonl; charset=utf-8" | "application/jsonlines" | "application/jsonlines+json" | "application/jsonlines+json; charset=utf-8" | "application/jsonlines; charset=utf-8" | "application/x-jsonlines" | "application/x-jsonlines; charset=utf-8" | "application/x-ndjson" | "application/x-ndjson; charset=utf-8" | "text/plain; charset=utf-8"| |
|
|
5575
|
+
|config.contentType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Allows to provide content type with query parameter. Has priority over value provided in Content-Type header. |
|
|
5516
5576
|
|
|
5517
5577
|
|
|
5518
5578
|
|
|
@@ -5587,7 +5647,7 @@ import { metricsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
5587
5647
|
### allMetrics
|
|
5588
5648
|
|
|
5589
5649
|
<div class="padding-bottom--md">
|
|
5590
|
-
<strong>metricsClient.allMetrics(config): Promise<<a href="#metricdescriptorcollection"
|
|
5650
|
+
<strong>metricsClient.allMetrics(config): Promise<<a href="#metricdescriptorcollection">MetricDescriptorCollection</a>></strong>
|
|
5591
5651
|
|
|
5592
5652
|
<div class="padding-left--md">
|
|
5593
5653
|
|
|
@@ -5726,7 +5786,7 @@ const data = await metricsClient.delete({
|
|
|
5726
5786
|
### ingest
|
|
5727
5787
|
|
|
5728
5788
|
<div class="padding-bottom--md">
|
|
5729
|
-
<strong>metricsClient.ingest(config): Promise<<a href="#validationresponse">ValidationResponse</a>></strong>
|
|
5789
|
+
<strong>metricsClient.ingest(config): Promise<<a href="#validationresponse" target="_blank" rel="noopener noreferrer">ValidationResponse</a>></strong>
|
|
5730
5790
|
|
|
5731
5791
|
<div class="padding-left--md">
|
|
5732
5792
|
|
|
@@ -5788,7 +5848,7 @@ const data = await metricsClient.ingest({
|
|
|
5788
5848
|
### metric
|
|
5789
5849
|
|
|
5790
5850
|
<div class="padding-bottom--md">
|
|
5791
|
-
<strong>metricsClient.metric(config): Promise<<a href="#metricdescriptor"
|
|
5851
|
+
<strong>metricsClient.metric(config): Promise<<a href="#metricdescriptor">MetricDescriptor</a>></strong>
|
|
5792
5852
|
|
|
5793
5853
|
<div class="padding-left--md">
|
|
5794
5854
|
|
|
@@ -5851,7 +5911,7 @@ const data = await metricsClient.metric({
|
|
|
5851
5911
|
### query
|
|
5852
5912
|
|
|
5853
5913
|
<div class="padding-bottom--md">
|
|
5854
|
-
<strong>metricsClient.query(config): Promise<<a href="#metricdata">MetricData</a>></strong>
|
|
5914
|
+
<strong>metricsClient.query(config): Promise<<a href="#metricdata" target="_blank" rel="noopener noreferrer">MetricData</a>></strong>
|
|
5855
5915
|
|
|
5856
5916
|
<div class="padding-left--md">
|
|
5857
5917
|
|
|
@@ -5879,11 +5939,11 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
|
|
|
5879
5939
|
| Name | Type | Description |
|
|
5880
5940
|
| --- | --- | --- |
|
|
5881
5941
|
|config.acceptType<sup>*required</sup>|"application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8"| |
|
|
5882
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entity scope of the query. Only data points delivered by matched entities are included in response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
5942
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entity scope of the query. Only data points delivered by matched entities are included in response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>Use the <a href="https://dt-url.net/6z23ifk" target="_blank" rel="noopener noreferrer" ><code>GET /metrics/\\{metricId}</code></a> call to fetch the list of possible entity types for your metric.</p> <p>To set a universal scope matching all entities, omit this parameter.</p> |
|
|
5883
5943
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
5884
5944
|
|config.metricSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Selects metrics for the query by their keys. You can select up to 10 metrics for one query.</p> <p>You can specify multiple metric keys separated by commas (for example, <code>metrickey1,metrickey2</code>). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the <code>builtin:host.cpu.idle</code> and <code>builtin:host.cpu.user</code> metric, write: <code>builtin:host.cpu.(idle,user)</code>.</p> <p>If the metric key contains any symbols you must quote (<code>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>~</code>):</p> <ul> <li>Quotes (<code>"</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type "APACHE"</strong> you must specify this selector:</p> <p><code>"ext:selfmonitoring.jmx.Agents: Type ~"APACHE~""</code></p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector" target="_blank" rel="noopener noreferrer" >Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> |
|
|
5885
5945
|
|config.mzSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The management zone scope of the query. Only metrics data relating to the specified management zones are included to the response.</p> <p>You can set one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li><code>mzId(123,456)</code></li> <li><code>mzName("name-1","name-2")</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName("name-1","name-2"),mzId(1234)</code>. Only results matching <strong>all</strong> of the criteria are included in the response.For example, to list metrics that have the id <strong>123</strong> OR <strong>234</strong> AND the name <strong>name-1</strong> OR <strong>name-2</strong>, use this <strong>mzSelector</strong>: `mzId(123,234),mzName("name-1","name-2").</li> </ul> |
|
|
5886
|
-
|config.resolution|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The desired resolution of data points.</p> <p>You can use one of the following options:</p> <ul> <li>The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points.</li> <li>The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan.</li> </ul> <p>Valid units for the timespan are:</p> <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>q</code>: quarters</li> <li><code>y</code>: years</li> </ul> <p>If not set, the default is <strong>120 data points</strong>.</p> <p>For example:</p> <ul> <li>Get data points which are 10 minutes apart: <code>resolution=10m</code></li> <li>Get data points which are 3 weeks apart: <code>resolution=3w</code></li> </ul> |
|
|
5946
|
+
|config.resolution|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The desired resolution of data points.</p> <p>You can use one of the following options:</p> <ul> <li>The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points.</li> <li>The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan.</li> </ul> <p>Valid units for the timespan are:</p> <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>q</code>: quarters</li> <li><code>y</code>: years</li> </ul> <p>If not set, the default is <strong>120 data points</strong>.</p> <p>For example:</p> <ul> <li>Get data points which are 10 minutes apart: <code>resolution=10m</code></li> <li>Get data points which are 3 weeks apart: <code>resolution=3w</code></li> </ul> <p>You can also specify <strong>multiple resolutions</strong> for a single query using index-based formatting. This allows each metric expression in a multi-expression selector to have its own resolution.</p> <p>Use the format: <code><index>:<resolution>(,<index>:<resolution>)\*</code> Where:</p> <ul> <li><code>index</code> is the zero-based position of the metric expression in the <code>metricSelector</code> list.</li> <li><code>resolution</code> is either a number of data points (e.g., <code>120</code>) or a timespan with a unit (e.g., <code>10m</code>, <code>3w</code>).</li> </ul> <p>If a resolution is not specified for a given index, the default of <strong>120 data points</strong> is applied.</p> <p><strong>Examples:</strong></p> <ul> <li><code>resolution=0:Inf</code> → First metric uses resolution <code>Inf</code>, second metric uses default (120 data points).</li> <li><code>resolution=0:Inf,1:10</code> → First metric uses <code>Inf</code>, second metric uses <code>10</code> data points.</li> <li><code>resolution=Inf</code> → All metrics use resolution <code>Inf</code>. <strong>Note:</strong> If multiple resolutions are used, the resolution field in the response is the smallest resolution.</li> </ul> |
|
|
5887
5947
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5888
5948
|
|
|
5889
5949
|
|
|
@@ -5933,7 +5993,7 @@ import { metricsUnitsClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
5933
5993
|
### allUnits
|
|
5934
5994
|
|
|
5935
5995
|
<div class="padding-bottom--md">
|
|
5936
|
-
<strong>metricsUnitsClient.allUnits(config): Promise<<a href="#unitlist"
|
|
5996
|
+
<strong>metricsUnitsClient.allUnits(config): Promise<<a href="#unitlist">UnitList</a>></strong>
|
|
5937
5997
|
|
|
5938
5998
|
<div class="padding-left--md">
|
|
5939
5999
|
|
|
@@ -5995,7 +6055,7 @@ const data = await metricsUnitsClient.allUnits();
|
|
|
5995
6055
|
### convert
|
|
5996
6056
|
|
|
5997
6057
|
<div class="padding-bottom--md">
|
|
5998
|
-
<strong>metricsUnitsClient.convert(config): Promise<<a href="#unitconversionresult">UnitConversionResult</a>></strong>
|
|
6058
|
+
<strong>metricsUnitsClient.convert(config): Promise<<a href="#unitconversionresult" target="_blank" rel="noopener noreferrer">UnitConversionResult</a>></strong>
|
|
5999
6059
|
|
|
6000
6060
|
<div class="padding-left--md">
|
|
6001
6061
|
|
|
@@ -6062,7 +6122,7 @@ const data = await metricsUnitsClient.convert({
|
|
|
6062
6122
|
### unit
|
|
6063
6123
|
|
|
6064
6124
|
<div class="padding-bottom--md">
|
|
6065
|
-
<strong>metricsUnitsClient.unit(config): Promise<<a href="#unit"
|
|
6125
|
+
<strong>metricsUnitsClient.unit(config): Promise<<a href="#unit">Unit</a>></strong>
|
|
6066
6126
|
|
|
6067
6127
|
<div class="padding-left--md">
|
|
6068
6128
|
|
|
@@ -6131,7 +6191,7 @@ import { monitoredEntitiesClient } from '@dynatrace-sdk/client-classic-environme
|
|
|
6131
6191
|
> ⚠️ **Deprecated**
|
|
6132
6192
|
|
|
6133
6193
|
<div class="padding-bottom--md">
|
|
6134
|
-
<strong>monitoredEntitiesClient.deleteSecurityContext(config): Promise<<a href="#securitycontextresultdto">SecurityContextResultDto</a>></strong>
|
|
6194
|
+
<strong>monitoredEntitiesClient.deleteSecurityContext(config): Promise<<a href="#securitycontextresultdto" target="_blank" rel="noopener noreferrer">SecurityContextResultDto</a>></strong>
|
|
6135
6195
|
|
|
6136
6196
|
<div class="padding-left--md">
|
|
6137
6197
|
|
|
@@ -6155,7 +6215,7 @@ Automatic management zone rules will apply again to entities without a security
|
|
|
6155
6215
|
|
|
6156
6216
|
| Name | Type | Description |
|
|
6157
6217
|
| --- | --- | --- |
|
|
6158
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6218
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6159
6219
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
6160
6220
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
6161
6221
|
|
|
@@ -6201,7 +6261,7 @@ const data =
|
|
|
6201
6261
|
### getEntities
|
|
6202
6262
|
|
|
6203
6263
|
<div class="padding-bottom--md">
|
|
6204
|
-
<strong>monitoredEntitiesClient.getEntities(config): Promise<<a href="#entitieslist"
|
|
6264
|
+
<strong>monitoredEntitiesClient.getEntities(config): Promise<<a href="#entitieslist">EntitiesList</a>></strong>
|
|
6205
6265
|
|
|
6206
6266
|
<div class="padding-left--md">
|
|
6207
6267
|
|
|
@@ -6231,7 +6291,7 @@ You can limit the output by using pagination:
|
|
|
6231
6291
|
|
|
6232
6292
|
| Name | Type | Description |
|
|
6233
6293
|
| --- | --- | --- |
|
|
6234
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6294
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The field is <strong>required</strong> when you're querying the first page of results.</p> |
|
|
6235
6295
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
|
|
6236
6296
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
6237
6297
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
@@ -6278,7 +6338,7 @@ const data = await monitoredEntitiesClient.getEntities();
|
|
|
6278
6338
|
### getEntity
|
|
6279
6339
|
|
|
6280
6340
|
<div class="padding-bottom--md">
|
|
6281
|
-
<strong>monitoredEntitiesClient.getEntity(config): Promise<<a href="#entity">Entity</a>></strong>
|
|
6341
|
+
<strong>monitoredEntitiesClient.getEntity(config): Promise<<a href="#entity" target="_blank" rel="noopener noreferrer">Entity</a>></strong>
|
|
6282
6342
|
|
|
6283
6343
|
<div class="padding-left--md">
|
|
6284
6344
|
|
|
@@ -6342,7 +6402,7 @@ const data = await monitoredEntitiesClient.getEntity({
|
|
|
6342
6402
|
### getEntityType
|
|
6343
6403
|
|
|
6344
6404
|
<div class="padding-bottom--md">
|
|
6345
|
-
<strong>monitoredEntitiesClient.getEntityType(config): Promise<<a href="#entitytype"
|
|
6405
|
+
<strong>monitoredEntitiesClient.getEntityType(config): Promise<<a href="#entitytype">EntityType</a>></strong>
|
|
6346
6406
|
|
|
6347
6407
|
<div class="padding-left--md">
|
|
6348
6408
|
|
|
@@ -6403,7 +6463,7 @@ const data = await monitoredEntitiesClient.getEntityType({
|
|
|
6403
6463
|
### getEntityTypes
|
|
6404
6464
|
|
|
6405
6465
|
<div class="padding-bottom--md">
|
|
6406
|
-
<strong>monitoredEntitiesClient.getEntityTypes(config): Promise<<a href="#entitytypelist">EntityTypeList</a>></strong>
|
|
6466
|
+
<strong>monitoredEntitiesClient.getEntityTypes(config): Promise<<a href="#entitytypelist" target="_blank" rel="noopener noreferrer">EntityTypeList</a>></strong>
|
|
6407
6467
|
|
|
6408
6468
|
<div class="padding-left--md">
|
|
6409
6469
|
|
|
@@ -6467,7 +6527,7 @@ const data = await monitoredEntitiesClient.getEntityTypes();
|
|
|
6467
6527
|
### pushCustomDevice
|
|
6468
6528
|
|
|
6469
6529
|
<div class="padding-bottom--md">
|
|
6470
|
-
<strong>monitoredEntitiesClient.pushCustomDevice(config): Promise<void | <a href="#customdevicecreationresult"
|
|
6530
|
+
<strong>monitoredEntitiesClient.pushCustomDevice(config): Promise<void | <a href="#customdevicecreationresult">CustomDeviceCreationResult</a>></strong>
|
|
6471
6531
|
|
|
6472
6532
|
<div class="padding-left--md">
|
|
6473
6533
|
|
|
@@ -6485,7 +6545,7 @@ Creates or updates a custom device
|
|
|
6485
6545
|
|
|
6486
6546
|
| Name | Type | Description |
|
|
6487
6547
|
| --- | --- | --- |
|
|
6488
|
-
|config.body<sup>*required</sup>|<a href="#customdevicecreation">CustomDeviceCreation</a>| |
|
|
6548
|
+
|config.body<sup>*required</sup>|<a href="#customdevicecreation" target="_blank" rel="noopener noreferrer">CustomDeviceCreation</a>| |
|
|
6489
6549
|
|config.uiBased|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, it will be handled as if it was created via UI. It will be refreshed automatically and won't age out. |
|
|
6490
6550
|
|
|
6491
6551
|
|
|
@@ -6532,7 +6592,7 @@ const data = await monitoredEntitiesClient.pushCustomDevice(
|
|
|
6532
6592
|
> ⚠️ **Deprecated**
|
|
6533
6593
|
|
|
6534
6594
|
<div class="padding-bottom--md">
|
|
6535
|
-
<strong>monitoredEntitiesClient.setSecurityContext(config): Promise<<a href="#securitycontextresultdto"
|
|
6595
|
+
<strong>monitoredEntitiesClient.setSecurityContext(config): Promise<<a href="#securitycontextresultdto">SecurityContextResultDto</a>></strong>
|
|
6536
6596
|
|
|
6537
6597
|
<div class="padding-left--md">
|
|
6538
6598
|
|
|
@@ -6558,8 +6618,8 @@ Automatic management zone rules will not apply to entities with a set security c
|
|
|
6558
6618
|
|
|
6559
6619
|
| Name | Type | Description |
|
|
6560
6620
|
| --- | --- | --- |
|
|
6561
|
-
|config.body<sup>*required</sup>|<a href="#securitycontextdtoimpl">SecurityContextDtoImpl</a>| |
|
|
6562
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6621
|
+
|config.body<sup>*required</sup>|<a href="#securitycontextdtoimpl" target="_blank" rel="noopener noreferrer">SecurityContextDtoImpl</a>| |
|
|
6622
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6563
6623
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
6564
6624
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
6565
6625
|
|
|
@@ -6612,7 +6672,7 @@ import { monitoredEntitiesCustomTagsClient } from '@dynatrace-sdk/client-classic
|
|
|
6612
6672
|
### deleteTags
|
|
6613
6673
|
|
|
6614
6674
|
<div class="padding-bottom--md">
|
|
6615
|
-
<strong>monitoredEntitiesCustomTagsClient.deleteTags(config): Promise<<a href="#deletedentitytags"
|
|
6675
|
+
<strong>monitoredEntitiesCustomTagsClient.deleteTags(config): Promise<<a href="#deletedentitytags">DeletedEntityTags</a>></strong>
|
|
6616
6676
|
|
|
6617
6677
|
<div class="padding-left--md">
|
|
6618
6678
|
|
|
@@ -6631,7 +6691,7 @@ Deletes the specified tag from the specified entities
|
|
|
6631
6691
|
| Name | Type | Description |
|
|
6632
6692
|
| --- | --- | --- |
|
|
6633
6693
|
|config.deleteAllWithKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<ul> <li>If <code>true</code>, all tags with the specified key are deleted, regardless of the value.</li> <li>If <code>false</code>, only tags with exact match of key <strong>and</strong> value are deleted.</li> </ul> <p>If not set, <code>false</code> is used.</p> |
|
|
6634
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to delete tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6694
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to delete tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6635
6695
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
6636
6696
|
|config.key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The key of the tag to be deleted.</p> <p>If <strong>deleteAllWithKey</strong> is <code>true</code>, then all tags with this key are deleted. Otherwise, only tags with exact match of key <strong>and</strong> value are deleted.</p> <p>For value-only tags, specify the value here.</p> |
|
|
6637
6697
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
@@ -6680,7 +6740,7 @@ const data =
|
|
|
6680
6740
|
### getTags
|
|
6681
6741
|
|
|
6682
6742
|
<div class="padding-bottom--md">
|
|
6683
|
-
<strong>monitoredEntitiesCustomTagsClient.getTags(config): Promise<<a href="#customentitytags">CustomEntityTags</a>></strong>
|
|
6743
|
+
<strong>monitoredEntitiesCustomTagsClient.getTags(config): Promise<<a href="#customentitytags" target="_blank" rel="noopener noreferrer">CustomEntityTags</a>></strong>
|
|
6684
6744
|
|
|
6685
6745
|
<div class="padding-left--md">
|
|
6686
6746
|
|
|
@@ -6700,7 +6760,7 @@ Automatically applied tags and imported tags are not included.
|
|
|
6700
6760
|
|
|
6701
6761
|
| Name | Type | Description |
|
|
6702
6762
|
| --- | --- | --- |
|
|
6703
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to read tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6763
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to read tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6704
6764
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
6705
6765
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
6706
6766
|
|
|
@@ -6746,7 +6806,7 @@ const data =
|
|
|
6746
6806
|
### postTags
|
|
6747
6807
|
|
|
6748
6808
|
<div class="padding-bottom--md">
|
|
6749
|
-
<strong>monitoredEntitiesCustomTagsClient.postTags(config): Promise<<a href="#addedentitytags"
|
|
6809
|
+
<strong>monitoredEntitiesCustomTagsClient.postTags(config): Promise<<a href="#addedentitytags">AddedEntityTags</a>></strong>
|
|
6750
6810
|
|
|
6751
6811
|
<div class="padding-left--md">
|
|
6752
6812
|
|
|
@@ -6766,8 +6826,8 @@ All existing tags remain unaffected.
|
|
|
6766
6826
|
|
|
6767
6827
|
| Name | Type | Description |
|
|
6768
6828
|
| --- | --- | --- |
|
|
6769
|
-
|config.body<sup>*required</sup>|<a href="#addentitytags">AddEntityTags</a>| |
|
|
6770
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to update tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6829
|
+
|config.body<sup>*required</sup>|<a href="#addentitytags" target="_blank" rel="noopener noreferrer">AddEntityTags</a>| |
|
|
6830
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to update tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6771
6831
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
6772
6832
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
6773
6833
|
|
|
@@ -6820,7 +6880,7 @@ import { monitoredEntitiesMonitoringStateClient } from '@dynatrace-sdk/client-cl
|
|
|
6820
6880
|
### getStates
|
|
6821
6881
|
|
|
6822
6882
|
<div class="padding-bottom--md">
|
|
6823
|
-
<strong>monitoredEntitiesMonitoringStateClient.getStates(config): Promise<<a href="#monitoredstates"
|
|
6883
|
+
<strong>monitoredEntitiesMonitoringStateClient.getStates(config): Promise<<a href="#monitoredstates">MonitoredStates</a>></strong>
|
|
6824
6884
|
|
|
6825
6885
|
<div class="padding-left--md">
|
|
6826
6886
|
|
|
@@ -6840,7 +6900,7 @@ Only process group instances are supported.
|
|
|
6840
6900
|
|
|
6841
6901
|
| Name | Type | Description |
|
|
6842
6902
|
| --- | --- | --- |
|
|
6843
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
6903
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6844
6904
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
6845
6905
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
6846
6906
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
|
|
@@ -6892,7 +6952,7 @@ import { networkZonesClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
6892
6952
|
### createOrUpdateNetworkZone
|
|
6893
6953
|
|
|
6894
6954
|
<div class="padding-bottom--md">
|
|
6895
|
-
<strong>networkZonesClient.createOrUpdateNetworkZone(config): Promise<void | <a href="#entityshortrepresentation">EntityShortRepresentation</a>></strong>
|
|
6955
|
+
<strong>networkZonesClient.createOrUpdateNetworkZone(config): Promise<void | <a href="#entityshortrepresentation" target="_blank" rel="noopener noreferrer">EntityShortRepresentation</a>></strong>
|
|
6896
6956
|
|
|
6897
6957
|
<div class="padding-left--md">
|
|
6898
6958
|
|
|
@@ -6914,7 +6974,7 @@ If the network zone with the specified ID does not exist, a new network zone is
|
|
|
6914
6974
|
|
|
6915
6975
|
| Name | Type | Description |
|
|
6916
6976
|
| --- | --- | --- |
|
|
6917
|
-
|config.body<sup>*required</sup>|<a href="#networkzone"
|
|
6977
|
+
|config.body<sup>*required</sup>|<a href="#networkzone">NetworkZone</a>| |
|
|
6918
6978
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The ID of the network zone to be updated.</p> <p>If you set the ID in the body as well, it must match this ID.</p> <p>The ID is not case sensitive. Dynatrace stores the ID in lowercase.</p> |
|
|
6919
6979
|
|
|
6920
6980
|
|
|
@@ -7026,7 +7086,7 @@ const data = await networkZonesClient.deleteNetworkZone({
|
|
|
7026
7086
|
### getAllNetworkZones
|
|
7027
7087
|
|
|
7028
7088
|
<div class="padding-bottom--md">
|
|
7029
|
-
<strong>networkZonesClient.getAllNetworkZones(config): Promise<<a href="#networkzonelist">NetworkZoneList</a>></strong>
|
|
7089
|
+
<strong>networkZonesClient.getAllNetworkZones(config): Promise<<a href="#networkzonelist" target="_blank" rel="noopener noreferrer">NetworkZoneList</a>></strong>
|
|
7030
7090
|
|
|
7031
7091
|
<div class="padding-left--md">
|
|
7032
7092
|
|
|
@@ -7077,7 +7137,7 @@ const data = await networkZonesClient.getAllNetworkZones();
|
|
|
7077
7137
|
### getHostStats
|
|
7078
7138
|
|
|
7079
7139
|
<div class="padding-bottom--md">
|
|
7080
|
-
<strong>networkZonesClient.getHostStats(config): Promise<<a href="#networkzoneconnectionstatistics"
|
|
7140
|
+
<strong>networkZonesClient.getHostStats(config): Promise<<a href="#networkzoneconnectionstatistics">NetworkZoneConnectionStatistics</a>></strong>
|
|
7081
7141
|
|
|
7082
7142
|
<div class="padding-left--md">
|
|
7083
7143
|
|
|
@@ -7139,7 +7199,7 @@ const data = await networkZonesClient.getHostStats({
|
|
|
7139
7199
|
### getNetworkZoneSettings
|
|
7140
7200
|
|
|
7141
7201
|
<div class="padding-bottom--md">
|
|
7142
|
-
<strong>networkZonesClient.getNetworkZoneSettings(config): Promise<<a href="#networkzonesettings">NetworkZoneSettings</a>></strong>
|
|
7202
|
+
<strong>networkZonesClient.getNetworkZoneSettings(config): Promise<<a href="#networkzonesettings" target="_blank" rel="noopener noreferrer">NetworkZoneSettings</a>></strong>
|
|
7143
7203
|
|
|
7144
7204
|
<div class="padding-left--md">
|
|
7145
7205
|
|
|
@@ -7191,7 +7251,7 @@ const data =
|
|
|
7191
7251
|
### getSingleNetworkZone
|
|
7192
7252
|
|
|
7193
7253
|
<div class="padding-bottom--md">
|
|
7194
|
-
<strong>networkZonesClient.getSingleNetworkZone(config): Promise<<a href="#networkzone"
|
|
7254
|
+
<strong>networkZonesClient.getSingleNetworkZone(config): Promise<<a href="#networkzone">NetworkZone</a>></strong>
|
|
7195
7255
|
|
|
7196
7256
|
<div class="padding-left--md">
|
|
7197
7257
|
|
|
@@ -7270,7 +7330,7 @@ Updates the global configuration of network zones
|
|
|
7270
7330
|
|
|
7271
7331
|
| Name | Type |
|
|
7272
7332
|
| --- | --- |
|
|
7273
|
-
|config.body<sup>*required</sup>|<a href="#networkzonesettings">NetworkZoneSettings</a>|
|
|
7333
|
+
|config.body<sup>*required</sup>|<a href="#networkzonesettings" target="_blank" rel="noopener noreferrer">NetworkZoneSettings</a>|
|
|
7274
7334
|
|
|
7275
7335
|
|
|
7276
7336
|
|
|
@@ -7320,7 +7380,7 @@ import { problemsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
7320
7380
|
### closeProblem
|
|
7321
7381
|
|
|
7322
7382
|
<div class="padding-bottom--md">
|
|
7323
|
-
<strong>problemsClient.closeProblem(config): Promise<void | <a href="#problemcloseresult"
|
|
7383
|
+
<strong>problemsClient.closeProblem(config): Promise<void | <a href="#problemcloseresult">ProblemCloseResult</a>></strong>
|
|
7324
7384
|
|
|
7325
7385
|
<div class="padding-left--md">
|
|
7326
7386
|
|
|
@@ -7338,7 +7398,7 @@ Closes the specified problem and adds a closing comment on it
|
|
|
7338
7398
|
|
|
7339
7399
|
| Name | Type | Description |
|
|
7340
7400
|
| --- | --- | --- |
|
|
7341
|
-
|config.body<sup>*required</sup>|<a href="#problemcloserequestdtoimpl">ProblemCloseRequestDtoImpl</a>| |
|
|
7401
|
+
|config.body<sup>*required</sup>|<a href="#problemcloserequestdtoimpl" target="_blank" rel="noopener noreferrer">ProblemCloseRequestDtoImpl</a>| |
|
|
7342
7402
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
7343
7403
|
|
|
7344
7404
|
|
|
@@ -7402,7 +7462,7 @@ Adds a new comment on the specified problem
|
|
|
7402
7462
|
|
|
7403
7463
|
| Name | Type | Description |
|
|
7404
7464
|
| --- | --- | --- |
|
|
7405
|
-
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl"
|
|
7465
|
+
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a>| |
|
|
7406
7466
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
7407
7467
|
|
|
7408
7468
|
|
|
@@ -7510,7 +7570,7 @@ const data = await problemsClient.deleteComment({
|
|
|
7510
7570
|
### getComment
|
|
7511
7571
|
|
|
7512
7572
|
<div class="padding-bottom--md">
|
|
7513
|
-
<strong>problemsClient.getComment(config): Promise<<a href="#comment">Comment</a>></strong>
|
|
7573
|
+
<strong>problemsClient.getComment(config): Promise<<a href="#comment" target="_blank" rel="noopener noreferrer">Comment</a>></strong>
|
|
7514
7574
|
|
|
7515
7575
|
<div class="padding-left--md">
|
|
7516
7576
|
|
|
@@ -7573,7 +7633,7 @@ const data = await problemsClient.getComment({
|
|
|
7573
7633
|
### getComments
|
|
7574
7634
|
|
|
7575
7635
|
<div class="padding-bottom--md">
|
|
7576
|
-
<strong>problemsClient.getComments(config): Promise<<a href="#commentslist"
|
|
7636
|
+
<strong>problemsClient.getComments(config): Promise<<a href="#commentslist">CommentsList</a>></strong>
|
|
7577
7637
|
|
|
7578
7638
|
<div class="padding-left--md">
|
|
7579
7639
|
|
|
@@ -7636,7 +7696,7 @@ const data = await problemsClient.getComments({
|
|
|
7636
7696
|
### getProblem
|
|
7637
7697
|
|
|
7638
7698
|
<div class="padding-bottom--md">
|
|
7639
|
-
<strong>problemsClient.getProblem(config): Promise<<a href="#problem">Problem</a>></strong>
|
|
7699
|
+
<strong>problemsClient.getProblem(config): Promise<<a href="#problem" target="_blank" rel="noopener noreferrer">Problem</a>></strong>
|
|
7640
7700
|
|
|
7641
7701
|
<div class="padding-left--md">
|
|
7642
7702
|
|
|
@@ -7698,7 +7758,7 @@ const data = await problemsClient.getProblem({
|
|
|
7698
7758
|
### getProblems
|
|
7699
7759
|
|
|
7700
7760
|
<div class="padding-bottom--md">
|
|
7701
|
-
<strong>problemsClient.getProblems(config): Promise<<a href="#problems"
|
|
7761
|
+
<strong>problemsClient.getProblems(config): Promise<<a href="#problems">Problems</a>></strong>
|
|
7702
7762
|
|
|
7703
7763
|
<div class="padding-left--md">
|
|
7704
7764
|
|
|
@@ -7716,12 +7776,12 @@ Lists problems observed within the specified timeframe
|
|
|
7716
7776
|
|
|
7717
7777
|
| Name | Type | Description |
|
|
7718
7778
|
| --- | --- | --- |
|
|
7719
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&
|
|
7779
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The maximum number of entities that may be selected is limited to 10000.</p> |
|
|
7720
7780
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of additional problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>evidenceDetails</code>: The details of the root cause.</li> <li><code>impactAnalysis</code>: The impact analysis of the problem on other entities/users.</li> <li><code>recentComments</code>: A list of the most recent comments to the problem.</li> </ul> <p>To add properties, specify them as a comma-separated list (for example, <code>evidenceDetails,impactAnalysis</code>).</p> <p>The field is valid only for the current page of results. You must set it for each page you're requesting.</p> |
|
|
7721
7781
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
7722
7782
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
|
|
7723
7783
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 50 is used.</p> |
|
|
7724
|
-
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("\[context]key:value","key:value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId(&
|
|
7784
|
+
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("\[context]key:value","key:value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId("id-1", "id-2")</code>.</li> <li>Under maintenance: <code>underMaintenance(true|false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text("value")</code>. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the <code>relevance</code> sort option should be used to get the most relevant problems first. The special characters <code>\\~</code> and <code>"</code> need to be escaped using a <code>\\~</code> (e.g. double quote search <code>text("\\~"")</code>). The search value is limited to 30 characters.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
7725
7785
|
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies a set of comma-separated (<code>,</code>) fields for sorting in the problem list.</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: problem status (<code>+</code> open problems first or <code>-</code> closed problems first)</li> <li><code>startTime</code>: problem start time (<code>+</code> old problems first or <code>-</code> new problems first)</li> <li><code>relevance</code>: problem relevance (<code>+</code> least relevant problems first or <code>-</code> most relevant problems first) - can be used only in combination with text search</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> <p>You can specify several levels of sorting. For example, <code>+status,-startTime</code> sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.</p> |
|
|
7726
7786
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
7727
7787
|
|
|
@@ -7782,7 +7842,7 @@ Updates the specified comment on a problem
|
|
|
7782
7842
|
|
|
7783
7843
|
| Name | Type | Description |
|
|
7784
7844
|
| --- | --- | --- |
|
|
7785
|
-
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a>| |
|
|
7845
|
+
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl" target="_blank" rel="noopener noreferrer">CommentRequestDtoImpl</a>| |
|
|
7786
7846
|
|config.commentId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required comment. |
|
|
7787
7847
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
7788
7848
|
|
|
@@ -7835,7 +7895,7 @@ import { releasesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
7835
7895
|
### getReleases
|
|
7836
7896
|
|
|
7837
7897
|
<div class="padding-bottom--md">
|
|
7838
|
-
<strong>releasesClient.getReleases(config): Promise<<a href="#releases"
|
|
7898
|
+
<strong>releasesClient.getReleases(config): Promise<<a href="#releases">Releases</a>></strong>
|
|
7839
7899
|
|
|
7840
7900
|
<div class="padding-left--md">
|
|
7841
7901
|
|
|
@@ -7910,7 +7970,7 @@ import { rumManualInsertionTagsClient } from '@dynatrace-sdk/client-classic-envi
|
|
|
7910
7970
|
|
|
7911
7971
|
<div class="padding-left--md">
|
|
7912
7972
|
|
|
7913
|
-
Download the inline code
|
|
7973
|
+
Download the inline code
|
|
7914
7974
|
|
|
7915
7975
|
**Required scope:** environment-api:rum:read
|
|
7916
7976
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -7974,7 +8034,7 @@ const data =
|
|
|
7974
8034
|
|
|
7975
8035
|
<div class="padding-left--md">
|
|
7976
8036
|
|
|
7977
|
-
Download the JavaScript tag
|
|
8037
|
+
Download the JavaScript tag
|
|
7978
8038
|
|
|
7979
8039
|
**Required scope:** environment-api:rum:read
|
|
7980
8040
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -8040,7 +8100,7 @@ const data =
|
|
|
8040
8100
|
|
|
8041
8101
|
<div class="padding-left--md">
|
|
8042
8102
|
|
|
8043
|
-
Download the OneAgent JavaScript tag
|
|
8103
|
+
Download the OneAgent JavaScript tag
|
|
8044
8104
|
|
|
8045
8105
|
**Required scope:** environment-api:rum:read
|
|
8046
8106
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -8105,7 +8165,7 @@ const data =
|
|
|
8105
8165
|
|
|
8106
8166
|
<div class="padding-left--md">
|
|
8107
8167
|
|
|
8108
|
-
Download the OneAgent JavaScript tag with SRI
|
|
8168
|
+
Download the OneAgent JavaScript tag with SRI
|
|
8109
8169
|
|
|
8110
8170
|
**Required scope:** environment-api:rum:read
|
|
8111
8171
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -8172,7 +8232,7 @@ import { securityProblemsClient } from '@dynatrace-sdk/client-classic-environmen
|
|
|
8172
8232
|
### bulkMuteRemediationItems
|
|
8173
8233
|
|
|
8174
8234
|
<div class="padding-bottom--md">
|
|
8175
|
-
<strong>securityProblemsClient.bulkMuteRemediationItems(config): Promise<<a href="#remediationitemsbulkmuteresponse">RemediationItemsBulkMuteResponse</a>></strong>
|
|
8235
|
+
<strong>securityProblemsClient.bulkMuteRemediationItems(config): Promise<<a href="#remediationitemsbulkmuteresponse" target="_blank" rel="noopener noreferrer">RemediationItemsBulkMuteResponse</a>></strong>
|
|
8176
8236
|
|
|
8177
8237
|
<div class="padding-left--md">
|
|
8178
8238
|
|
|
@@ -8190,7 +8250,7 @@ Mutes several remediation items
|
|
|
8190
8250
|
|
|
8191
8251
|
| Name | Type | Description |
|
|
8192
8252
|
| --- | --- | --- |
|
|
8193
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkmute"
|
|
8253
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a>| |
|
|
8194
8254
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
8195
8255
|
|
|
8196
8256
|
|
|
@@ -8239,7 +8299,7 @@ const data =
|
|
|
8239
8299
|
### bulkMuteSecurityProblems
|
|
8240
8300
|
|
|
8241
8301
|
<div class="padding-bottom--md">
|
|
8242
|
-
<strong>securityProblemsClient.bulkMuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkmuteresponse">SecurityProblemsBulkMuteResponse</a>></strong>
|
|
8302
|
+
<strong>securityProblemsClient.bulkMuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkmuteresponse" target="_blank" rel="noopener noreferrer">SecurityProblemsBulkMuteResponse</a>></strong>
|
|
8243
8303
|
|
|
8244
8304
|
<div class="padding-left--md">
|
|
8245
8305
|
|
|
@@ -8257,7 +8317,7 @@ Mutes several security problems
|
|
|
8257
8317
|
|
|
8258
8318
|
| Name | Type |
|
|
8259
8319
|
| --- | --- |
|
|
8260
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkmute"
|
|
8320
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkmute">SecurityProblemsBulkMute</a>|
|
|
8261
8321
|
|
|
8262
8322
|
|
|
8263
8323
|
|
|
@@ -8304,7 +8364,7 @@ const data =
|
|
|
8304
8364
|
### bulkUnmuteRemediationItems
|
|
8305
8365
|
|
|
8306
8366
|
<div class="padding-bottom--md">
|
|
8307
|
-
<strong>securityProblemsClient.bulkUnmuteRemediationItems(config): Promise<<a href="#remediationitemsbulkunmuteresponse">RemediationItemsBulkUnmuteResponse</a>></strong>
|
|
8367
|
+
<strong>securityProblemsClient.bulkUnmuteRemediationItems(config): Promise<<a href="#remediationitemsbulkunmuteresponse" target="_blank" rel="noopener noreferrer">RemediationItemsBulkUnmuteResponse</a>></strong>
|
|
8308
8368
|
|
|
8309
8369
|
<div class="padding-left--md">
|
|
8310
8370
|
|
|
@@ -8322,7 +8382,7 @@ Un-mutes several remediation items
|
|
|
8322
8382
|
|
|
8323
8383
|
| Name | Type | Description |
|
|
8324
8384
|
| --- | --- | --- |
|
|
8325
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkunmute"
|
|
8385
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a>| |
|
|
8326
8386
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
8327
8387
|
|
|
8328
8388
|
|
|
@@ -8371,7 +8431,7 @@ const data =
|
|
|
8371
8431
|
### bulkUnmuteSecurityProblems
|
|
8372
8432
|
|
|
8373
8433
|
<div class="padding-bottom--md">
|
|
8374
|
-
<strong>securityProblemsClient.bulkUnmuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkunmuteresponse">SecurityProblemsBulkUnmuteResponse</a>></strong>
|
|
8434
|
+
<strong>securityProblemsClient.bulkUnmuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkunmuteresponse" target="_blank" rel="noopener noreferrer">SecurityProblemsBulkUnmuteResponse</a>></strong>
|
|
8375
8435
|
|
|
8376
8436
|
<div class="padding-left--md">
|
|
8377
8437
|
|
|
@@ -8389,7 +8449,7 @@ Un-mutes several security problems
|
|
|
8389
8449
|
|
|
8390
8450
|
| Name | Type |
|
|
8391
8451
|
| --- | --- |
|
|
8392
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkunmute"
|
|
8452
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkunmute">SecurityProblemsBulkUnmute</a>|
|
|
8393
8453
|
|
|
8394
8454
|
|
|
8395
8455
|
|
|
@@ -8436,7 +8496,7 @@ const data =
|
|
|
8436
8496
|
### getEventsForSecurityProblem
|
|
8437
8497
|
|
|
8438
8498
|
<div class="padding-bottom--md">
|
|
8439
|
-
<strong>securityProblemsClient.getEventsForSecurityProblem(config): Promise<<a href="#securityproblemeventslist">SecurityProblemEventsList</a>></strong>
|
|
8499
|
+
<strong>securityProblemsClient.getEventsForSecurityProblem(config): Promise<<a href="#securityproblemeventslist" target="_blank" rel="noopener noreferrer">SecurityProblemEventsList</a>></strong>
|
|
8440
8500
|
|
|
8441
8501
|
<div class="padding-left--md">
|
|
8442
8502
|
|
|
@@ -8502,7 +8562,7 @@ const data =
|
|
|
8502
8562
|
### getRemediationItem
|
|
8503
8563
|
|
|
8504
8564
|
<div class="padding-bottom--md">
|
|
8505
|
-
<strong>securityProblemsClient.getRemediationItem(config): Promise<<a href="#remediationdetailsitem"
|
|
8565
|
+
<strong>securityProblemsClient.getRemediationItem(config): Promise<<a href="#remediationdetailsitem">RemediationDetailsItem</a>></strong>
|
|
8506
8566
|
|
|
8507
8567
|
<div class="padding-left--md">
|
|
8508
8568
|
|
|
@@ -8568,7 +8628,7 @@ const data =
|
|
|
8568
8628
|
### getRemediationItems
|
|
8569
8629
|
|
|
8570
8630
|
<div class="padding-bottom--md">
|
|
8571
|
-
<strong>securityProblemsClient.getRemediationItems(config): Promise<<a href="#remediationitemlist">RemediationItemList</a>></strong>
|
|
8631
|
+
<strong>securityProblemsClient.getRemediationItems(config): Promise<<a href="#remediationitemlist" target="_blank" rel="noopener noreferrer">RemediationItemList</a>></strong>
|
|
8572
8632
|
|
|
8573
8633
|
<div class="padding-left--md">
|
|
8574
8634
|
|
|
@@ -8633,7 +8693,7 @@ const data =
|
|
|
8633
8693
|
### getRemediationProgressEntities
|
|
8634
8694
|
|
|
8635
8695
|
<div class="padding-bottom--md">
|
|
8636
|
-
<strong>securityProblemsClient.getRemediationProgressEntities(config): Promise<<a href="#remediationprogressentitylist"
|
|
8696
|
+
<strong>securityProblemsClient.getRemediationProgressEntities(config): Promise<<a href="#remediationprogressentitylist">RemediationProgressEntityList</a>></strong>
|
|
8637
8697
|
|
|
8638
8698
|
<div class="padding-left--md">
|
|
8639
8699
|
|
|
@@ -8699,7 +8759,7 @@ const data =
|
|
|
8699
8759
|
### getSecurityProblem
|
|
8700
8760
|
|
|
8701
8761
|
<div class="padding-bottom--md">
|
|
8702
|
-
<strong>securityProblemsClient.getSecurityProblem(config): Promise<<a href="#securityproblemdetails">SecurityProblemDetails</a>></strong>
|
|
8762
|
+
<strong>securityProblemsClient.getSecurityProblem(config): Promise<<a href="#securityproblemdetails" target="_blank" rel="noopener noreferrer">SecurityProblemDetails</a>></strong>
|
|
8703
8763
|
|
|
8704
8764
|
<div class="padding-left--md">
|
|
8705
8765
|
|
|
@@ -8766,7 +8826,7 @@ const data =
|
|
|
8766
8826
|
### getSecurityProblems
|
|
8767
8827
|
|
|
8768
8828
|
<div class="padding-bottom--md">
|
|
8769
|
-
<strong>securityProblemsClient.getSecurityProblems(config): Promise<<a href="#securityproblemlist"
|
|
8829
|
+
<strong>securityProblemsClient.getSecurityProblems(config): Promise<<a href="#securityproblemlist">SecurityProblemList</a>></strong>
|
|
8770
8830
|
|
|
8771
8831
|
<div class="padding-left--md">
|
|
8772
8832
|
|
|
@@ -8834,7 +8894,7 @@ const data =
|
|
|
8834
8894
|
### getVulnerableFunctions
|
|
8835
8895
|
|
|
8836
8896
|
<div class="padding-bottom--md">
|
|
8837
|
-
<strong>securityProblemsClient.getVulnerableFunctions(config): Promise<<a href="#vulnerablefunctionscontainer">VulnerableFunctionsContainer</a>></strong>
|
|
8897
|
+
<strong>securityProblemsClient.getVulnerableFunctions(config): Promise<<a href="#vulnerablefunctionscontainer" target="_blank" rel="noopener noreferrer">VulnerableFunctionsContainer</a>></strong>
|
|
8838
8898
|
|
|
8839
8899
|
<div class="padding-left--md">
|
|
8840
8900
|
|
|
@@ -8918,7 +8978,7 @@ Mutes a security problem
|
|
|
8918
8978
|
|
|
8919
8979
|
| Name | Type | Description |
|
|
8920
8980
|
| --- | --- | --- |
|
|
8921
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemmute"
|
|
8981
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemmute">SecurityProblemMute</a>| |
|
|
8922
8982
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
8923
8983
|
|
|
8924
8984
|
|
|
@@ -8983,7 +9043,7 @@ Sets the mute state of a remediation item
|
|
|
8983
9043
|
|
|
8984
9044
|
| Name | Type | Description |
|
|
8985
9045
|
| --- | --- | --- |
|
|
8986
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a>| |
|
|
9046
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemmutestatechange" target="_blank" rel="noopener noreferrer">RemediationItemMuteStateChange</a>| |
|
|
8987
9047
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
8988
9048
|
|config.remediationItemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation item. |
|
|
8989
9049
|
|
|
@@ -9054,7 +9114,7 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
|
|
|
9054
9114
|
|
|
9055
9115
|
| Name | Type | Description |
|
|
9056
9116
|
| --- | --- | --- |
|
|
9057
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkupdatedeletedto"
|
|
9117
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a>| |
|
|
9058
9118
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
9059
9119
|
|
|
9060
9120
|
|
|
@@ -9117,7 +9177,7 @@ Un-mutes a security problem
|
|
|
9117
9177
|
|
|
9118
9178
|
| Name | Type | Description |
|
|
9119
9179
|
| --- | --- | --- |
|
|
9120
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemunmute">SecurityProblemUnmute</a>| |
|
|
9180
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemunmute" target="_blank" rel="noopener noreferrer">SecurityProblemUnmute</a>| |
|
|
9121
9181
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
9122
9182
|
|
|
9123
9183
|
|
|
@@ -9170,7 +9230,7 @@ import { serviceLevelObjectivesClient } from '@dynatrace-sdk/client-classic-envi
|
|
|
9170
9230
|
### createAlert
|
|
9171
9231
|
|
|
9172
9232
|
<div class="padding-bottom--md">
|
|
9173
|
-
<strong>serviceLevelObjectivesClient.createAlert(config): Promise<<a href="#entityshortrepresentation"
|
|
9233
|
+
<strong>serviceLevelObjectivesClient.createAlert(config): Promise<<a href="#entityshortrepresentation">EntityShortRepresentation</a>></strong>
|
|
9174
9234
|
|
|
9175
9235
|
<div class="padding-left--md">
|
|
9176
9236
|
|
|
@@ -9190,7 +9250,7 @@ Creates an alert of the provided alert type for an SLO
|
|
|
9190
9250
|
|
|
9191
9251
|
| Name | Type | Description |
|
|
9192
9252
|
| --- | --- | --- |
|
|
9193
|
-
|config.body<sup>*required</sup>|<a href="#abstractsloalertdto">AbstractSloAlertDto</a>| |
|
|
9253
|
+
|config.body<sup>*required</sup>|<a href="#abstractsloalertdto" target="_blank" rel="noopener noreferrer">AbstractSloAlertDto</a>| |
|
|
9194
9254
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
9195
9255
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
9196
9256
|
|config.timeFrame|"CURRENT" | "GTF"|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> |
|
|
@@ -9264,7 +9324,7 @@ Creates a new SLO
|
|
|
9264
9324
|
|
|
9265
9325
|
| Name | Type |
|
|
9266
9326
|
| --- | --- |
|
|
9267
|
-
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl"
|
|
9327
|
+
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a>|
|
|
9268
9328
|
|
|
9269
9329
|
|
|
9270
9330
|
|
|
@@ -9376,7 +9436,7 @@ const data = await serviceLevelObjectivesClient.deleteSlo({
|
|
|
9376
9436
|
### getSlo
|
|
9377
9437
|
|
|
9378
9438
|
<div class="padding-bottom--md">
|
|
9379
|
-
<strong>serviceLevelObjectivesClient.getSlo(config): Promise<<a href="#slos">SLOs</a>></strong>
|
|
9439
|
+
<strong>serviceLevelObjectivesClient.getSlo(config): Promise<<a href="#slos" target="_blank" rel="noopener noreferrer">SLOs</a>></strong>
|
|
9380
9440
|
|
|
9381
9441
|
<div class="padding-left--md">
|
|
9382
9442
|
|
|
@@ -9454,7 +9514,7 @@ const data = await serviceLevelObjectivesClient.getSlo();
|
|
|
9454
9514
|
### getSloById
|
|
9455
9515
|
|
|
9456
9516
|
<div class="padding-bottom--md">
|
|
9457
|
-
<strong>serviceLevelObjectivesClient.getSloById(config): Promise<<a href="#slo"
|
|
9517
|
+
<strong>serviceLevelObjectivesClient.getSloById(config): Promise<<a href="#slo">SLO</a>></strong>
|
|
9458
9518
|
|
|
9459
9519
|
<div class="padding-left--md">
|
|
9460
9520
|
|
|
@@ -9544,7 +9604,7 @@ Updates an existing SLO
|
|
|
9544
9604
|
|
|
9545
9605
|
| Name | Type | Description |
|
|
9546
9606
|
| --- | --- | --- |
|
|
9547
|
-
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a>| |
|
|
9607
|
+
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl" target="_blank" rel="noopener noreferrer">SloConfigItemDtoImpl</a>| |
|
|
9548
9608
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
9549
9609
|
|
|
9550
9610
|
|
|
@@ -9602,7 +9662,7 @@ import { settingsManagementZonesClient } from '@dynatrace-sdk/client-classic-env
|
|
|
9602
9662
|
### getManagementZoneDetails
|
|
9603
9663
|
|
|
9604
9664
|
<div class="padding-bottom--md">
|
|
9605
|
-
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails"
|
|
9665
|
+
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails">ManagementZoneDetails</a>></strong>
|
|
9606
9666
|
|
|
9607
9667
|
<div class="padding-left--md">
|
|
9608
9668
|
|
|
@@ -9676,7 +9736,7 @@ import { settingsObjectsClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
9676
9736
|
### addPermission
|
|
9677
9737
|
|
|
9678
9738
|
<div class="padding-bottom--md">
|
|
9679
|
-
<strong>settingsObjectsClient.addPermission(config): Promise<<a href="#accessorpermissions">AccessorPermissions</a>></strong>
|
|
9739
|
+
<strong>settingsObjectsClient.addPermission(config): Promise<<a href="#accessorpermissions" target="_blank" rel="noopener noreferrer">AccessorPermissions</a>></strong>
|
|
9680
9740
|
|
|
9681
9741
|
<div class="padding-left--md">
|
|
9682
9742
|
|
|
@@ -9697,7 +9757,7 @@ Add the permissions for a single accessor on this object, anyone with read/write
|
|
|
9697
9757
|
| Name | Type | Description |
|
|
9698
9758
|
| --- | --- | --- |
|
|
9699
9759
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
9700
|
-
|config.body<sup>*required</sup>|<a href="#accessorpermissions"
|
|
9760
|
+
|config.body<sup>*required</sup>|<a href="#accessorpermissions">AccessorPermissions</a>| |
|
|
9701
9761
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
9702
9762
|
|
|
9703
9763
|
|
|
@@ -9809,7 +9869,7 @@ const data =
|
|
|
9809
9869
|
### getEffectiveSettingsValues
|
|
9810
9870
|
|
|
9811
9871
|
<div class="padding-bottom--md">
|
|
9812
|
-
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist">EffectiveSettingsValuesList</a>></strong>
|
|
9872
|
+
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist" target="_blank" rel="noopener noreferrer">EffectiveSettingsValuesList</a>></strong>
|
|
9813
9873
|
|
|
9814
9874
|
<div class="padding-left--md">
|
|
9815
9875
|
|
|
@@ -9886,7 +9946,7 @@ const data =
|
|
|
9886
9946
|
### getPermission
|
|
9887
9947
|
|
|
9888
9948
|
<div class="padding-bottom--md">
|
|
9889
|
-
<strong>settingsObjectsClient.getPermission(config): Promise<<a href="#accessorpermissions"
|
|
9949
|
+
<strong>settingsObjectsClient.getPermission(config): Promise<<a href="#accessorpermissions">AccessorPermissions</a>></strong>
|
|
9890
9950
|
|
|
9891
9951
|
<div class="padding-left--md">
|
|
9892
9952
|
|
|
@@ -9954,7 +10014,7 @@ const data = await settingsObjectsClient.getPermission({
|
|
|
9954
10014
|
### getPermissionAllUsers
|
|
9955
10015
|
|
|
9956
10016
|
<div class="padding-bottom--md">
|
|
9957
|
-
<strong>settingsObjectsClient.getPermissionAllUsers(config): Promise<<a href="#accessorpermissions">AccessorPermissions</a>></strong>
|
|
10017
|
+
<strong>settingsObjectsClient.getPermissionAllUsers(config): Promise<<a href="#accessorpermissions" target="_blank" rel="noopener noreferrer">AccessorPermissions</a>></strong>
|
|
9958
10018
|
|
|
9959
10019
|
<div class="padding-left--md">
|
|
9960
10020
|
|
|
@@ -10019,7 +10079,7 @@ const data =
|
|
|
10019
10079
|
### getPermissions
|
|
10020
10080
|
|
|
10021
10081
|
<div class="padding-bottom--md">
|
|
10022
|
-
<strong>settingsObjectsClient.getPermissions(config): Promise<<a href="#accessorpermissionslist"
|
|
10082
|
+
<strong>settingsObjectsClient.getPermissions(config): Promise<<a href="#accessorpermissionslist">AccessorPermissionsList</a>></strong>
|
|
10023
10083
|
|
|
10024
10084
|
<div class="padding-left--md">
|
|
10025
10085
|
|
|
@@ -10083,7 +10143,7 @@ const data = await settingsObjectsClient.getPermissions({
|
|
|
10083
10143
|
### getSettingsHistory
|
|
10084
10144
|
|
|
10085
10145
|
<div class="padding-bottom--md">
|
|
10086
|
-
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage">RevisionDiffPage</a>></strong>
|
|
10146
|
+
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage" target="_blank" rel="noopener noreferrer">RevisionDiffPage</a>></strong>
|
|
10087
10147
|
|
|
10088
10148
|
<div class="padding-left--md">
|
|
10089
10149
|
|
|
@@ -10108,7 +10168,7 @@ Gets the history of settings objects
|
|
|
10108
10168
|
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Filtering is supported on the following fields:</p> <ul> <li><code>objectId</code></li> <li><code>modificationInfo.lastModifiedTime</code></li> </ul> <p>The fields can only be combined with <code>and</code> as a boolean operator. If this parameter is omitted only revisions of the last 2 weeks are returned. If <strong>modificationInfo.lastModifiedTime</strong> does not specify a full range, it will be completed with current time minus 1 year for the missing lower bound or the current time for the upper bound. (optional)</p> |
|
|
10109
10169
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
10110
10170
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
10111
|
-
|config.schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)
|
|
10171
|
+
|config.schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Schema ID to which the requested revisions belong.</p> <p>In the Dynatrace Platform, this parameter accepts multiple schema IDs separated with commas. In Dynatrace Managed and in SaaS Environments not connected to the Dynatrace Platform, this parameter accepts only a single schema ID, not multiple ones.</p> |
|
|
10112
10172
|
|config.scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The scope that the requested history objects target.</p> <p>The selection only matches revisions directly targeting the specified scope. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p> |
|
|
10113
10173
|
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Sorting is supported on the following fields:</p> <ul> <li><code>modificationInfo.lastModifiedTime</code> (optional, default to -modificationInfo.lastModifiedTime)</li> </ul> |
|
|
10114
10174
|
|
|
@@ -10126,7 +10186,7 @@ Gets the history of settings objects
|
|
|
10126
10186
|
|
|
10127
10187
|
| Error Type | Error Message |
|
|
10128
10188
|
|---|---|
|
|
10129
|
-
|ErrorEnvelopeError|Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.|
|
|
10189
|
+
|ErrorEnvelopeError|Failed. schemaId contains multiple schemaIds and request was for not for Dynatrace Platform. | Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.|
|
|
10130
10190
|
|
|
10131
10191
|
|
|
10132
10192
|
<details>
|
|
@@ -10152,7 +10212,7 @@ const data =
|
|
|
10152
10212
|
### getSettingsObjectByObjectId
|
|
10153
10213
|
|
|
10154
10214
|
<div class="padding-bottom--md">
|
|
10155
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse"
|
|
10215
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse">SettingsObjectByObjectIdResponse</a>></strong>
|
|
10156
10216
|
|
|
10157
10217
|
<div class="padding-left--md">
|
|
10158
10218
|
|
|
@@ -10217,7 +10277,7 @@ const data =
|
|
|
10217
10277
|
### getSettingsObjects
|
|
10218
10278
|
|
|
10219
10279
|
<div class="padding-bottom--md">
|
|
10220
|
-
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist">ObjectsList</a>></strong>
|
|
10280
|
+
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist" target="_blank" rel="noopener noreferrer">ObjectsList</a>></strong>
|
|
10221
10281
|
|
|
10222
10282
|
<div class="padding-left--md">
|
|
10223
10283
|
|
|
@@ -10297,7 +10357,7 @@ const data =
|
|
|
10297
10357
|
### postSettingsObjects
|
|
10298
10358
|
|
|
10299
10359
|
<div class="padding-bottom--md">
|
|
10300
|
-
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse"
|
|
10360
|
+
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse">SettingsObjectResponse</a>>></strong>
|
|
10301
10361
|
|
|
10302
10362
|
<div class="padding-left--md">
|
|
10303
10363
|
|
|
@@ -10322,7 +10382,7 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
10322
10382
|
| Name | Type | Description |
|
|
10323
10383
|
| --- | --- | --- |
|
|
10324
10384
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10325
|
-
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>>| |
|
|
10385
|
+
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate" target="_blank" rel="noopener noreferrer">SettingsObjectCreate</a>>| |
|
|
10326
10386
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. |
|
|
10327
10387
|
|
|
10328
10388
|
|
|
@@ -10376,7 +10436,7 @@ const data =
|
|
|
10376
10436
|
### putSettingsObjectByObjectId
|
|
10377
10437
|
|
|
10378
10438
|
<div class="padding-bottom--md">
|
|
10379
|
-
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse"
|
|
10439
|
+
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse">SettingsObjectResponse</a>></strong>
|
|
10380
10440
|
|
|
10381
10441
|
<div class="padding-left--md">
|
|
10382
10442
|
|
|
@@ -10403,7 +10463,7 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
10403
10463
|
| Name | Type | Description |
|
|
10404
10464
|
| --- | --- | --- |
|
|
10405
10465
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10406
|
-
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate">SettingsObjectUpdate</a>| |
|
|
10466
|
+
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate" target="_blank" rel="noopener noreferrer">SettingsObjectUpdate</a>| |
|
|
10407
10467
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10408
10468
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings object, without saving it. |
|
|
10409
10469
|
|
|
@@ -10584,7 +10644,7 @@ const data =
|
|
|
10584
10644
|
### resolveEffectivePermissions
|
|
10585
10645
|
|
|
10586
10646
|
<div class="padding-bottom--md">
|
|
10587
|
-
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission"
|
|
10647
|
+
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission">EffectivePermission</a>>></strong>
|
|
10588
10648
|
|
|
10589
10649
|
<div class="padding-left--md">
|
|
10590
10650
|
|
|
@@ -10609,7 +10669,7 @@ Get the effective settings permissions of the calling user in the environment
|
|
|
10609
10669
|
|
|
10610
10670
|
| Name | Type |
|
|
10611
10671
|
| --- | --- |
|
|
10612
|
-
|config.body<sup>*required</sup>|<a href="#resolutionrequest">ResolutionRequest</a>|
|
|
10672
|
+
|config.body<sup>*required</sup>|<a href="#resolutionrequest" target="_blank" rel="noopener noreferrer">ResolutionRequest</a>|
|
|
10613
10673
|
|
|
10614
10674
|
|
|
10615
10675
|
|
|
@@ -10684,7 +10744,7 @@ Transfer ownership of the object, only the owner or the main admin is allowed to
|
|
|
10684
10744
|
| Name | Type | Description |
|
|
10685
10745
|
| --- | --- | --- |
|
|
10686
10746
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10687
|
-
|config.body<sup>*required</sup>|<a href="#transferownershiprequest"
|
|
10747
|
+
|config.body<sup>*required</sup>|<a href="#transferownershiprequest">TransferOwnershipRequest</a>| |
|
|
10688
10748
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10689
10749
|
|
|
10690
10750
|
|
|
@@ -10752,7 +10812,7 @@ Update the permissions for an existing accessor on this object, anyone with read
|
|
|
10752
10812
|
|config.accessorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user uuid or group uuid of the accessor, depending on the type. |
|
|
10753
10813
|
|config.accessorType<sup>*required</sup>|"group" | "user"|The type of the accessor. |
|
|
10754
10814
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10755
|
-
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest">UpdatePermissionsRequest</a>| |
|
|
10815
|
+
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest" target="_blank" rel="noopener noreferrer">UpdatePermissionsRequest</a>| |
|
|
10756
10816
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10757
10817
|
|
|
10758
10818
|
|
|
@@ -10820,7 +10880,7 @@ Update the permissions for an existing all-users accessor on this object, anyone
|
|
|
10820
10880
|
| Name | Type | Description |
|
|
10821
10881
|
| --- | --- | --- |
|
|
10822
10882
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10823
|
-
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest"
|
|
10883
|
+
|config.body<sup>*required</sup>|<a href="#updatepermissionsrequest">UpdatePermissionsRequest</a>| |
|
|
10824
10884
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
10825
10885
|
|
|
10826
10886
|
|
|
@@ -10872,7 +10932,7 @@ import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
10872
10932
|
### getAvailableSchemaDefinitions
|
|
10873
10933
|
|
|
10874
10934
|
<div class="padding-bottom--md">
|
|
10875
|
-
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist">SchemaList</a>></strong>
|
|
10935
|
+
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist" target="_blank" rel="noopener noreferrer">SchemaList</a>></strong>
|
|
10876
10936
|
|
|
10877
10937
|
<div class="padding-left--md">
|
|
10878
10938
|
|
|
@@ -10934,7 +10994,7 @@ const data =
|
|
|
10934
10994
|
### getSchemaDefinition
|
|
10935
10995
|
|
|
10936
10996
|
<div class="padding-bottom--md">
|
|
10937
|
-
<strong>settingsSchemasClient.getSchemaDefinition(config): Promise<<a href="#schemadefinitionrestdto"
|
|
10997
|
+
<strong>settingsSchemasClient.getSchemaDefinition(config): Promise<<a href="#schemadefinitionrestdto">SchemaDefinitionRestDto</a>></strong>
|
|
10938
10998
|
|
|
10939
10999
|
<div class="padding-left--md">
|
|
10940
11000
|
|
|
@@ -11005,7 +11065,7 @@ import { syntheticHttpMonitorExecutionsClient } from '@dynatrace-sdk/client-clas
|
|
|
11005
11065
|
### getExecutionResult
|
|
11006
11066
|
|
|
11007
11067
|
<div class="padding-bottom--md">
|
|
11008
|
-
<strong>syntheticHttpMonitorExecutionsClient.getExecutionResult(config): Promise<<a href="#monitorexecutionresults">MonitorExecutionResults</a>></strong>
|
|
11068
|
+
<strong>syntheticHttpMonitorExecutionsClient.getExecutionResult(config): Promise<<a href="#monitorexecutionresults" target="_blank" rel="noopener noreferrer">MonitorExecutionResults</a>></strong>
|
|
11009
11069
|
|
|
11010
11070
|
<div class="padding-left--md">
|
|
11011
11071
|
|
|
@@ -11075,7 +11135,7 @@ import { syntheticLocationsNodesAndConfigurationClient } from '@dynatrace-sdk/cl
|
|
|
11075
11135
|
### addLocation
|
|
11076
11136
|
|
|
11077
11137
|
<div class="padding-bottom--md">
|
|
11078
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.addLocation(config): Promise<<a href="#syntheticlocationidsdto"
|
|
11138
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.addLocation(config): Promise<<a href="#syntheticlocationidsdto">SyntheticLocationIdsDto</a>></strong>
|
|
11079
11139
|
|
|
11080
11140
|
<div class="padding-left--md">
|
|
11081
11141
|
|
|
@@ -11093,7 +11153,7 @@ Creates a new private synthetic location
|
|
|
11093
11153
|
|
|
11094
11154
|
| Name | Type |
|
|
11095
11155
|
| --- | --- |
|
|
11096
|
-
|config.body<sup>*required</sup>|<a href="#privatesyntheticlocation">PrivateSyntheticLocation</a>|
|
|
11156
|
+
|config.body<sup>*required</sup>|<a href="#privatesyntheticlocation" target="_blank" rel="noopener noreferrer">PrivateSyntheticLocation</a>|
|
|
11097
11157
|
|
|
11098
11158
|
|
|
11099
11159
|
|
|
@@ -11145,7 +11205,7 @@ const data =
|
|
|
11145
11205
|
### getConfiguration
|
|
11146
11206
|
|
|
11147
11207
|
<div class="padding-bottom--md">
|
|
11148
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getConfiguration(config): Promise<<a href="#syntheticconfigdto"
|
|
11208
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getConfiguration(config): Promise<<a href="#syntheticconfigdto">SyntheticConfigDto</a>></strong>
|
|
11149
11209
|
|
|
11150
11210
|
<div class="padding-left--md">
|
|
11151
11211
|
|
|
@@ -11197,7 +11257,7 @@ const data =
|
|
|
11197
11257
|
### getLocation
|
|
11198
11258
|
|
|
11199
11259
|
<div class="padding-bottom--md">
|
|
11200
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocation(config): Promise<<a href="#privatesyntheticlocation">PrivateSyntheticLocation</a> | <a href="#syntheticlocation"
|
|
11260
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocation(config): Promise<<a href="#privatesyntheticlocation" target="_blank" rel="noopener noreferrer">PrivateSyntheticLocation</a> | <a href="#syntheticlocation">SyntheticLocation</a>></strong>
|
|
11201
11261
|
|
|
11202
11262
|
<div class="padding-left--md">
|
|
11203
11263
|
|
|
@@ -11278,8 +11338,10 @@ Gets list of commands to deploy synthetic location in Kubernetes/Openshift clust
|
|
|
11278
11338
|
| Name | Type | Description |
|
|
11279
11339
|
| --- | --- | --- |
|
|
11280
11340
|
|config.filename|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filename |
|
|
11341
|
+
|config.fipsMode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Fips mode, accepted values are: DISABLED, ENABLED, ENABLED_WITH_CORPORATE_PROXY. Default value is DISABLED. |
|
|
11281
11342
|
|config.namespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Namespace |
|
|
11282
11343
|
|config.platform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
|
|
11344
|
+
|config.squidProxyConfig|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional configuration for Squid corporate proxy. If not provided the default value will be used. |
|
|
11283
11345
|
|
|
11284
11346
|
|
|
11285
11347
|
|
|
@@ -11453,7 +11515,7 @@ const data =
|
|
|
11453
11515
|
### getLocations
|
|
11454
11516
|
|
|
11455
11517
|
<div class="padding-bottom--md">
|
|
11456
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocations(config): Promise<<a href="#syntheticlocations">SyntheticLocations</a>></strong>
|
|
11518
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocations(config): Promise<<a href="#syntheticlocations" target="_blank" rel="noopener noreferrer">SyntheticLocations</a>></strong>
|
|
11457
11519
|
|
|
11458
11520
|
<div class="padding-left--md">
|
|
11459
11521
|
|
|
@@ -11515,7 +11577,7 @@ const data =
|
|
|
11515
11577
|
### getLocationsStatus
|
|
11516
11578
|
|
|
11517
11579
|
<div class="padding-bottom--md">
|
|
11518
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationsStatus(config): Promise<<a href="#syntheticpubliclocationsstatus"
|
|
11580
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationsStatus(config): Promise<<a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a>></strong>
|
|
11519
11581
|
|
|
11520
11582
|
<div class="padding-left--md">
|
|
11521
11583
|
|
|
@@ -11567,7 +11629,7 @@ const data =
|
|
|
11567
11629
|
### getNode
|
|
11568
11630
|
|
|
11569
11631
|
<div class="padding-bottom--md">
|
|
11570
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getNode(config): Promise<<a href="#node">Node</a>></strong>
|
|
11632
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getNode(config): Promise<<a href="#node" target="_blank" rel="noopener noreferrer">Node</a>></strong>
|
|
11571
11633
|
|
|
11572
11634
|
<div class="padding-left--md">
|
|
11573
11635
|
|
|
@@ -11629,7 +11691,7 @@ const data =
|
|
|
11629
11691
|
### getNodes
|
|
11630
11692
|
|
|
11631
11693
|
<div class="padding-bottom--md">
|
|
11632
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getNodes(config): Promise<<a href="#nodes"
|
|
11694
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getNodes(config): Promise<<a href="#nodes">Nodes</a>></strong>
|
|
11633
11695
|
|
|
11634
11696
|
<div class="padding-left--md">
|
|
11635
11697
|
|
|
@@ -11752,7 +11814,7 @@ const data =
|
|
|
11752
11814
|
### updateConfiguration
|
|
11753
11815
|
|
|
11754
11816
|
<div class="padding-bottom--md">
|
|
11755
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<<a href="#syntheticconfigdto">SyntheticConfigDto</a>></strong>
|
|
11817
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<<a href="#syntheticconfigdto" target="_blank" rel="noopener noreferrer">SyntheticConfigDto</a>></strong>
|
|
11756
11818
|
|
|
11757
11819
|
<div class="padding-left--md">
|
|
11758
11820
|
|
|
@@ -11770,7 +11832,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
11770
11832
|
|
|
11771
11833
|
| Name | Type |
|
|
11772
11834
|
| --- | --- |
|
|
11773
|
-
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto"
|
|
11835
|
+
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto">SyntheticConfigDto</a>|
|
|
11774
11836
|
|
|
11775
11837
|
|
|
11776
11838
|
|
|
@@ -11834,7 +11896,7 @@ For public locations you can only change the location status.
|
|
|
11834
11896
|
|
|
11835
11897
|
| Name | Type | Description |
|
|
11836
11898
|
| --- | --- | --- |
|
|
11837
|
-
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate">SyntheticLocationUpdate</a>| |
|
|
11899
|
+
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate" target="_blank" rel="noopener noreferrer">SyntheticLocationUpdate</a>| |
|
|
11838
11900
|
|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the synthetic location to be updated. |
|
|
11839
11901
|
|
|
11840
11902
|
|
|
@@ -11897,7 +11959,7 @@ Changes the status of public synthetic locations
|
|
|
11897
11959
|
|
|
11898
11960
|
| Name | Type |
|
|
11899
11961
|
| --- | --- |
|
|
11900
|
-
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus"
|
|
11962
|
+
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a>|
|
|
11901
11963
|
|
|
11902
11964
|
|
|
11903
11965
|
|
|
@@ -11947,7 +12009,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
11947
12009
|
### createMonitor
|
|
11948
12010
|
|
|
11949
12011
|
<div class="padding-bottom--md">
|
|
11950
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto">MonitorEntityIdDto</a>></strong>
|
|
12012
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto" target="_blank" rel="noopener noreferrer">MonitorEntityIdDto</a>></strong>
|
|
11951
12013
|
|
|
11952
12014
|
<div class="padding-left--md">
|
|
11953
12015
|
|
|
@@ -11965,7 +12027,7 @@ Creates a synthetic monitor definition. Currently network availability monitors
|
|
|
11965
12027
|
|
|
11966
12028
|
| Name | Type |
|
|
11967
12029
|
| --- | --- |
|
|
11968
|
-
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorRequest</a>|
|
|
12030
|
+
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest">SyntheticBrowserMonitorRequest</a> | <a href="#syntheticmultiprotocolmonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorRequest</a>|
|
|
11969
12031
|
|
|
11970
12032
|
|
|
11971
12033
|
|
|
@@ -12071,7 +12133,7 @@ const data =
|
|
|
12071
12133
|
### getMonitor
|
|
12072
12134
|
|
|
12073
12135
|
<div class="padding-bottom--md">
|
|
12074
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticmultiprotocolmonitorresponse">SyntheticMultiProtocolMonitorResponse</a>></strong>
|
|
12136
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticbrowsermonitorresponse">SyntheticBrowserMonitorResponse</a> | <a href="#syntheticmultiprotocolmonitorresponse" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorResponse</a>></strong>
|
|
12075
12137
|
|
|
12076
12138
|
<div class="padding-left--md">
|
|
12077
12139
|
|
|
@@ -12098,7 +12160,7 @@ Gets a synthetic monitor definition for the given monitor ID. Currently network
|
|
|
12098
12160
|
|
|
12099
12161
|
| Return type | Status code | Description |
|
|
12100
12162
|
|---|---|---|
|
|
12101
|
-
|[
|
|
12163
|
+
|[SyntheticBrowserMonitorResponse](#syntheticbrowsermonitorresponse)|200|Success|
|
|
12102
12164
|
|
|
12103
12165
|
|
|
12104
12166
|
#### Throws
|
|
@@ -12133,7 +12195,7 @@ const data =
|
|
|
12133
12195
|
### getMonitors
|
|
12134
12196
|
|
|
12135
12197
|
<div class="padding-bottom--md">
|
|
12136
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto"
|
|
12198
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto">SyntheticMonitorListDto</a>></strong>
|
|
12137
12199
|
|
|
12138
12200
|
<div class="padding-left--md">
|
|
12139
12201
|
|
|
@@ -12211,7 +12273,7 @@ Updates a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
12211
12273
|
|
|
12212
12274
|
| Name | Type | Description |
|
|
12213
12275
|
| --- | --- | --- |
|
|
12214
|
-
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorrequest">SyntheticMultiProtocolMonitorRequest</a>| |
|
|
12276
|
+
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorRequest</a> | <a href="#syntheticmultiprotocolmonitorrequest">SyntheticMultiProtocolMonitorRequest</a>| |
|
|
12215
12277
|
|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
12216
12278
|
|
|
12217
12279
|
|
|
@@ -13092,7 +13154,7 @@ Metadata for an extension asset.
|
|
|
13092
13154
|
|assetSchemaDetails|<a href="#assetschemadetailsdto" target="_blank" rel="noopener noreferrer">AssetSchemaDetailsDto</a>|Settings schema details for asset |
|
|
13093
13155
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-friendly name of the asset. |
|
|
13094
13156
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ID of the asset. Identifies the asset in REST API and/or UI (where applicable). |
|
|
13095
|
-
|type|"ALERT" | "ALERT_TEMPLATE" | "AWS_SERVICE" | "CUSTOM_CARDS" | "DASHBOARD" | "DECLARATIVE_PROCESSES" | "DOCUMENT_DASHBOARD" | "DQL_LOG_METRIC" | "DQL_LOG_PROCESSING_RULE" | "GENERIC_RELATIONSHIP" | "GENERIC_TYPE" | "LIST_SCREEN_FILTERS" | "LIST_SCREEN_INJECTIONS" | "LIST_SCREEN_LAYOUT" | "LOG_EVENT" | "LOG_METRIC" | "LOG_PROCESSING_RULE" | "LQL_LOG_METRIC" | "LQL_LOG_PROCESSING_RULE" | "METRIC_METADATA" | "METRIC_QUERY" | "PROCESS_GROUPING_RULES" | "SCREEN_ACTIONS" | "SCREEN_CHART_GROUPS" | "SCREEN_DQL_TABLE" | "SCREEN_ENTITIES_LISTS" | "SCREEN_EVENTS_CARDS" | "SCREEN_FILTERS" | "SCREEN_HEALTH_CARDS" | "SCREEN_INJECTIONS" | "SCREEN_LAYOUT" | "SCREEN_LOGS_CARDS" | "SCREEN_MESSAGE_CARDS" | "SCREEN_METRIC_TABLES" | "SCREEN_PROBLEMS" | "SCREEN_PROPERTIES"|The type of the asset. |
|
|
13157
|
+
|type|"ALERT" | "ALERT_TEMPLATE" | "AWS_SERVICE" | "CUSTOM_CARDS" | "DASHBOARD" | "DECLARATIVE_PROCESSES" | "DOCUMENT_DASHBOARD" | "DQL_LOG_METRIC" | "DQL_LOG_PROCESSING_RULE" | "GENERIC_RELATIONSHIP" | "GENERIC_TYPE" | "LIST_SCREEN_FILTERS" | "LIST_SCREEN_INJECTIONS" | "LIST_SCREEN_LAYOUT" | "LOG_EVENT" | "LOG_METRIC" | "LOG_PROCESSING_RULE" | "LQL_LOG_METRIC" | "LQL_LOG_PROCESSING_RULE" | "METRIC_METADATA" | "METRIC_QUERY" | "OPEN_PIPELINE" | "PROCESS_GROUPING_RULES" | "SCREEN_ACTIONS" | "SCREEN_CHART_GROUPS" | "SCREEN_DQL_TABLE" | "SCREEN_ENTITIES_LISTS" | "SCREEN_EVENTS_CARDS" | "SCREEN_FILTERS" | "SCREEN_HEALTH_CARDS" | "SCREEN_INJECTIONS" | "SCREEN_LAYOUT" | "SCREEN_LOGS_CARDS" | "SCREEN_MESSAGE_CARDS" | "SCREEN_METRIC_TABLES" | "SCREEN_PROBLEMS" | "SCREEN_PROPERTIES"|The type of the asset. |
|
|
13096
13158
|
|
|
13097
13159
|
### AssetSchemaDetailsDto
|
|
13098
13160
|
|
|
@@ -13248,6 +13310,17 @@ An entry of the audit log.
|
|
|
13248
13310
|
|userOrigin|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The origin and the IP address of the <strong>user</strong>. |
|
|
13249
13311
|
|userType<sup>*required</sup>|"PUBLIC_TOKEN_IDENTIFIER" | "SERVICE_NAME" | "TOKEN_HASH" | "USER_NAME"|<p>The type of the authentication of the <strong>user</strong>.</p> <ul> <li><code>USER_NAME</code> -> User was logged in the UI</li> <li><code>TOKEN_HASH</code> -> URL Token or DevOps Token, the hash of the token is logged</li> <li><code>SERVICE_NAME</code> -> No authenticated user at all, this action was performed by a system service automatically</li> <li><code>PUBLIC_TOKEN_IDENTIFIER</code> -> API Token, the public token id is logged</li> </ul> |
|
|
13250
13312
|
|
|
13313
|
+
### AuthenticationDto
|
|
13314
|
+
|
|
13315
|
+
Authentication dto for Browser Monitor step.
|
|
13316
|
+
|
|
13317
|
+
| Name | Type | Description |
|
|
13318
|
+
| --- | --- | --- |
|
|
13319
|
+
|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
13320
|
+
|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
13321
|
+
|inputType<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureAuthenticationDto</li> <li><code>PLAIN</code> -> PlainAuthenticationDto</li> </ul> |
|
|
13322
|
+
|type<sup>*required</sup>|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |
|
|
13323
|
+
|
|
13251
13324
|
### AuthorDto
|
|
13252
13325
|
|
|
13253
13326
|
Extension author
|
|
@@ -13354,6 +13427,14 @@ Contains detailed information about Browser monitor action.
|
|
|
13354
13427
|
|userActionPropertyCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of properties in the action. |
|
|
13355
13428
|
|visuallyCompleteTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of time until the page is visually complete, in milliseconds. |
|
|
13356
13429
|
|
|
13430
|
+
### BaseWaitConditionDto
|
|
13431
|
+
|
|
13432
|
+
Wait condition for Browser Monitor step.
|
|
13433
|
+
|
|
13434
|
+
| Name | Type | Description |
|
|
13435
|
+
| --- | --- | --- |
|
|
13436
|
+
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
13437
|
+
|
|
13357
13438
|
### BizEventIngestError
|
|
13358
13439
|
|
|
13359
13440
|
| Name | Type |
|
|
@@ -13371,6 +13452,17 @@ Result received after ingesting business events.
|
|
|
13371
13452
|
| --- | --- | --- |
|
|
13372
13453
|
|errors|Array<<a href="#bizeventingesterror" target="_blank" rel="noopener noreferrer">BizEventIngestError</a>>|A list of business events ingest errors. |
|
|
13373
13454
|
|
|
13455
|
+
### BrowserPermissionsDto
|
|
13456
|
+
|
|
13457
|
+
Permissions settings for browser.
|
|
13458
|
+
|
|
13459
|
+
| Name | Type | Description |
|
|
13460
|
+
| --- | --- | --- |
|
|
13461
|
+
|camera|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Camera permission. If not defined in request, it will be set to false by default. |
|
|
13462
|
+
|location|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Location permission. If not defined in request, it will be set to false by default. |
|
|
13463
|
+
|microphone|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Microphone permission. If not defined in request, it will be set to false by default. |
|
|
13464
|
+
|notifications|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Notifications permission. If not defined in request, it will be set to false by default. |
|
|
13465
|
+
|
|
13374
13466
|
### BurnRateAlert
|
|
13375
13467
|
|
|
13376
13468
|
Parameters of an error budget burn rate alert.
|
|
@@ -13400,6 +13492,37 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
13400
13492
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
13401
13493
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
13402
13494
|
|
|
13495
|
+
### ChromiumStartupFlagsDto
|
|
13496
|
+
|
|
13497
|
+
Chromium startup flags of a Browser Monitor.
|
|
13498
|
+
|
|
13499
|
+
| Name | Type | Description |
|
|
13500
|
+
| --- | --- | --- |
|
|
13501
|
+
|autoplay-policy|"no-user-gesture-required" | "document-user-activation-required"|autoplay-policy type. |
|
|
13502
|
+
|disable-features|<a href="#chromiumstartupflagsdtodisablefeatures" target="_blank" rel="noopener noreferrer">ChromiumStartupFlagsDtoDisableFeatures</a>|disable-features map |
|
|
13503
|
+
|disable-site-isolation-trials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-site-isolation-trials flag. |
|
|
13504
|
+
|disable-web-security|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-web-security flag. If no value is passed, it will be set to false by default. |
|
|
13505
|
+
|host-resolver-rules|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|host-resolver-rules. |
|
|
13506
|
+
|ignore-certificate-errors|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ignore-certificate-errors flag. |
|
|
13507
|
+
|ssl-version-max|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ssl-version-max. |
|
|
13508
|
+
|ssl-version-min|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ssl-version-min. |
|
|
13509
|
+
|test-type|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|test-type flag. |
|
|
13510
|
+
|
|
13511
|
+
### ChromiumStartupFlagsDtoDisableFeatures
|
|
13512
|
+
|
|
13513
|
+
disable-features map
|
|
13514
|
+
|
|
13515
|
+
**type**: Record<string, boolean | undefined>
|
|
13516
|
+
|
|
13517
|
+
### ClientCertificateDto
|
|
13518
|
+
|
|
13519
|
+
Client certificate.
|
|
13520
|
+
|
|
13521
|
+
| Name | Type | Description |
|
|
13522
|
+
| --- | --- | --- |
|
|
13523
|
+
|credentialId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Certificate CV id. |
|
|
13524
|
+
|domain<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Domain certificate will be applied to. |
|
|
13525
|
+
|
|
13403
13526
|
### CloudEvent
|
|
13404
13527
|
|
|
13405
13528
|
CloudEvents is a [specification](https://github.com/cloudevents/spec/blob/v1.0/spec.json) for describing event data in common formats to provide interoperability across services, platforms and systems.
|
|
@@ -13431,7 +13554,7 @@ The details of a code-level vulnerability.
|
|
|
13431
13554
|
|type|"SQL_INJECTION" | "SSRF" | "CMD_INJECTION" | "IMPROPER_INPUT_VALIDATION"|The type of code level vulnerability. |
|
|
13432
13555
|
|vulnerabilityLocation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The code location of the vulnerability. |
|
|
13433
13556
|
|vulnerableFunction|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The vulnerable function of the vulnerability. |
|
|
13434
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput"
|
|
13557
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability. |
|
|
13435
13558
|
|
|
13436
13559
|
### CodeLocation
|
|
13437
13560
|
|
|
@@ -13445,7 +13568,7 @@ Information about a code location.
|
|
|
13445
13568
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the code location. |
|
|
13446
13569
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the code location. |
|
|
13447
13570
|
|lineNumber|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The line number of the code location. |
|
|
13448
|
-
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
13571
|
+
|parameterTypes|<a href="#truncatableliststring" target="_blank" rel="noopener noreferrer">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
13449
13572
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function. |
|
|
13450
13573
|
|
|
13451
13574
|
### Comment
|
|
@@ -13473,7 +13596,7 @@ A list of comments.
|
|
|
13473
13596
|
|
|
13474
13597
|
| Name | Type | Description |
|
|
13475
13598
|
| --- | --- | --- |
|
|
13476
|
-
|comments<sup>*required</sup>|Array<<a href="#comment"
|
|
13599
|
+
|comments<sup>*required</sup>|Array<<a href="#comment">Comment</a>>|The result entries. |
|
|
13477
13600
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13478
13601
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13479
13602
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -13491,6 +13614,7 @@ A constraint on the values accepted for a complex settings property.
|
|
|
13491
13614
|
|minimumPropertyCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of properties that must be set. |
|
|
13492
13615
|
|properties|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of properties (defined by IDs) that are used to check the constraint. |
|
|
13493
13616
|
|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |
|
|
13617
|
+
|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |
|
|
13494
13618
|
|type<sup>*required</sup>|"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "PROPERTY_COUNT_RANGE" | "SECRET_RESUBMISSION"|The type of the constraint. |
|
|
13495
13619
|
|
|
13496
13620
|
### ConfigurationMetadata
|
|
@@ -13518,6 +13642,7 @@ A constraint on the values accepted for a settings property.
|
|
|
13518
13642
|
|minimum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum allowed value. |
|
|
13519
13643
|
|pattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The regular expression pattern for valid string values. |
|
|
13520
13644
|
|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |
|
|
13645
|
+
|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |
|
|
13521
13646
|
|type<sup>*required</sup>|"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "LENGTH" | "NOT_BLANK" | "NOT_EMPTY" | "NO_WHITESPACE" | "PATTERN" | "RANGE" | "REGEX" | "TRIMMED" | "UNIQUE"|The type of the constraint. |
|
|
13522
13647
|
|uniqueProperties|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of properties for which the combination of values must be unique. |
|
|
13523
13648
|
|
|
@@ -13532,6 +13657,17 @@ A list of constraint violations
|
|
|
13532
13657
|
|parameterLocation|"HEADER" | "PATH" | "PAYLOAD_BODY" | "QUERY"|
|
|
13533
13658
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
13534
13659
|
|
|
13660
|
+
### CookieStepDto
|
|
13661
|
+
|
|
13662
|
+
Cookie step of Browser Monitor.
|
|
13663
|
+
|
|
13664
|
+
| Name | Type | Description |
|
|
13665
|
+
| --- | --- | --- |
|
|
13666
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies. |
|
|
13667
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
13668
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
13669
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
13670
|
+
|
|
13535
13671
|
### CredentialAccessData
|
|
13536
13672
|
|
|
13537
13673
|
The set of entities allowed to use the credential.
|
|
@@ -13587,15 +13723,24 @@ Details of certificate credentials set.
|
|
|
13587
13723
|
|scope|"ALL" | "EXTENSION" | "SYNTHETIC" | "UNKNOWN"|The scope of the credentials set. |
|
|
13588
13724
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
13589
13725
|
|
|
13726
|
+
### CredentialsDetailsList
|
|
13727
|
+
|
|
13728
|
+
A list of detailed credentials sets for Synthetic monitors.
|
|
13729
|
+
|
|
13730
|
+
| Name | Type | Description |
|
|
13731
|
+
| --- | --- | --- |
|
|
13732
|
+
|allowPlaybackWithPrefilledCredentials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |
|
|
13733
|
+
|credentials<sup>*required</sup>|Array<<a href="#abstractcredentialsresponseelement" target="_blank" rel="noopener noreferrer">AbstractCredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors. |
|
|
13734
|
+
|
|
13590
13735
|
### CredentialsDetailsTokenResponseElement
|
|
13591
13736
|
|
|
13592
13737
|
Details of the token credentials set.
|
|
13593
13738
|
|
|
13594
13739
|
| Name | Type | Description |
|
|
13595
13740
|
| --- | --- | --- |
|
|
13596
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
13741
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
13597
13742
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
13598
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13743
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13599
13744
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
13600
13745
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
13601
13746
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
@@ -13610,9 +13755,9 @@ Details of username and password credentials set.
|
|
|
13610
13755
|
|
|
13611
13756
|
| Name | Type | Description |
|
|
13612
13757
|
| --- | --- | --- |
|
|
13613
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
13758
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
13614
13759
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
13615
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13760
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13616
13761
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
13617
13762
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
13618
13763
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
@@ -13636,7 +13781,7 @@ A list of credentials sets for Synthetic monitors.
|
|
|
13636
13781
|
|
|
13637
13782
|
| Name | Type | Description |
|
|
13638
13783
|
| --- | --- | --- |
|
|
13639
|
-
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement"
|
|
13784
|
+
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement">CredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors. |
|
|
13640
13785
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13641
13786
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13642
13787
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
@@ -13648,10 +13793,10 @@ Metadata of the credentials set.
|
|
|
13648
13793
|
| Name | Type | Description |
|
|
13649
13794
|
| --- | --- | --- |
|
|
13650
13795
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope). |
|
|
13651
|
-
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
13652
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
13796
|
+
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
13797
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
13653
13798
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
13654
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13799
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
13655
13800
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
13656
13801
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
13657
13802
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
@@ -13668,7 +13813,7 @@ Analysis of problem impact to a custom application.
|
|
|
13668
13813
|
| --- | --- | --- |
|
|
13669
13814
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
13670
13815
|
|impactType<sup>*required</sup>|"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
13671
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
13816
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
13672
13817
|
|
|
13673
13818
|
### CustomDeviceCreation
|
|
13674
13819
|
|
|
@@ -13684,7 +13829,7 @@ Configuration of a custom device.
|
|
|
13684
13829
|
|group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>User defined group ID of entity.</p> <p>The group ID helps to keep a consistent picture of device-group relations. One of many cases where a proper group is important is service detection: you can define which custom devices should lead to the same service by defining the same group ID for them.</p> <p>If you set a group ID, it will be hashed into the Dynatrace entity ID of the custom device. In that case the custom device can only be part of one custom device group.</p> <p>If you don't set the group ID, Dynatrace will create it based on the ID or type of the custom device. Also, the group will not be hashed into the device ID which means the device may switch groups.</p> |
|
|
13685
13830
|
|ipAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The list of IP addresses that belong to the custom device.</p> <p>These addresses are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If you send a value (including an empty value), the existing values will be overwritten.</p> <p>If you send <code>null</code> or omit this field, the existing values will be kept.</p> |
|
|
13686
13831
|
|listenPorts|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>The list of ports the custom devices listens to.</p> <p>These ports are used to discover the horizontal communication relationship between this component and all other observed components within Smartscape.</p> <p>Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If ports are specified, you should also add at least one IP address or a DNS name for the custom device.</p> <p>If you send a value, the existing values will be overwritten.</p> <p>If you send <code>null</code>, or an empty value, or omit this field, the existing values will be kept.</p> |
|
|
13687
|
-
|properties|<a href="#customdevicecreationproperties">CustomDeviceCreationProperties</a>|The list of key-value pair properties that will be shown beneath the infographics of your custom device. |
|
|
13832
|
+
|properties|<a href="#customdevicecreationproperties" target="_blank" rel="noopener noreferrer">CustomDeviceCreationProperties</a>|The list of key-value pair properties that will be shown beneath the infographics of your custom device. |
|
|
13688
13833
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The technology type definition of the custom device.</p> <p>It must be the same technology type of the metric you're reporting.</p> <p>If you send a value, the existing value will be overwritten.</p> <p>If you send <code>null</code>, empty or omit this field, the existing value will be kept.</p> |
|
|
13689
13834
|
|
|
13690
13835
|
### CustomDeviceCreationProperties
|
|
@@ -13708,7 +13853,7 @@ A list of custom tags.
|
|
|
13708
13853
|
|
|
13709
13854
|
| Name | Type | Description |
|
|
13710
13855
|
| --- | --- | --- |
|
|
13711
|
-
|tags<sup>*required</sup>|Array<<a href="#metag"
|
|
13856
|
+
|tags<sup>*required</sup>|Array<<a href="#metag">METag</a>>|A list of custom tags. |
|
|
13712
13857
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of tags in the response. |
|
|
13713
13858
|
|
|
13714
13859
|
### CustomLogLine
|
|
@@ -13832,7 +13977,7 @@ A list of advice from the Davis security advisor.
|
|
|
13832
13977
|
|
|
13833
13978
|
| Name | Type | Description |
|
|
13834
13979
|
| --- | --- | --- |
|
|
13835
|
-
|advices|Array<<a href="#davissecurityadvice">DavisSecurityAdvice</a>>| |
|
|
13980
|
+
|advices|Array<<a href="#davissecurityadvice" target="_blank" rel="noopener noreferrer">DavisSecurityAdvice</a>>| |
|
|
13836
13981
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13837
13982
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13838
13983
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -13854,13 +13999,14 @@ A constraint on the values that are going to be deleted.
|
|
|
13854
13999
|
|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
|
|
13855
14000
|
|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
|
|
13856
14001
|
|schemaIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
14002
|
+
|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |
|
|
13857
14003
|
|type<sup>*required</sup>|"UNKNOWN" | "CUSTOM_VALIDATOR_REF" | "REFERENTIAL_INTEGRITY"|The type of the deletion constraint. |
|
|
13858
14004
|
|
|
13859
14005
|
### EffectivePermission
|
|
13860
14006
|
|
|
13861
14007
|
| Name | Type | Description |
|
|
13862
14008
|
| --- | --- | --- |
|
|
13863
|
-
|context|<a href="#permissioncontext"
|
|
14009
|
+
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
13864
14010
|
|granted<sup>*required</sup>|"condition" | "false" | "true"| |
|
|
13865
14011
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13866
14012
|
|
|
@@ -13887,18 +14033,37 @@ A list of effective settings values.
|
|
|
13887
14033
|
|
|
13888
14034
|
| Name | Type | Description |
|
|
13889
14035
|
| --- | --- | --- |
|
|
13890
|
-
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue">EffectiveSettingsValue</a>>|A list of effective settings values. |
|
|
14036
|
+
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue" target="_blank" rel="noopener noreferrer">EffectiveSettingsValue</a>>|A list of effective settings values. |
|
|
13891
14037
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13892
14038
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13893
14039
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13894
14040
|
|
|
14041
|
+
### EnrichedManagementZoneDto
|
|
14042
|
+
|
|
14043
|
+
| Name | Type | Description |
|
|
14044
|
+
| --- | --- | --- |
|
|
14045
|
+
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the management zone. |
|
|
14046
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the management zone. |
|
|
14047
|
+
|sourceSetting|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path to the settings object in the Settings API. |
|
|
14048
|
+
|
|
14049
|
+
### EnrichedTagDto
|
|
14050
|
+
|
|
14051
|
+
| Name | Type | Description |
|
|
14052
|
+
| --- | --- | --- |
|
|
14053
|
+
|context|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The origin of the tag, such as AWS or Cloud Foundry.</p> <p>Custom tags use the <code>CONTEXTLESS</code> value.</p> |
|
|
14054
|
+
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the tag. |
|
|
14055
|
+
|source|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The source where the tag comes from. Possible values are:</p> <ul> <li>Auto tags</li> <li>Environment tags</li> <li>User provided tags</li> </ul> |
|
|
14056
|
+
|sourceSetting|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path to the settings object in the Settings API. Only available for tags with the Auto tags source. |
|
|
14057
|
+
|stringRepresentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The string representation of the tag. |
|
|
14058
|
+
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the tag. |
|
|
14059
|
+
|
|
13895
14060
|
### EntitiesList
|
|
13896
14061
|
|
|
13897
14062
|
A list of monitored entities along with their properties.
|
|
13898
14063
|
|
|
13899
14064
|
| Name | Type | Description |
|
|
13900
14065
|
| --- | --- | --- |
|
|
13901
|
-
|entities|Array<<a href="#entity"
|
|
14066
|
+
|entities|Array<<a href="#entity">Entity</a>>|A list of monitored entities. |
|
|
13902
14067
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
13903
14068
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13904
14069
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -13912,13 +14077,13 @@ The properties of a monitored entity.
|
|
|
13912
14077
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the entity, displayed in the UI. |
|
|
13913
14078
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the entity. |
|
|
13914
14079
|
|firstSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was first seen, in UTC milliseconds. |
|
|
13915
|
-
|fromRelationships|<a href="#entityfromrelationships">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position. |
|
|
13916
|
-
|icon|<a href="#entityicon"
|
|
14080
|
+
|fromRelationships|<a href="#entityfromrelationships" target="_blank" rel="noopener noreferrer">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position. |
|
|
14081
|
+
|icon|<a href="#entityicon">EntityIcon</a>|The icon of a monitored entity. |
|
|
13917
14082
|
|lastSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was last seen, in UTC milliseconds. |
|
|
13918
|
-
|managementZones|Array<<a href="#
|
|
13919
|
-
|properties|<a href="#entityproperties"
|
|
13920
|
-
|tags|Array<<a href="#
|
|
13921
|
-
|toRelationships|<a href="#entitytorelationships"
|
|
14083
|
+
|managementZones|Array<<a href="#enrichedmanagementzonedto" target="_blank" rel="noopener noreferrer">EnrichedManagementZoneDto</a>>|A set of management zones to which the entity belongs. |
|
|
14084
|
+
|properties|<a href="#entityproperties">EntityProperties</a>|A list of additional properties of the entity. |
|
|
14085
|
+
|tags|Array<<a href="#enrichedtagdto" target="_blank" rel="noopener noreferrer">EnrichedTagDto</a>>|A set of tags assigned to the entity. |
|
|
14086
|
+
|toRelationships|<a href="#entitytorelationships">EntityToRelationships</a>|A list of relationships where the entity occupies the TO position. |
|
|
13922
14087
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the entity. |
|
|
13923
14088
|
|
|
13924
14089
|
### EntityFromRelationships
|
|
@@ -13968,7 +14133,7 @@ A short representation of a monitored entity.
|
|
|
13968
14133
|
|
|
13969
14134
|
| Name | Type | Description |
|
|
13970
14135
|
| --- | --- | --- |
|
|
13971
|
-
|entityId|<a href="#entityid">EntityId</a>|A short representation of a monitored entity. |
|
|
14136
|
+
|entityId|<a href="#entityid" target="_blank" rel="noopener noreferrer">EntityId</a>|A short representation of a monitored entity. |
|
|
13972
14137
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The name of the entity.</p> <p>Not included in the response in case no entity with the relevant ID was found.</p> |
|
|
13973
14138
|
|
|
13974
14139
|
### EntityToRelationships
|
|
@@ -13986,11 +14151,11 @@ A list of properties of the monitored entity type.
|
|
|
13986
14151
|
|dimensionKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dimension key used within metrics for this monitored entity. |
|
|
13987
14152
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the monitored entity. |
|
|
13988
14153
|
|entityLimitExceeded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether the entity creation limit for the given type has been exceeded |
|
|
13989
|
-
|fromRelationships|Array<<a href="#toposition"
|
|
14154
|
+
|fromRelationships|Array<<a href="#toposition">ToPosition</a>>|A list of possible relationships where the monitored entity type occupies the FROM position |
|
|
13990
14155
|
|managementZones|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of management zones of an actual entity. |
|
|
13991
|
-
|properties|Array<<a href="#entitytypepropertydto">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type. |
|
|
14156
|
+
|properties|Array<<a href="#entitytypepropertydto" target="_blank" rel="noopener noreferrer">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type. |
|
|
13992
14157
|
|tags|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of tags of an actual entity. |
|
|
13993
|
-
|toRelationships|Array<<a href="#fromposition"
|
|
14158
|
+
|toRelationships|Array<<a href="#fromposition">FromPosition</a>>|A list of possible relationships where the monitored entity type occupies the TO position. |
|
|
13994
14159
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the monitored entity. |
|
|
13995
14160
|
|
|
13996
14161
|
### EntityTypeList
|
|
@@ -14002,7 +14167,7 @@ A list of properties of all available entity types.
|
|
|
14002
14167
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14003
14168
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14004
14169
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14005
|
-
|types|Array<<a href="#entitytype">EntityType</a>>|The list of meta information for all available entity-types |
|
|
14170
|
+
|types|Array<<a href="#entitytype" target="_blank" rel="noopener noreferrer">EntityType</a>>|The list of meta information for all available entity-types |
|
|
14006
14171
|
|
|
14007
14172
|
### EntityTypePropertyDto
|
|
14008
14173
|
|
|
@@ -14021,7 +14186,7 @@ Information about an entry point of a code-level vulnerability.
|
|
|
14021
14186
|
| Name | Type | Description |
|
|
14022
14187
|
| --- | --- | --- |
|
|
14023
14188
|
|sourceHttpPath|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Source HTTP path of entry points. |
|
|
14024
|
-
|usageSegments|Array<<a href="#entrypointusagesegment"
|
|
14189
|
+
|usageSegments|Array<<a href="#entrypointusagesegment">EntryPointUsageSegment</a>>|List of entry point usage segments. |
|
|
14025
14190
|
|
|
14026
14191
|
### EntryPointUsageSegment
|
|
14027
14192
|
|
|
@@ -14040,7 +14205,7 @@ A list of entry points and a flag which indicates whether this list was truncate
|
|
|
14040
14205
|
|
|
14041
14206
|
| Name | Type | Description |
|
|
14042
14207
|
| --- | --- | --- |
|
|
14043
|
-
|items|Array<<a href="#entrypoint">EntryPoint</a>>|A list of entry points. |
|
|
14208
|
+
|items|Array<<a href="#entrypoint" target="_blank" rel="noopener noreferrer">EntryPoint</a>>|A list of entry points. |
|
|
14044
14209
|
|truncated|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether the list of entry points was truncated or not. |
|
|
14045
14210
|
|
|
14046
14211
|
### EntrypointPayload
|
|
@@ -14063,7 +14228,7 @@ Definition of an enum property.
|
|
|
14063
14228
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
14064
14229
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
14065
14230
|
|enumClass|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An existing Java enum class that holds the allowed values of the enum. |
|
|
14066
|
-
|items<sup>*required</sup>|Array<<a href="#enumvalue"
|
|
14231
|
+
|items<sup>*required</sup>|Array<<a href="#enumvalue">EnumValue</a>>|A list of allowed values of the enum. |
|
|
14067
14232
|
|type<sup>*required</sup>|"enum"|The type of the property. |
|
|
14068
14233
|
|
|
14069
14234
|
### EnumValue
|
|
@@ -14083,14 +14248,14 @@ An allowed value for an enum property.
|
|
|
14083
14248
|
| Name | Type | Description |
|
|
14084
14249
|
| --- | --- | --- |
|
|
14085
14250
|
|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |
|
|
14086
|
-
|constraintViolations|Array<<a href="#constraintviolation">ConstraintViolation</a>>|A list of constraint violations |
|
|
14251
|
+
|constraintViolations|Array<<a href="#constraintviolation" target="_blank" rel="noopener noreferrer">ConstraintViolation</a>>|A list of constraint violations |
|
|
14087
14252
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
|
|
14088
14253
|
|
|
14089
14254
|
### ErrorEnvelope
|
|
14090
14255
|
|
|
14091
14256
|
| Name | Type |
|
|
14092
14257
|
| --- | --- |
|
|
14093
|
-
|error|<a href="#error"
|
|
14258
|
+
|error|<a href="#error">Error</a>|
|
|
14094
14259
|
|
|
14095
14260
|
### Event
|
|
14096
14261
|
|
|
@@ -14100,13 +14265,13 @@ Configuration of an event.
|
|
|
14100
14265
|
| --- | --- | --- |
|
|
14101
14266
|
|correlationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The correlation ID of the event. |
|
|
14102
14267
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp when the event was closed, in UTC milliseconds.</p> <p>Has the value of <code>null</code> if the event is still active.</p> |
|
|
14103
|
-
|entityId|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14104
|
-
|entityTags|Array<<a href="#metag"
|
|
14268
|
+
|entityId|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
14269
|
+
|entityTags|Array<<a href="#metag">METag</a>>|A list of tags of the related entity. |
|
|
14105
14270
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
14106
14271
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
14107
14272
|
|frequentEvent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code>, the event happens <a href="https://dt-url.net/4da3kdg" target="_blank" rel="noopener noreferrer" >frequently</a>.</p> <p>A frequent event doesn't raise a problem.</p> |
|
|
14108
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the event belongs to. |
|
|
14109
|
-
|properties|Array<<a href="#eventproperty"
|
|
14273
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of all management zones that the event belongs to. |
|
|
14274
|
+
|properties|Array<<a href="#eventproperty">EventProperty</a>>|A list of event properties. |
|
|
14110
14275
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event was raised, in UTC milliseconds. |
|
|
14111
14276
|
|status|"CLOSED" | "OPEN"|The status of the event. |
|
|
14112
14277
|
|suppressAlert|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The alerting status during a <a href="https://dt-url.net/b2123rg0" target="_blank" rel="noopener noreferrer" >maintenance</a>:</p> <ul> <li><code>false</code>: Alerting works as usual.</li> <li><code>true</code>: Alerting is disabled.</li> </ul> |
|
|
@@ -14122,14 +14287,14 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
14122
14287
|
|
|
14123
14288
|
| Name | Type | Description |
|
|
14124
14289
|
| --- | --- | --- |
|
|
14125
|
-
|data|<a href="#event">Event</a>|Configuration of an event. |
|
|
14290
|
+
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>|Configuration of an event. |
|
|
14126
14291
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
14127
14292
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end timestamp of the event, in UTC milliseconds.</p> <p>Has <code>-1</code> value, if the event is still active.</p> |
|
|
14128
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
14293
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14129
14294
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
14130
14295
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
14131
14296
|
|evidenceType<sup>*required</sup>|"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
14132
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14297
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
14133
14298
|
|rootCauseRelevant<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The evidence is (<code>true</code>) or is not (<code>false</code>) a part of the root cause. |
|
|
14134
14299
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
14135
14300
|
|
|
@@ -14140,9 +14305,9 @@ The configuration of an event to be ingested.
|
|
|
14140
14305
|
| Name | Type | Description |
|
|
14141
14306
|
| --- | --- | --- |
|
|
14142
14307
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end time of the event, in UTC milliseconds.</p> <p>If not set, the start time plus timeout is used.</p> |
|
|
14143
|
-
|entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >entity selector</a>, defining a set of Dynatrace entities to be associated with the event.</p> <p>Only entities that have been active within the last 24 hours can be selected.</p> <p>If not set, the event is associated with the environment (<code>dt.entity.environment</code>) entity.</p> |
|
|
14144
|
-
|eventType<sup>*required</sup>|"AVAILABILITY_EVENT" | "CUSTOM_ALERT" | "CUSTOM_ANNOTATION" | "CUSTOM_CONFIGURATION" | "CUSTOM_DEPLOYMENT" | "CUSTOM_INFO" | "ERROR_EVENT" | "MARKED_FOR_TERMINATION" | "PERFORMANCE_EVENT" | "RESOURCE_CONTENTION_EVENT"|The type of the event. |
|
|
14145
|
-
|properties|<a href="#eventingestproperties"
|
|
14308
|
+
|entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >entity selector</a>, defining a set of Dynatrace entities to be associated with the event.</p> <p>Only entities that have been active within the last 24 hours can be selected. Note that the <code>entityId</code> filter bypasses this time constraint, allowing events to be ingested for entities that have been inactive for more than 24 hours.</p> <p>If not set, the event is associated with the environment (<code>dt.entity.environment</code>) entity.</p> |
|
|
14309
|
+
|eventType<sup>*required</sup>|"AVAILABILITY_EVENT" | "CUSTOM_ALERT" | "CUSTOM_ANNOTATION" | "CUSTOM_CONFIGURATION" | "CUSTOM_DEPLOYMENT" | "CUSTOM_INFO" | "ERROR_EVENT" | "MARKED_FOR_TERMINATION" | "PERFORMANCE_EVENT" | "RESOURCE_CONTENTION_EVENT" | "WARNING"|The type of the event. |
|
|
14310
|
+
|properties|<a href="#eventingestproperties">EventIngestProperties</a>|<p>A map of event properties.</p> <ul> <li>To set event properties with predefined behavior, use classic <code>dt.event.\*</code> and <code>dt.davis.\*</code> properties. To check which properties belong to classic API, see <a href="https://dt-url.net/9622g1w" target="_blank" rel="noopener noreferrer" >Events API v2 - GET all event properties</a>.</li> <li>To attach entity information to an event, use <code>dt.entity.\*</code> keys.</li> <li>To provide additional info, you can use any key outside of the <code>dt.\*</code> namespace.</li> </ul> <p>Values of event properties with predefined behavior must fulfill the requirements of the respective property.</p> <p>A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.</p> |
|
|
14146
14311
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The start time of the event, in UTC milliseconds.</p> <p>If not set, the current timestamp is used.</p> <p>Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events.</p> <p>Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events.</p> <p>Events that can be sent up to 7 days in the future:</p> <ul> <li><code>CUSTOM_ANNOTATION</code></li> <li><code>CUSTOM_CONFIGURATION</code></li> <li><code>CUSTOM_DEPLOYMENT</code></li> <li><code>CUSTOM_INFO</code></li> <li><code>MARKED_FOR_TERMINATION</code></li> </ul> |
|
|
14147
14312
|
|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timeout of the event, in minutes.</p> <p>If not set, 15 is used.</p> <p>The timeout will automatically be capped to a maximum of 360 minutes (6 hours).</p> <p>Problem-opening events can be refreshed and therefore kept open by sending the same payload again.</p> |
|
|
14148
14313
|
|title<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the event. |
|
|
@@ -14176,7 +14341,7 @@ The results of an event ingest.
|
|
|
14176
14341
|
|
|
14177
14342
|
| Name | Type | Description |
|
|
14178
14343
|
| --- | --- | --- |
|
|
14179
|
-
|eventIngestResults|Array<<a href="#eventingestresult">EventIngestResult</a>>|The result of each created event report. |
|
|
14344
|
+
|eventIngestResults|Array<<a href="#eventingestresult" target="_blank" rel="noopener noreferrer">EventIngestResult</a>>|The result of each created event report. |
|
|
14180
14345
|
|reportCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of created event reports. |
|
|
14181
14346
|
|
|
14182
14347
|
### EventList
|
|
@@ -14185,7 +14350,7 @@ A list of events.
|
|
|
14185
14350
|
|
|
14186
14351
|
| Name | Type | Description |
|
|
14187
14352
|
| --- | --- | --- |
|
|
14188
|
-
|events|Array<<a href="#event"
|
|
14353
|
+
|events|Array<<a href="#event">Event</a>>|A list of events. |
|
|
14189
14354
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14190
14355
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14191
14356
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14197,7 +14362,7 @@ A list of event properties.
|
|
|
14197
14362
|
|
|
14198
14363
|
| Name | Type | Description |
|
|
14199
14364
|
| --- | --- | --- |
|
|
14200
|
-
|eventProperties|Array<<a href="#eventpropertydetails">EventPropertyDetails</a>>|A list of event properties. |
|
|
14365
|
+
|eventProperties|Array<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>>|A list of event properties. |
|
|
14201
14366
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14202
14367
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14203
14368
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14240,7 +14405,7 @@ A list of event types.
|
|
|
14240
14405
|
|
|
14241
14406
|
| Name | Type | Description |
|
|
14242
14407
|
| --- | --- | --- |
|
|
14243
|
-
|eventTypeInfos|Array<<a href="#eventtype"
|
|
14408
|
+
|eventTypeInfos|Array<<a href="#eventtype">EventType</a>>|A list of event types. |
|
|
14244
14409
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14245
14410
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14246
14411
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14254,9 +14419,9 @@ An evidence of a root cause.
|
|
|
14254
14419
|
| Name | Type | Description |
|
|
14255
14420
|
| --- | --- | --- |
|
|
14256
14421
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
14257
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14422
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
14258
14423
|
|evidenceType<sup>*required</sup>|"AVAILABILITY_EVIDENCE" | "EVENT" | "MAINTENANCE_WINDOW" | "METRIC" | "TRANSACTIONAL"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
14259
|
-
|groupingEntity|<a href="#entitystub"
|
|
14424
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14260
14425
|
|rootCauseRelevant<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The evidence is (<code>true</code>) or is not (<code>false</code>) a part of the root cause. |
|
|
14261
14426
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
14262
14427
|
|
|
@@ -14266,14 +14431,14 @@ The evidence details of a problem.
|
|
|
14266
14431
|
|
|
14267
14432
|
| Name | Type | Description |
|
|
14268
14433
|
| --- | --- | --- |
|
|
14269
|
-
|details<sup>*required</sup>|Array<<a href="#evidence">Evidence</a>>|A list of all evidence. |
|
|
14434
|
+
|details<sup>*required</sup>|Array<<a href="#evidence" target="_blank" rel="noopener noreferrer">Evidence</a>>|A list of all evidence. |
|
|
14270
14435
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of evidence of a problem. |
|
|
14271
14436
|
|
|
14272
14437
|
### ExecuteActionsDto
|
|
14273
14438
|
|
|
14274
14439
|
| Name | Type | Description |
|
|
14275
14440
|
| --- | --- | --- |
|
|
14276
|
-
|actions|<a href="#executeactionsdtoactions"
|
|
14441
|
+
|actions|<a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a>|Data Source defined action objects |
|
|
14277
14442
|
|
|
14278
14443
|
### ExecuteActionsDtoActions
|
|
14279
14444
|
|
|
@@ -14296,7 +14461,7 @@ Contains extended monitor's execution details.
|
|
|
14296
14461
|
| --- | --- | --- |
|
|
14297
14462
|
|errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Error code. |
|
|
14298
14463
|
|executionStepCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number executed steps. |
|
|
14299
|
-
|executionSteps|Array<<a href="#executionstep">ExecutionStep</a>>|Details about the monitor's step execution. |
|
|
14464
|
+
|executionSteps|Array<<a href="#executionstep" target="_blank" rel="noopener noreferrer">ExecutionStep</a>>|Details about the monitor's step execution. |
|
|
14300
14465
|
|failedStepName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failed step name. |
|
|
14301
14466
|
|failedStepSequenceId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Failed step sequence id. |
|
|
14302
14467
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failure message. |
|
|
@@ -14345,7 +14510,7 @@ A list of exported log records.
|
|
|
14345
14510
|
| --- | --- | --- |
|
|
14346
14511
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14347
14512
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14348
|
-
|results|Array<<a href="#logrecord"
|
|
14513
|
+
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records. |
|
|
14349
14514
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14350
14515
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
14351
14516
|
|
|
@@ -14353,11 +14518,11 @@ A list of exported log records.
|
|
|
14353
14518
|
|
|
14354
14519
|
| Name | Type | Description |
|
|
14355
14520
|
| --- | --- | --- |
|
|
14356
|
-
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author |
|
|
14521
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author |
|
|
14357
14522
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
14358
14523
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
14359
14524
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
14360
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails"
|
|
14525
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails">ExtensionFeatureSetsDetails</a>|Details of feature sets |
|
|
14361
14526
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
14362
14527
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
14363
14528
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -14370,7 +14535,7 @@ List of assets imported with the active extension environment configuration.
|
|
|
14370
14535
|
|
|
14371
14536
|
| Name | Type | Description |
|
|
14372
14537
|
| --- | --- | --- |
|
|
14373
|
-
|assets<sup>*required</sup>|Array<<a href="#assetinfodto">AssetInfoDto</a>>|The list of the imported assets. |
|
|
14538
|
+
|assets<sup>*required</sup>|Array<<a href="#assetinfodto" target="_blank" rel="noopener noreferrer">AssetInfoDto</a>>|The list of the imported assets. |
|
|
14374
14539
|
|errors<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of errors during asset import |
|
|
14375
14540
|
|status<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The status of the assets list. |
|
|
14376
14541
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Version of the active extension environment configuration. <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
@@ -14399,7 +14564,7 @@ A list of extension events.
|
|
|
14399
14564
|
|
|
14400
14565
|
| Name | Type | Description |
|
|
14401
14566
|
| --- | --- | --- |
|
|
14402
|
-
|extensionEvents|Array<<a href="#extensioneventdto"
|
|
14567
|
+
|extensionEvents|Array<<a href="#extensioneventdto">ExtensionEventDto</a>>|A list of extension events. |
|
|
14403
14568
|
|
|
14404
14569
|
### ExtensionFeatureSetsDetails
|
|
14405
14570
|
|
|
@@ -14422,7 +14587,7 @@ A list of extensions with additional metadata.
|
|
|
14422
14587
|
|
|
14423
14588
|
| Name | Type | Description |
|
|
14424
14589
|
| --- | --- | --- |
|
|
14425
|
-
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo">ExtensionInfo</a>>|A list of extensions with additional metadata. |
|
|
14590
|
+
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo" target="_blank" rel="noopener noreferrer">ExtensionInfo</a>>|A list of extensions with additional metadata. |
|
|
14426
14591
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14427
14592
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14428
14593
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14431,7 +14596,7 @@ A list of extensions with additional metadata.
|
|
|
14431
14596
|
|
|
14432
14597
|
| Name | Type | Description |
|
|
14433
14598
|
| --- | --- | --- |
|
|
14434
|
-
|extensions<sup>*required</sup>|Array<<a href="#minimalextension"
|
|
14599
|
+
|extensions<sup>*required</sup>|Array<<a href="#minimalextension">MinimalExtension</a>>|A list of extensions. |
|
|
14435
14600
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14436
14601
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14437
14602
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14448,7 +14613,7 @@ A list of extensions with additional metadata.
|
|
|
14448
14613
|
|
|
14449
14614
|
| Name | Type | Description |
|
|
14450
14615
|
| --- | --- | --- |
|
|
14451
|
-
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>>|A list of extension monitoring configurations. |
|
|
14616
|
+
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfiguration</a>>|A list of extension monitoring configurations. |
|
|
14452
14617
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
14453
14618
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14454
14619
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -14457,7 +14622,7 @@ A list of extensions with additional metadata.
|
|
|
14457
14622
|
|
|
14458
14623
|
| Name | Type | Description |
|
|
14459
14624
|
| --- | --- | --- |
|
|
14460
|
-
|status<sup>*required</sup>|"UNKNOWN" | "
|
|
14625
|
+
|status<sup>*required</sup>|"UNKNOWN" | "WARNING" | "OK" | "ERROR" | "PENDING"|Latest status of given configuration. |
|
|
14461
14626
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Timestamp of the latest status of given configuration. |
|
|
14462
14627
|
|
|
14463
14628
|
### ExtensionStatusWithIdDto
|
|
@@ -14465,19 +14630,19 @@ A list of extensions with additional metadata.
|
|
|
14465
14630
|
| Name | Type | Description |
|
|
14466
14631
|
| --- | --- | --- |
|
|
14467
14632
|
|configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Unique ID of the configuration. |
|
|
14468
|
-
|status<sup>*required</sup>|"UNKNOWN" | "
|
|
14633
|
+
|status<sup>*required</sup>|"UNKNOWN" | "WARNING" | "OK" | "ERROR" | "PENDING"|Latest status of given configuration. |
|
|
14469
14634
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Timestamp of the latest status of given configuration. |
|
|
14470
14635
|
|
|
14471
14636
|
### ExtensionUploadResponseDto
|
|
14472
14637
|
|
|
14473
14638
|
| Name | Type | Description |
|
|
14474
14639
|
| --- | --- | --- |
|
|
14475
|
-
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo"
|
|
14476
|
-
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author |
|
|
14640
|
+
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo">AssetInfo</a>>|Information about extension assets included |
|
|
14641
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author |
|
|
14477
14642
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
14478
14643
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
14479
14644
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
14480
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails"
|
|
14645
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets |
|
|
14481
14646
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
14482
14647
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
14483
14648
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -14526,7 +14691,7 @@ Additional information about a Feature Set
|
|
|
14526
14691
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional description for the feature set |
|
|
14527
14692
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional display name of the feature set |
|
|
14528
14693
|
|isRecommended<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Marks the feature set as recommended (selected by default during activation) |
|
|
14529
|
-
|metrics|Array<<a href="#metricdto">MetricDto</a>>|Feature set metrics |
|
|
14694
|
+
|metrics|Array<<a href="#metricdto" target="_blank" rel="noopener noreferrer">MetricDto</a>>|Feature set metrics |
|
|
14530
14695
|
|
|
14531
14696
|
### Filter
|
|
14532
14697
|
|
|
@@ -14534,11 +14699,11 @@ A dimensional or series filter on a metric.
|
|
|
14534
14699
|
|
|
14535
14700
|
| Name | Type | Description |
|
|
14536
14701
|
| --- | --- | --- |
|
|
14537
|
-
|operands|Array<<a href="#filter"
|
|
14538
|
-
|referenceInvocation|<a href="#invocation">Invocation</a>|Invocation of a function, e.g. the <code>entitySelector</code> function. |
|
|
14702
|
+
|operands|Array<<a href="#filter">Filter</a>>|If the type is <code>not</code>, <code>and</code> or <code>or</code>, then holds the contained filters. |
|
|
14703
|
+
|referenceInvocation|<a href="#invocation" target="_blank" rel="noopener noreferrer">Invocation</a>|Invocation of a function, e.g. the <code>entitySelector</code> function. |
|
|
14539
14704
|
|referenceString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For filters that match a dimension against a valkue, such as <code>eq</code> or <code>ne</code>, holds the value to compare the dimension against. |
|
|
14540
14705
|
|referenceValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|For the operands of <code>series</code> filters that match against a number, holds the number to compare against. |
|
|
14541
|
-
|rollup|<a href="#rollup"
|
|
14706
|
+
|rollup|<a href="#rollup">Rollup</a>|A way of viewing a series as a single value for the purpose of sorting or series-based filters. |
|
|
14542
14707
|
|targetDimension|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If the type applies to a dimension, then holds the target dimension. |
|
|
14543
14708
|
|targetDimensions|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|If the type applies to n dimensions, then holds the target dimensions. Currently only used for the <code>remainder</code> filter. |
|
|
14544
14709
|
|type|"and" | "contains" | "eq" | "existsKey" | "ge" | "gt" | "in" | "le" | "lt" | "ne" | "not" | "or" | "otherwise" | "prefix" | "remainder" | "series" | "suffix"|<p>Type of this filter, determines which other fields are present.Can be any of:</p> <ul> <li><code>eq</code>,</li> <li><code>ne</code>,</li> <li><code>prefix</code>,</li> <li><code>in</code>,</li> <li><code>remainder</code>,</li> <li><code>suffix</code>,</li> <li><code>contains</code>,</li> <li><code>existsKey</code>,</li> <li><code>series</code>,</li> <li><code>or</code>,</li> <li><code>and</code>,</li> <li><code>not</code>,</li> <li><code>ge</code>,</li> <li><code>gt</code>,</li> <li><code>le</code>,</li> <li><code>lt</code>,</li> <li><code>otherwise</code>.</li> </ul> |
|
|
@@ -14563,6 +14728,30 @@ Statistics about the security problem, filtered by the management zone and timef
|
|
|
14563
14728
|
|relatedServices|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of related services |
|
|
14564
14729
|
|vulnerableComponents|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of vulnerable components |
|
|
14565
14730
|
|
|
14731
|
+
### FilteredRequestsDto
|
|
14732
|
+
|
|
14733
|
+
Filtered requests of a Browser Monitor.
|
|
14734
|
+
|
|
14735
|
+
| Name | Type | Description |
|
|
14736
|
+
| --- | --- | --- |
|
|
14737
|
+
|mode<sup>*required</sup>|"BLOCK" | "ALLOW"|Filter mode for filtered requests. |
|
|
14738
|
+
|requests<sup>*required</sup>|Array<<a href="#requestfilterdto" target="_blank" rel="noopener noreferrer">RequestFilterDto</a>>|Requests to be filtered. |
|
|
14739
|
+
|
|
14740
|
+
### FrameworkOptionsDto
|
|
14741
|
+
|
|
14742
|
+
JS framework options of a JS Agent.
|
|
14743
|
+
|
|
14744
|
+
| Name | Type | Description |
|
|
14745
|
+
| --- | --- | --- |
|
|
14746
|
+
|activeXObject|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|activeXObject support. If not defined in request, it will be set to false by default. |
|
|
14747
|
+
|angular|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Angular support. If not defined in request, it will be set to false by default. |
|
|
14748
|
+
|dojo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Dojo support. If not defined in request, it will be set to false by default. |
|
|
14749
|
+
|extJs|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|extJs support. If not defined in request, it will be set to false by default. |
|
|
14750
|
+
|icefaces|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|icefaces support. If not defined in request, it will be set to false by default. |
|
|
14751
|
+
|jQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|jquery support. If not defined in request, it will be set to false by default. |
|
|
14752
|
+
|mooTools|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|mooTools support. If not defined in request, it will be set to false by default. |
|
|
14753
|
+
|prototype|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|prototype support. If not defined in request, it will be set to false by default. |
|
|
14754
|
+
|
|
14566
14755
|
### FromPosition
|
|
14567
14756
|
|
|
14568
14757
|
The FROM position of a relationship.
|
|
@@ -14677,6 +14866,7 @@ Modification information about the setting.
|
|
|
14677
14866
|
| Name | Type | Description |
|
|
14678
14867
|
| --- | --- | --- |
|
|
14679
14868
|
|lastModifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14869
|
+
|lastModifiedReason|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Reason for system change |
|
|
14680
14870
|
|lastModifiedTime<sup>*required</sup>|Date|Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
|
|
14681
14871
|
|
|
14682
14872
|
### HttpProtocolDetails
|
|
@@ -14707,6 +14897,15 @@ An Identity describing either a user, a group, or the all-users group (applying
|
|
|
14707
14897
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'. |
|
|
14708
14898
|
|type<sup>*required</sup>|"all-users" | "group" | "user"|The type of the identity. |
|
|
14709
14899
|
|
|
14900
|
+
### IgnoredErrorCodesDto
|
|
14901
|
+
|
|
14902
|
+
Ignored Error Codes of a Browser Monitor.
|
|
14903
|
+
|
|
14904
|
+
| Name | Type | Description |
|
|
14905
|
+
| --- | --- | --- |
|
|
14906
|
+
|matchingDocumentRequests|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Ignoring status codes will be applied to requests matching pattern. |
|
|
14907
|
+
|statusCodes|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Status codes to be ignored. |
|
|
14908
|
+
|
|
14710
14909
|
### Impact
|
|
14711
14910
|
|
|
14712
14911
|
The impact analysis of the problem on other entities/users.
|
|
@@ -14735,6 +14934,20 @@ The position where the button should be shown relative to a property in the UI
|
|
|
14735
14934
|
| --- | --- | --- |
|
|
14736
14935
|
|after<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of a property after which the button should be shown in the UI |
|
|
14737
14936
|
|
|
14937
|
+
### InteractionStepDto
|
|
14938
|
+
|
|
14939
|
+
Interaction step of Browser Monitor.
|
|
14940
|
+
|
|
14941
|
+
| Name | Type | Description |
|
|
14942
|
+
| --- | --- | --- |
|
|
14943
|
+
|button|"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"|Integer containing the button index. |
|
|
14944
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
14945
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
14946
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
14947
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
14948
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
14949
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
14950
|
+
|
|
14738
14951
|
### InvalidLine
|
|
14739
14952
|
|
|
14740
14953
|
| Name | Type |
|
|
@@ -14757,16 +14970,16 @@ An item of a collection property.
|
|
|
14757
14970
|
|
|
14758
14971
|
| Name | Type | Description |
|
|
14759
14972
|
| --- | --- | --- |
|
|
14760
|
-
|constraints|Array<<a href="#constraint"
|
|
14761
|
-
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
14973
|
+
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
14974
|
+
|datasource|<a href="#datasourcedefinition" target="_blank" rel="noopener noreferrer">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
14762
14975
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the item. |
|
|
14763
14976
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the item. |
|
|
14764
14977
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
14765
|
-
|metadata|<a href="#itemmetadata"
|
|
14978
|
+
|metadata|<a href="#itemmetadata">ItemMetadata</a>|Metadata of the items. |
|
|
14766
14979
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the item's value. |
|
|
14767
14980
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the item's value. |
|
|
14768
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer">RefPointer</a>|The type of the item's value. |
|
|
14769
|
-
|uiCustomization|<a href="#uicustomization"
|
|
14981
|
+
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer" target="_blank" rel="noopener noreferrer">RefPointer</a>|The type of the item's value. |
|
|
14982
|
+
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
14770
14983
|
|
|
14771
14984
|
### ItemMetadata
|
|
14772
14985
|
|
|
@@ -14774,6 +14987,68 @@ Metadata of the items.
|
|
|
14774
14987
|
|
|
14775
14988
|
**type**: Record<string, string | undefined>
|
|
14776
14989
|
|
|
14990
|
+
### JavaScriptAgentSettingsDto
|
|
14991
|
+
|
|
14992
|
+
JavaScript Agent Settings.
|
|
14993
|
+
|
|
14994
|
+
| Name | Type | Description |
|
|
14995
|
+
| --- | --- | --- |
|
|
14996
|
+
|customProperties|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Custom configuration properties |
|
|
14997
|
+
|experimentalValues|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Experimental values support. If not defined in request, it will be set to false by default. |
|
|
14998
|
+
|fetchRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture fetch() requests. If not defined in request, it will be set to true by default. |
|
|
14999
|
+
|javaScriptErrors|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Enable this setting to monitor JavaScript errors. The window.onError handler is used for capturing JavaScript errors. If not defined in request, it will be set to true by default. |
|
|
15000
|
+
|javaScriptFrameworkSupport|<a href="#frameworkoptionsdto" target="_blank" rel="noopener noreferrer">FrameworkOptionsDto</a>|JS framework options of a JS Agent. |
|
|
15001
|
+
|timedActions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Within JavaScript frameworks, XHRs are often sent via setTimeout methods. Enable this setting to detect actions that trigger such XHRs. If not defined in request, it will be set to true by default. |
|
|
15002
|
+
|timeoutSettings|<a href="#timeoutsettingsdto">TimeoutSettingsDto</a>|Timeout settings of a Browser Monitor. |
|
|
15003
|
+
|visuallyCompleteOptions|<a href="#visuallycompleteoptionsdto" target="_blank" rel="noopener noreferrer">VisuallyCompleteOptionsDto</a>|Visually Complete Options of a Browser Monitor. |
|
|
15004
|
+
|xmlHttpRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture xml Http requests (XHR). If not defined in request, it will be set to true by default. |
|
|
15005
|
+
|
|
15006
|
+
### JavaScriptStepDto
|
|
15007
|
+
|
|
15008
|
+
JavaScript step of Browser Monitor.
|
|
15009
|
+
|
|
15010
|
+
| Name | Type | Description |
|
|
15011
|
+
| --- | --- | --- |
|
|
15012
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
15013
|
+
|javaScript|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing a script in JavaScript. |
|
|
15014
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15015
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
15016
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
15017
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
15018
|
+
|
|
15019
|
+
### KeyPerformanceMetrics
|
|
15020
|
+
|
|
15021
|
+
The key performance metrics configuration.
|
|
15022
|
+
|
|
15023
|
+
| Name | Type | Description |
|
|
15024
|
+
| --- | --- | --- |
|
|
15025
|
+
|loadActionKpm|"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "SPEED_INDEX" | "DOM_INTERACTIVE" | "LOAD_EVENT_START" | "LOAD_EVENT_END" | "RESPONSE_START" | "RESPONSE_END" | "LARGEST_CONTENTFUL_PAINT" | "CUMULATIVE_LAYOUT_SHIFT"|Load action key performance metric. |
|
|
15026
|
+
|xhrActionKpm|"USER_ACTION_DURATION" | "VISUALLY_COMPLETE" | "RESPONSE_START" | "RESPONSE_END"|XHR action key performance metric. |
|
|
15027
|
+
|
|
15028
|
+
### KeyStrokesStepDto
|
|
15029
|
+
|
|
15030
|
+
Key strokes step of Browser Monitor.
|
|
15031
|
+
|
|
15032
|
+
| Name | Type | Description |
|
|
15033
|
+
| --- | --- | --- |
|
|
15034
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
15035
|
+
|input|<a href="#keystrokesinputdto">KeystrokesInputDto</a>|Key strokes step input. |
|
|
15036
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15037
|
+
|simulateBlurEvent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if blur event should be simulated. |
|
|
15038
|
+
|simulateReturnKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if return key should be simulated. |
|
|
15039
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
15040
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
15041
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
15042
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
15043
|
+
|
|
15044
|
+
### KeystrokesInputDto
|
|
15045
|
+
|
|
15046
|
+
Key strokes step input.
|
|
15047
|
+
|
|
15048
|
+
| Name | Type | Description |
|
|
15049
|
+
| --- | --- | --- |
|
|
15050
|
+
|type<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureKeystrokesInputDto</li> <li><code>PLAIN</code> -> PlainKeystrokesInputDto</li> </ul> |
|
|
15051
|
+
|
|
14777
15052
|
### LinkedProblem
|
|
14778
15053
|
|
|
14779
15054
|
The properties of the linked problem.
|
|
@@ -14817,6 +15092,15 @@ Results of the execution HTTP monitor's requests at a given location
|
|
|
14817
15092
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location id. |
|
|
14818
15093
|
|requestResults|Array<<a href="#monitorrequestexecutionresult">MonitorRequestExecutionResult</a>>|The list of the monitor's request results executed on this location. |
|
|
14819
15094
|
|
|
15095
|
+
### LocatorDto
|
|
15096
|
+
|
|
15097
|
+
Browser Monitor locator.
|
|
15098
|
+
|
|
15099
|
+
| Name | Type | Description |
|
|
15100
|
+
| --- | --- | --- |
|
|
15101
|
+
|type<sup>*required</sup>|"CSS" | "DOM"|Enum value of the locator type. |
|
|
15102
|
+
|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Value of the locator. |
|
|
15103
|
+
|
|
14820
15104
|
### LogRecord
|
|
14821
15105
|
|
|
14822
15106
|
A single log record.
|
|
@@ -15136,6 +15420,15 @@ Results of the execution of all HTTP monitor's requests.
|
|
|
15136
15420
|
|locationsExecutionResults|Array<<a href="#locationexecutionresults">LocationExecutionResults</a>>|The list with the results of the requests executed on assigned locations. |
|
|
15137
15421
|
|monitorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor id. |
|
|
15138
15422
|
|
|
15423
|
+
### MonitorPropertyDto
|
|
15424
|
+
|
|
15425
|
+
Property of a Browser Monitor.
|
|
15426
|
+
|
|
15427
|
+
| Name | Type | Description |
|
|
15428
|
+
| --- | --- | --- |
|
|
15429
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Property name. |
|
|
15430
|
+
|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Property value. |
|
|
15431
|
+
|
|
15139
15432
|
### MonitorRequestExecutionResult
|
|
15140
15433
|
|
|
15141
15434
|
A result of the execution HTTP monitor's request.
|
|
@@ -15246,6 +15539,32 @@ Metadata of the muted state of a security problem in relation to an event.
|
|
|
15246
15539
|
|reason|"OTHER" | "AFFECTED" | "CONFIGURATION_NOT_AFFECTED" | "FALSE_POSITIVE" | "IGNORE" | "INITIAL_STATE" | "VULNERABLE_CODE_NOT_IN_USE"|The reason for the mute state change. |
|
|
15247
15540
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user who has muted or unmuted the problem. |
|
|
15248
15541
|
|
|
15542
|
+
### NavigateStepDto
|
|
15543
|
+
|
|
15544
|
+
Step of Browser Monitor that navigates to a website.
|
|
15545
|
+
|
|
15546
|
+
| Name | Type | Description |
|
|
15547
|
+
| --- | --- | --- |
|
|
15548
|
+
|authentication|<a href="#authenticationdto">AuthenticationDto</a>|Authentication dto for Browser Monitor step. |
|
|
15549
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
15550
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15551
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
15552
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
15553
|
+
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Field containing the url that the monitor should navigate to. |
|
|
15554
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
15555
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
15556
|
+
|
|
15557
|
+
### NetworkThrottlingDto
|
|
15558
|
+
|
|
15559
|
+
Network throttling of a Browser Monitor.
|
|
15560
|
+
|
|
15561
|
+
| Name | Type | Description |
|
|
15562
|
+
| --- | --- | --- |
|
|
15563
|
+
|download|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Download throughput. If not defined in request, it will be set to -1 by default. |
|
|
15564
|
+
|latency|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Latency. If not defined in request, it will be set to 0 by default. |
|
|
15565
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Predefined network type. If not defined in request, it will be set to "" by default. |
|
|
15566
|
+
|upload|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Upload throughput. If not defined in request, it will be set to -1 by default. |
|
|
15567
|
+
|
|
15249
15568
|
### NetworkZone
|
|
15250
15569
|
|
|
15251
15570
|
Configuration of a network zone.
|
|
@@ -15360,6 +15679,29 @@ Optional context data
|
|
|
15360
15679
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Settings schema id for conditional permission |
|
|
15361
15680
|
|scope<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Settings scope for conditional permission |
|
|
15362
15681
|
|
|
15682
|
+
### PlainAuthenticationDto
|
|
15683
|
+
|
|
15684
|
+
Plain authentication dto for Browser Monitor step.
|
|
15685
|
+
|
|
15686
|
+
| Name | Type | Description |
|
|
15687
|
+
| --- | --- | --- |
|
|
15688
|
+
|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
15689
|
+
|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
15690
|
+
|inputType<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureAuthenticationDto</li> <li><code>PLAIN</code> -> PlainAuthenticationDto</li> </ul> |
|
|
15691
|
+
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the password. |
|
|
15692
|
+
|type<sup>*required</sup>|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |
|
|
15693
|
+
|username|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the username. |
|
|
15694
|
+
|
|
15695
|
+
### PlainKeystrokesInputDto
|
|
15696
|
+
|
|
15697
|
+
Credential-based input for keystrokes step.
|
|
15698
|
+
|
|
15699
|
+
| Name | Type | Description |
|
|
15700
|
+
| --- | --- | --- |
|
|
15701
|
+
|masked|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if key strokes should be masked. If not defined in request, the default value will be set to false. |
|
|
15702
|
+
|textValue|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String value containing the text. |
|
|
15703
|
+
|type<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureKeystrokesInputDto</li> <li><code>PLAIN</code> -> PlainKeystrokesInputDto</li> </ul> |
|
|
15704
|
+
|
|
15363
15705
|
### Precondition
|
|
15364
15706
|
|
|
15365
15707
|
A precondition for visibility of a property.
|
|
@@ -15372,7 +15714,7 @@ A precondition for visibility of a property.
|
|
|
15372
15714
|
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property. |
|
|
15373
15715
|
|preconditions|Array<<a href="#precondition">Precondition</a>>|<p>A list of child preconditions to be evaluated.</p> <p>Only applicable to properties of the <code>AND</code> and <code>OR</code> types.</p> |
|
|
15374
15716
|
|property|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The property to be evaluated. |
|
|
15375
|
-
|type<sup>*required</sup>|"
|
|
15717
|
+
|type<sup>*required</sup>|"EQUALS" | "AND" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"|The type of the precondition. |
|
|
15376
15718
|
|
|
15377
15719
|
### PrivateSyntheticLocation
|
|
15378
15720
|
|
|
@@ -15392,6 +15734,7 @@ Configuration of a private synthetic location.
|
|
|
15392
15734
|
|countryName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The country name of the location. |
|
|
15393
15735
|
|deploymentType|"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"|<p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
|
|
15394
15736
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the location. |
|
|
15737
|
+
|fipsMode|"ENABLED" | "DISABLED" | "ENABLED_WITH_CORPORATE_PROXY"|<p>Containerized location property indicating whether FIPS mode is enabled on this location:</p> <ul> <li><code>DISABLED</code>: FIPS is not enabled on the location.</li> <li><code>ENABLED</code>: FIPS is enabled on the location.</li> <li><code>ENABLED_WITH_CORPORATE_PROXY</code>: FIPS with corporate proxy is enabled on this location. Default: DISABLED</li> </ul> |
|
|
15395
15738
|
|geoLocationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace GeoLocation ID of the location. |
|
|
15396
15739
|
|latitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The latitude of the location in <code>DDD.dddd</code> format. |
|
|
15397
15740
|
|locationNodeOutageDelayInMinutes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
|
|
@@ -15520,6 +15863,14 @@ Details that are specific to the used protocol.
|
|
|
15520
15863
|
| --- | --- | --- |
|
|
15521
15864
|
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|HTTP specific request details. |
|
|
15522
15865
|
|
|
15866
|
+
### ProxyDto
|
|
15867
|
+
|
|
15868
|
+
Browser Monitor proxy.
|
|
15869
|
+
|
|
15870
|
+
| Name | Type | Description |
|
|
15871
|
+
| --- | --- | --- |
|
|
15872
|
+
|pacUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|pacUrl |
|
|
15873
|
+
|
|
15523
15874
|
### PublicCertificateCredentials
|
|
15524
15875
|
|
|
15525
15876
|
A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
@@ -15655,7 +16006,7 @@ A Release is a combination of a component and a version.
|
|
|
15655
16006
|
A Component can be any form of deployable that can be associated with a version.
|
|
15656
16007
|
In the first draft, a Component is always a Service.
|
|
15657
16008
|
|
|
15658
|
-
The tuple &
|
|
16009
|
+
The tuple <name, product, stage, version> is always unique.
|
|
15659
16010
|
|
|
15660
16011
|
| Name | Type | Description |
|
|
15661
16012
|
| --- | --- | --- |
|
|
@@ -15914,6 +16265,24 @@ A vulnerable component with details for a remediation progress entity (PGI).
|
|
|
15914
16265
|
|loadOrigins|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The load origins of the vulnerable components. |
|
|
15915
16266
|
|shortName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The short, component-only name of the vulnerable component. |
|
|
15916
16267
|
|
|
16268
|
+
### RequestFilterDto
|
|
16269
|
+
|
|
16270
|
+
Request filter for Browser Monitor.
|
|
16271
|
+
|
|
16272
|
+
| Name | Type | Description |
|
|
16273
|
+
| --- | --- | --- |
|
|
16274
|
+
|matchingPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Regex for request that filter will be applied to. |
|
|
16275
|
+
|type<sup>*required</sup>|"REGEX" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "EQUALS"|Filter type. |
|
|
16276
|
+
|
|
16277
|
+
### RequestHeaderOptionsDto
|
|
16278
|
+
|
|
16279
|
+
Header Options of a Browser Monitor.
|
|
16280
|
+
|
|
16281
|
+
| Name | Type | Description |
|
|
16282
|
+
| --- | --- | --- |
|
|
16283
|
+
|matchingPatterns<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Apply headers to requests matching pattern. |
|
|
16284
|
+
|requestHeaders<sup>*required</sup>|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|Request headers list. |
|
|
16285
|
+
|
|
15917
16286
|
### RequestInformation
|
|
15918
16287
|
|
|
15919
16288
|
Describes the complete request information of an attack.
|
|
@@ -15922,14 +16291,14 @@ Describes the complete request information of an attack.
|
|
|
15922
16291
|
| --- | --- | --- |
|
|
15923
16292
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
15924
16293
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
15925
|
-
|protocolDetails|<a href="#protocoldetails"
|
|
16294
|
+
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>|Details that are specific to the used protocol. |
|
|
15926
16295
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
15927
16296
|
|
|
15928
16297
|
### ResolutionRequest
|
|
15929
16298
|
|
|
15930
16299
|
| Name | Type |
|
|
15931
16300
|
| --- | --- |
|
|
15932
|
-
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest">SinglePermissionRequest</a>>|
|
|
16301
|
+
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest" target="_blank" rel="noopener noreferrer">SinglePermissionRequest</a>>|
|
|
15933
16302
|
|
|
15934
16303
|
### ResourceContext
|
|
15935
16304
|
|
|
@@ -15937,7 +16306,7 @@ The resource context, which contains additional permission information about the
|
|
|
15937
16306
|
|
|
15938
16307
|
| Name | Type | Description |
|
|
15939
16308
|
| --- | --- | --- |
|
|
15940
|
-
|modifications<sup>*required</sup>|<a href="#modification"
|
|
16309
|
+
|modifications<sup>*required</sup>|<a href="#modification">Modification</a>|The additional modification details for this settings object. |
|
|
15941
16310
|
|operations<sup>*required</sup>|Array<"delete" | "read" | "write">|The allowed operations on this settings object. |
|
|
15942
16311
|
|
|
15943
16312
|
### RevisionDiff
|
|
@@ -15950,7 +16319,7 @@ The diff between two revisions.
|
|
|
15950
16319
|
|jsonAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The new value of the changed settings value or null if the value has been deleted. |
|
|
15951
16320
|
|jsonBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The previous value of the changed settings value or null if the value has been newly created. |
|
|
15952
16321
|
|jsonPatch|AnyValue|The JSON Patch for this value. May be null if the diff type is not UPDATE. |
|
|
15953
|
-
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
16322
|
+
|modificationInfo|<a href="#historymodificationinfo" target="_blank" rel="noopener noreferrer">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
15954
16323
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
15955
16324
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
15956
16325
|
|schemaDisplayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema to which the revision belongs. |
|
|
@@ -15967,7 +16336,7 @@ The paged response payload for diff between revisions of settings.
|
|
|
15967
16336
|
| Name | Type | Description |
|
|
15968
16337
|
| --- | --- | --- |
|
|
15969
16338
|
|endTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
15970
|
-
|items<sup>*required</sup>|Array<<a href="#revisiondiff"
|
|
16339
|
+
|items<sup>*required</sup>|Array<<a href="#revisiondiff">RevisionDiff</a>>|The list of revisions changes in the current page. |
|
|
15971
16340
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
15972
16341
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
15973
16342
|
|startTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
@@ -15979,7 +16348,7 @@ Risk assessment of a security problem.
|
|
|
15979
16348
|
| Name | Type | Description |
|
|
15980
16349
|
| --- | --- | --- |
|
|
15981
16350
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
15982
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
16351
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
15983
16352
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
15984
16353
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
15985
16354
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -16014,7 +16383,7 @@ Risk assessment of a security problem.
|
|
|
16014
16383
|
| Name | Type | Description |
|
|
16015
16384
|
| --- | --- | --- |
|
|
16016
16385
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
16017
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails"
|
|
16386
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
16018
16387
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
16019
16388
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
16020
16389
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -16034,7 +16403,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
16034
16403
|
| Name | Type | Description |
|
|
16035
16404
|
| --- | --- | --- |
|
|
16036
16405
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
16037
|
-
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
16406
|
+
|changes|<a href="#riskassessmentchanges" target="_blank" rel="noopener noreferrer">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
16038
16407
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities. |
|
|
16039
16408
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
16040
16409
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
@@ -16067,7 +16436,7 @@ Parameters of a service-level objective (SLO).
|
|
|
16067
16436
|
|enabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The SLO is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
16068
16437
|
|error<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The error of the SLO calculation.</p> <p>If the value differs from <code>NONE</code>, there is something wrong with the SLO calculation.</p> |
|
|
16069
16438
|
|errorBudget<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The error budget of the calculated SLO.</p> <p>The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.</p> <p>Has the value of the evaluated error budget or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
16070
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate"
|
|
16439
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>|Error budget burn rate evaluation of a service-level objective (SLO). |
|
|
16071
16440
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric. |
|
|
16072
16441
|
|evaluatedPercentage<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
16073
16442
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
@@ -16099,7 +16468,7 @@ Contains SLOs and paging information.
|
|
|
16099
16468
|
| --- | --- | --- |
|
|
16100
16469
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
16101
16470
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16102
|
-
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs. |
|
|
16471
|
+
|slo<sup>*required</sup>|Array<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>>|The list of SLOs. |
|
|
16103
16472
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
16104
16473
|
|
|
16105
16474
|
### SNMPV3Credentials
|
|
@@ -16109,7 +16478,7 @@ A credentials set of the `SNMPV3` type.
|
|
|
16109
16478
|
| Name | Type | Description |
|
|
16110
16479
|
| --- | --- | --- |
|
|
16111
16480
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
16112
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
16481
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
16113
16482
|
|authenticationPassword|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The authentication password in the string format (should not be empty for AUTH_PRIV and AUTH_NO_PRIV security levels) |
|
|
16114
16483
|
|authenticationProtocol|"MD5" | "SHA" | "SHA224" | "SHA256" | "SHA384" | "SHA512"|The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512 |
|
|
16115
16484
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
@@ -16141,25 +16510,25 @@ A credentials set of the `SNMPV3` type.
|
|
|
16141
16510
|
| Name | Type | Description |
|
|
16142
16511
|
| --- | --- | --- |
|
|
16143
16512
|
|allowedScopes<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of scopes where the schema can be used. |
|
|
16144
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
16145
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
16513
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
16514
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted. |
|
|
16146
16515
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema. |
|
|
16147
16516
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
16148
16517
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
16149
16518
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
16150
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
16519
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
16151
16520
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
16152
16521
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum amount of objects per scope.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
16153
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
16522
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting. |
|
|
16154
16523
|
|multiObject<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multiple (<code>true</code>) objects per scope are permitted or a single (<code>false</code>) object per scope is permitted. |
|
|
16155
16524
|
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the order of objects has semantic significance.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
16156
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
16157
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
16525
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
16526
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
16158
16527
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
16159
16528
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
16160
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
16161
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
16162
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
16529
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
16530
|
+
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a>|<p>A list of definitions of types.</p> <p>A type is a complex property that contains its own set of subproperties.</p> |
|
|
16531
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
16163
16532
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
16164
16533
|
|
|
16165
16534
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -16206,7 +16575,7 @@ The list of available settings schemas.
|
|
|
16206
16575
|
|
|
16207
16576
|
| Name | Type | Description |
|
|
16208
16577
|
| --- | --- | --- |
|
|
16209
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
16578
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas. |
|
|
16210
16579
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list. |
|
|
16211
16580
|
|
|
16212
16581
|
### SchemaStub
|
|
@@ -16230,11 +16599,11 @@ A list of definitions of types.
|
|
|
16230
16599
|
|
|
16231
16600
|
| Name | Type | Description |
|
|
16232
16601
|
| --- | --- | --- |
|
|
16233
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
16602
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
16234
16603
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
16235
16604
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
16236
16605
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
16237
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
16606
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>|Definition of properties that can be persisted. |
|
|
16238
16607
|
|searchPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary search(for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
16239
16608
|
|summaryPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary (for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
16240
16609
|
|type<sup>*required</sup>|"object"|Type of the reference type. |
|
|
@@ -16253,40 +16622,62 @@ Definition of properties that can be persisted.
|
|
|
16253
16622
|
| --- | --- | --- |
|
|
16254
16623
|
|versions<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of schema versions. |
|
|
16255
16624
|
|
|
16256
|
-
###
|
|
16625
|
+
### SecureAuthenticationDto
|
|
16626
|
+
|
|
16627
|
+
Secure authentication dto for Browser Monitor step.
|
|
16257
16628
|
|
|
16258
16629
|
| Name | Type | Description |
|
|
16259
16630
|
| --- | --- | --- |
|
|
16260
|
-
|
|
|
16631
|
+
|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
16632
|
+
|credentialId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the username and password credential which will be used for authentication. |
|
|
16633
|
+
|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
16634
|
+
|inputType<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureAuthenticationDto</li> <li><code>PLAIN</code> -> PlainAuthenticationDto</li> </ul> |
|
|
16635
|
+
|type<sup>*required</sup>|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |
|
|
16261
16636
|
|
|
16262
|
-
###
|
|
16637
|
+
### SecureKeystrokesInputDto
|
|
16263
16638
|
|
|
16264
|
-
|
|
16639
|
+
Credential-based input for keystrokes step.
|
|
16265
16640
|
|
|
16266
16641
|
| Name | Type | Description |
|
|
16267
16642
|
| --- | --- | --- |
|
|
16268
|
-
|
|
|
16269
|
-
|
|
|
16643
|
+
|credentialField|"TOKEN" | "USERNAME" | "PASSWORD"|Enum value of the credential field. |
|
|
16644
|
+
|credentialId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String value containing the credential id. |
|
|
16645
|
+
|type<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureKeystrokesInputDto</li> <li><code>PLAIN</code> -> PlainKeystrokesInputDto</li> </ul> |
|
|
16270
16646
|
|
|
16271
|
-
###
|
|
16647
|
+
### SecurityContextDtoImpl
|
|
16648
|
+
|
|
16649
|
+
| Name | Type | Description |
|
|
16650
|
+
| --- | --- | --- |
|
|
16651
|
+
|securityContext|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The security context, that will be set for matching entities. If there exists a management zone with this name, it will be set for all matching entities, overriding all automatic management zone rules. |
|
|
16652
|
+
|
|
16653
|
+
### SecurityContextResultDto
|
|
16654
|
+
|
|
16655
|
+
The response payload holding the result of the security context application.
|
|
16656
|
+
|
|
16657
|
+
| Name | Type | Description |
|
|
16658
|
+
| --- | --- | --- |
|
|
16659
|
+
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The entity ids that matched the entity selector and now have the supplied security context set. |
|
|
16660
|
+
|managementZoneIds|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The management zone ids that is applied to the entity ids, if the security context matched an existing management zone's name, otherwise null. |
|
|
16661
|
+
|
|
16662
|
+
### SecurityProblem
|
|
16272
16663
|
|
|
16273
16664
|
Parameters of a security problem
|
|
16274
16665
|
|
|
16275
16666
|
| Name | Type | Description |
|
|
16276
16667
|
| --- | --- | --- |
|
|
16277
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
16668
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
16278
16669
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
16279
16670
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
16280
16671
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
16281
16672
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
16282
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
16673
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
16283
16674
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
16284
16675
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
16285
16676
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
16286
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
16677
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
16287
16678
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
16288
16679
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
16289
|
-
|riskAssessment|<a href="#riskassessment"
|
|
16680
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>|Risk assessment of a security problem. |
|
|
16290
16681
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
16291
16682
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
16292
16683
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
@@ -16311,37 +16702,37 @@ Parameters of a security problem
|
|
|
16311
16702
|
| Name | Type | Description |
|
|
16312
16703
|
| --- | --- | --- |
|
|
16313
16704
|
|affectedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of affected entities of the security problem.</p> <p>An affected entity is an entity where a vulnerable component runs.</p> |
|
|
16314
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
16705
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
16315
16706
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
16316
16707
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
16317
16708
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
16318
|
-
|entryPoints|<a href="#entrypoints"
|
|
16319
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
16709
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>|A list of entry points and a flag which indicates whether this list was truncated or not. |
|
|
16710
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
16320
16711
|
|exposedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of exposed entities of the security problem.</p> <p>An exposed entity is an affected entity that is exposed to the internet.</p> |
|
|
16321
16712
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
16322
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
16713
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>|Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters. |
|
|
16323
16714
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
16324
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
16715
|
+
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
16325
16716
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
16326
16717
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
16327
16718
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
16328
|
-
|managementZones|Array<<a href="#managementzone"
|
|
16719
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
16329
16720
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress. |
|
|
16330
16721
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
16331
16722
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
16332
16723
|
|reachableDataAssets|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of data assets reachable by affected entities of the security problem.</p> <p>A data asset is a service that has database access.</p> |
|
|
16333
|
-
|relatedAttacks|<a href="#relatedattackslist">RelatedAttacksList</a>|<p>A list of related attacks of the security problem.</p> <p>Related attacks are attacks on the exposed security problem.</p> |
|
|
16334
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
16335
|
-
|relatedEntities|<a href="#relatedentitieslist">RelatedEntitiesList</a>|<p>A list of related entities of the security problem.</p> <p>A related entity is a monitored entity that is directly or indirectly related to an <em>affected entity</em> (for example, it could be a host where an affected process runs).</p> <p>Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).</p> |
|
|
16724
|
+
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a>|<p>A list of related attacks of the security problem.</p> <p>Related attacks are attacks on the exposed security problem.</p> |
|
|
16725
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>|A list of related container images. |
|
|
16726
|
+
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a>|<p>A list of related entities of the security problem.</p> <p>A related entity is a monitored entity that is directly or indirectly related to an <em>affected entity</em> (for example, it could be a host where an affected process runs).</p> <p>Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).</p> |
|
|
16336
16727
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
16337
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
16728
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>|Risk assessment of a security problem. |
|
|
16338
16729
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
16339
16730
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
16340
16731
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
16341
16732
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
16342
16733
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
16343
16734
|
|vulnerabilityType|"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"|The type of the vulnerability. |
|
|
16344
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
16735
|
+
|vulnerableComponents|Array<<a href="#vulnerablecomponent" target="_blank" rel="noopener noreferrer">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
16345
16736
|
|
|
16346
16737
|
### SecurityProblemEvent
|
|
16347
16738
|
|
|
@@ -16349,9 +16740,9 @@ The event of a security problem.
|
|
|
16349
16740
|
|
|
16350
16741
|
| Name | Type | Description |
|
|
16351
16742
|
| --- | --- | --- |
|
|
16352
|
-
|muteState|<a href="#mutestate"
|
|
16743
|
+
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event. |
|
|
16353
16744
|
|reason|"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED"|The reason of the event creation. |
|
|
16354
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
16745
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
16355
16746
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
16356
16747
|
|
|
16357
16748
|
### SecurityProblemEventsList
|
|
@@ -16360,7 +16751,7 @@ A list of events for a security problem.
|
|
|
16360
16751
|
|
|
16361
16752
|
| Name | Type | Description |
|
|
16362
16753
|
| --- | --- | --- |
|
|
16363
|
-
|events|Array<<a href="#securityproblemevent"
|
|
16754
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem. |
|
|
16364
16755
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
16365
16756
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16366
16757
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16373,7 +16764,7 @@ A list of security problems.
|
|
|
16373
16764
|
| --- | --- | --- |
|
|
16374
16765
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
16375
16766
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16376
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems. |
|
|
16767
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems. |
|
|
16377
16768
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
16378
16769
|
|
|
16379
16770
|
### SecurityProblemMute
|
|
@@ -16410,7 +16801,7 @@ Response of muting several security problems.
|
|
|
16410
16801
|
|
|
16411
16802
|
| Name | Type | Description |
|
|
16412
16803
|
| --- | --- | --- |
|
|
16413
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
16804
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously. |
|
|
16414
16805
|
|
|
16415
16806
|
### SecurityProblemsBulkUnmute
|
|
16416
16807
|
|
|
@@ -16428,7 +16819,30 @@ Response of un-muting several security problems.
|
|
|
16428
16819
|
|
|
16429
16820
|
| Name | Type | Description |
|
|
16430
16821
|
| --- | --- | --- |
|
|
16431
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
16822
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary" target="_blank" rel="noopener noreferrer">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
16823
|
+
|
|
16824
|
+
### SelectOptionStepDto
|
|
16825
|
+
|
|
16826
|
+
Select option step of Browser Monitor.
|
|
16827
|
+
|
|
16828
|
+
| Name | Type | Description |
|
|
16829
|
+
| --- | --- | --- |
|
|
16830
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
16831
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
16832
|
+
|selections|Array<<a href="#selectiondto">SelectionDto</a>>|Field containing the credential. |
|
|
16833
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
16834
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
16835
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
16836
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
16837
|
+
|
|
16838
|
+
### SelectionDto
|
|
16839
|
+
|
|
16840
|
+
Option selection for Browser Monitor step.
|
|
16841
|
+
|
|
16842
|
+
| Name | Type | Description |
|
|
16843
|
+
| --- | --- | --- |
|
|
16844
|
+
|index<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Selection index. |
|
|
16845
|
+
|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Selection value. |
|
|
16432
16846
|
|
|
16433
16847
|
### ServiceImpact
|
|
16434
16848
|
|
|
@@ -16438,7 +16852,7 @@ Analysis of problem impact to a service.
|
|
|
16438
16852
|
| --- | --- | --- |
|
|
16439
16853
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
16440
16854
|
|impactType<sup>*required</sup>|"APPLICATION" | "CUSTOM_APPLICATION" | "MOBILE" | "SERVICE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
16441
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
16855
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16442
16856
|
|numberOfPotentiallyAffectedServiceCalls|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
16443
16857
|
|
|
16444
16858
|
### SettingsObject
|
|
@@ -16451,12 +16865,12 @@ A settings object.
|
|
|
16451
16865
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
16452
16866
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
16453
16867
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
16454
|
-
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
16868
|
+
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
16455
16869
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
16456
16870
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
16457
16871
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
16458
|
-
|owner|<a href="#identity"
|
|
16459
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
16872
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
16873
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
16460
16874
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
16461
16875
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
16462
16876
|
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>. |
|
|
@@ -16478,8 +16892,8 @@ The response to a get by objectId request.
|
|
|
16478
16892
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
16479
16893
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
16480
16894
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
16481
|
-
|owner|<a href="#identity"
|
|
16482
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
16895
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
16896
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
16483
16897
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
16484
16898
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
16485
16899
|
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>. |
|
|
@@ -16509,7 +16923,7 @@ The response to a creation- or update-request.
|
|
|
16509
16923
|
| Name | Type | Description |
|
|
16510
16924
|
| --- | --- | --- |
|
|
16511
16925
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object. |
|
|
16512
|
-
|error|<a href="#error"
|
|
16926
|
+
|error|<a href="#error">Error</a>| |
|
|
16513
16927
|
|invalidValue|AnyValue|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
16514
16928
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object. |
|
|
16515
16929
|
|
|
@@ -16531,7 +16945,7 @@ A list of permissions.
|
|
|
16531
16945
|
|
|
16532
16946
|
| Name | Type | Description |
|
|
16533
16947
|
| --- | --- | --- |
|
|
16534
|
-
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
16948
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>|Optional context data |
|
|
16535
16949
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed |
|
|
16536
16950
|
|
|
16537
16951
|
### SloBurnRate
|
|
@@ -16562,7 +16976,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
16562
16976
|
| --- | --- | --- |
|
|
16563
16977
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
16564
16978
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The SLO is enabled (<code>true</code>) or disabled (<code>false</code>).</p> <p>If not defined, the SLO is disabled by default.</p> |
|
|
16565
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig"
|
|
16979
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>|Error budget burn rate configuration of a service-level objective (SLO). |
|
|
16566
16980
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
16567
16981
|
|filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the <a href="https://dt-url.net/entityselector" target="_blank" rel="noopener noreferrer" >syntax of entity selector</a>. |
|
|
16568
16982
|
|~~metricDenominator~~<sup>**DEPRECATED**</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The total count metric (the denominator in rate calculation).</p> <p>Required when the <strong>useRateMetric</strong> is set to <code>false</code>.</p> |
|
|
@@ -16608,7 +17022,84 @@ Parameters of a status alert.
|
|
|
16608
17022
|
|
|
16609
17023
|
| Name | Type |
|
|
16610
17024
|
| --- | --- |
|
|
16611
|
-
|details|<a href="#success">Success</a>|
|
|
17025
|
+
|details|<a href="#success" target="_blank" rel="noopener noreferrer">Success</a>|
|
|
17026
|
+
|
|
17027
|
+
### SyntheticBrowserMonitorConfigurationDto
|
|
17028
|
+
|
|
17029
|
+
Browser Monitor configuration.
|
|
17030
|
+
|
|
17031
|
+
| Name | Type | Description |
|
|
17032
|
+
| --- | --- | --- |
|
|
17033
|
+
|blockedRequests|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|All requests matching the specified patterns will be blocked during the execution of the monitor. |
|
|
17034
|
+
|browserPermissions|<a href="#browserpermissionsdto">BrowserPermissionsDto</a>|Permissions settings for browser. |
|
|
17035
|
+
|bypassCSP|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Bypass ContentSecurity Policy for monitored pages. If not defined in request, it will be set to false by default. |
|
|
17036
|
+
|chromiumStartupFlags|<a href="#chromiumstartupflagsdto" target="_blank" rel="noopener noreferrer">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor. |
|
|
17037
|
+
|clientCertificates|Array<<a href="#clientcertificatedto">ClientCertificateDto</a>>|Identifier of stored client's certificate. |
|
|
17038
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Cookies list. |
|
|
17039
|
+
|device<sup>*required</sup>|<a href="#testdevicedto">TestDeviceDto</a>|Test device of a Browser Monitor. |
|
|
17040
|
+
|experimentalProperties|Array<<a href="#monitorpropertydto" target="_blank" rel="noopener noreferrer">MonitorPropertyDto</a>>|Experimental properties list. |
|
|
17041
|
+
|filteredRequests|<a href="#filteredrequestsdto">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor. |
|
|
17042
|
+
|ignoredErrorCodes|<a href="#ignorederrorcodesdto" target="_blank" rel="noopener noreferrer">IgnoredErrorCodesDto</a>|Ignored Error Codes of a Browser Monitor. |
|
|
17043
|
+
|javaScriptSettings|<a href="#javascriptagentsettingsdto">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings. |
|
|
17044
|
+
|monitorFrames|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default. |
|
|
17045
|
+
|networkThrottling|<a href="#networkthrottlingdto" target="_blank" rel="noopener noreferrer">NetworkThrottlingDto</a>|Network throttling of a Browser Monitor. |
|
|
17046
|
+
|proxy|<a href="#proxydto">ProxyDto</a>|Browser Monitor proxy. |
|
|
17047
|
+
|requestHeaderOptions|<a href="#requestheaderoptionsdto" target="_blank" rel="noopener noreferrer">RequestHeaderOptionsDto</a>|Header Options of a Browser Monitor. |
|
|
17048
|
+
|useIESupportedAgent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|useIESupportedAgent flag. If not defined in request, it will be set to false by default. |
|
|
17049
|
+
|userAgent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User agent |
|
|
17050
|
+
|
|
17051
|
+
### SyntheticBrowserMonitorRequest
|
|
17052
|
+
|
|
17053
|
+
Browser monitor update.
|
|
17054
|
+
|
|
17055
|
+
| Name | Type | Description |
|
|
17056
|
+
| --- | --- | --- |
|
|
17057
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
17058
|
+
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
17059
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
17060
|
+
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
17061
|
+
|keyPerformanceMetrics|<a href="#keyperformancemetrics" target="_blank" rel="noopener noreferrer">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
17062
|
+
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
17063
|
+
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
17064
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17065
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17066
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
17067
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17068
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
17069
|
+
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
17070
|
+
|
|
17071
|
+
### SyntheticBrowserMonitorResponse
|
|
17072
|
+
|
|
17073
|
+
Browser Monitor.
|
|
17074
|
+
|
|
17075
|
+
| Name | Type | Description |
|
|
17076
|
+
| --- | --- | --- |
|
|
17077
|
+
|automaticallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Automatically assigned entities. |
|
|
17078
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
17079
|
+
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
17080
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. |
|
|
17081
|
+
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
17082
|
+
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
17083
|
+
|keyPerformanceMetrics<sup>*required</sup>|<a href="#keyperformancemetrics" target="_blank" rel="noopener noreferrer">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
17084
|
+
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
17085
|
+
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
17086
|
+
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
17087
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17088
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17089
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
17090
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17091
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
17092
|
+
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
17093
|
+
|
|
17094
|
+
### SyntheticBrowserMonitorStepDto
|
|
17095
|
+
|
|
17096
|
+
Base step of Browser Monitor.
|
|
17097
|
+
|
|
17098
|
+
| Name | Type | Description |
|
|
17099
|
+
| --- | --- | --- |
|
|
17100
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
17101
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
17102
|
+
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
16612
17103
|
|
|
16613
17104
|
### SyntheticConfigDto
|
|
16614
17105
|
|
|
@@ -16665,7 +17156,7 @@ A list of synthetic locations.
|
|
|
16665
17156
|
|
|
16666
17157
|
| Name | Type | Description |
|
|
16667
17158
|
| --- | --- | --- |
|
|
16668
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement"
|
|
17159
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
16669
17160
|
|
|
16670
17161
|
### SyntheticMonitorConstraintDto
|
|
16671
17162
|
|
|
@@ -16673,7 +17164,7 @@ Synthetic monitor constraint.
|
|
|
16673
17164
|
|
|
16674
17165
|
| Name | Type | Description |
|
|
16675
17166
|
| --- | --- | --- |
|
|
16676
|
-
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties">SyntheticMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
17167
|
+
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
16677
17168
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
16678
17169
|
|
|
16679
17170
|
### SyntheticMonitorConstraintDtoProperties
|
|
@@ -16682,13 +17173,24 @@ The properties of the constraint.
|
|
|
16682
17173
|
|
|
16683
17174
|
**type**: Record<string, string | undefined>
|
|
16684
17175
|
|
|
17176
|
+
### SyntheticMonitorCookieDto
|
|
17177
|
+
|
|
17178
|
+
Cookie dto for Synthetic Monitor step.
|
|
17179
|
+
|
|
17180
|
+
| Name | Type | Description |
|
|
17181
|
+
| --- | --- | --- |
|
|
17182
|
+
|domain<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cookie domain. |
|
|
17183
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cookie name. |
|
|
17184
|
+
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cookie path. |
|
|
17185
|
+
|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cookie value. |
|
|
17186
|
+
|
|
16685
17187
|
### SyntheticMonitorListDto
|
|
16686
17188
|
|
|
16687
17189
|
List of available synthetic monitors.
|
|
16688
17190
|
|
|
16689
17191
|
| Name | Type | Description |
|
|
16690
17192
|
| --- | --- | --- |
|
|
16691
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto"
|
|
17193
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
16692
17194
|
|
|
16693
17195
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
16694
17196
|
|
|
@@ -16723,7 +17225,7 @@ Performance thresholds configuration.
|
|
|
16723
17225
|
| Name | Type | Description |
|
|
16724
17226
|
| --- | --- | --- |
|
|
16725
17227
|
|enabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
16726
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
17228
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
16727
17229
|
|
|
16728
17230
|
### SyntheticMonitorSummaryDto
|
|
16729
17231
|
|
|
@@ -16747,11 +17249,11 @@ Network Availability monitor.
|
|
|
16747
17249
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
16748
17250
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
16749
17251
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
16750
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
16751
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
16752
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
16753
|
-
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
16754
|
-
|type<sup>*required</sup>|"MULTI_PROTOCOL"|Monitor type. |
|
|
17252
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17253
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
17254
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17255
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
17256
|
+
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
16755
17257
|
|
|
16756
17258
|
### SyntheticMultiProtocolMonitorResponse
|
|
16757
17259
|
|
|
@@ -16760,17 +17262,17 @@ Network Availability monitor.
|
|
|
16760
17262
|
| Name | Type | Description |
|
|
16761
17263
|
| --- | --- | --- |
|
|
16762
17264
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
16763
|
-
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.
|
|
17265
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. |
|
|
16764
17266
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
16765
17267
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
16766
|
-
|locations
|
|
17268
|
+
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
16767
17269
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
16768
|
-
|name
|
|
16769
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
16770
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
16771
|
-
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
16772
|
-
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
16773
|
-
|type<sup>*required</sup>|"BROWSER" | "
|
|
17270
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17271
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17272
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
17273
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17274
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
17275
|
+
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
16774
17276
|
|
|
16775
17277
|
### SyntheticMultiProtocolMonitorStepDto
|
|
16776
17278
|
|
|
@@ -16778,10 +17280,10 @@ The step of a network availability monitor.
|
|
|
16778
17280
|
|
|
16779
17281
|
| Name | Type | Description |
|
|
16780
17282
|
| --- | --- | --- |
|
|
16781
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
17283
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
16782
17284
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
16783
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
16784
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto"
|
|
17285
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
17286
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
16785
17287
|
|requestType<sup>*required</sup>|"ICMP" | "TCP" | "DNS"|Request type. |
|
|
16786
17288
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
16787
17289
|
|targetList|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -16798,7 +17300,7 @@ The configuration of a network availability monitor request.
|
|
|
16798
17300
|
|
|
16799
17301
|
| Name | Type | Description |
|
|
16800
17302
|
| --- | --- | --- |
|
|
16801
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|Request constraints. |
|
|
17303
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDto</a>>|Request constraints. |
|
|
16802
17304
|
|
|
16803
17305
|
### SyntheticOnDemandBatchStatus
|
|
16804
17306
|
|
|
@@ -16810,12 +17312,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
16810
17312
|
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"|The status of the batch. |
|
|
16811
17313
|
|executedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result SUCCESS or FAILED. |
|
|
16812
17314
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
16813
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
16814
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
17315
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
17316
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
16815
17317
|
|failedToExecuteCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were triggered and timed out because of a problem with the Synthetic engine. |
|
|
16816
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata"
|
|
17318
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
16817
17319
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
16818
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
17320
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
16819
17321
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
16820
17322
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered execution of the batch. |
|
|
16821
17323
|
|
|
@@ -16837,14 +17339,14 @@ Describes the status of an on-demand execution.
|
|
|
16837
17339
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
16838
17340
|
|executionStage<sup>*required</sup>|"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"|Execution stage. |
|
|
16839
17341
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
16840
|
-
|fullResults|<a href="#executionfullresults"
|
|
17342
|
+
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
16841
17343
|
|locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the location from where the monitor is to be executed. |
|
|
16842
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
17344
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
16843
17345
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
16844
|
-
|nextExecutionId|[
|
|
17346
|
+
|nextExecutionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Next execution id for sequential mode. |
|
|
16845
17347
|
|processingMode<sup>*required</sup>|"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The processing mode of the execution. |
|
|
16846
17348
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
16847
|
-
|simpleResults|<a href="#executionsimpleresults"
|
|
17349
|
+
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
16848
17350
|
|source<sup>*required</sup>|"API" | "UI"|The source of the triggering request. |
|
|
16849
17351
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered the on-demand execution. |
|
|
16850
17352
|
|
|
@@ -16862,9 +17364,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
16862
17364
|
| --- | --- | --- |
|
|
16863
17365
|
|failOnPerformanceIssue|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code>|
|
|
16864
17366
|
|failOnSslWarning|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code>|
|
|
16865
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
16866
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata"
|
|
16867
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
17367
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
17368
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
17369
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
16868
17370
|
|processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode <i>default:</i> <code>"STANDARD"</code>|
|
|
16869
17371
|
|stopOnProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code>|
|
|
16870
17372
|
|takeScreenshotsOnSuccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code>|
|
|
@@ -16905,10 +17407,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
16905
17407
|
| Name | Type | Description |
|
|
16906
17408
|
| --- | --- | --- |
|
|
16907
17409
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
16908
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor"
|
|
17410
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
16909
17411
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
16910
17412
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
16911
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
17413
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
16912
17414
|
|
|
16913
17415
|
### SyntheticOnDemandExecutions
|
|
16914
17416
|
|
|
@@ -16916,7 +17418,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
16916
17418
|
|
|
16917
17419
|
| Name | Type | Description |
|
|
16918
17420
|
| --- | --- | --- |
|
|
16919
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution"
|
|
17421
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
16920
17422
|
|
|
16921
17423
|
### SyntheticOnDemandFailedExecutionStatus
|
|
16922
17424
|
|
|
@@ -16947,7 +17449,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
16947
17449
|
|
|
16948
17450
|
| Name | Type | Description |
|
|
16949
17451
|
| --- | --- | --- |
|
|
16950
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
17452
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
16951
17453
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
16952
17454
|
|
|
16953
17455
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -16959,7 +17461,7 @@ Contains the details of problems encountered while triggering on-demand executio
|
|
|
16959
17461
|
|cause<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cause of not triggering entity. |
|
|
16960
17462
|
|details<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The details of triggering problem. |
|
|
16961
17463
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity identifier. |
|
|
16962
|
-
|executionId<sup>*required</sup>|[
|
|
17464
|
+
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The execution identifier. |
|
|
16963
17465
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The location identifier. |
|
|
16964
17466
|
|
|
16965
17467
|
### SyntheticPrivateLocationUpdate
|
|
@@ -16976,6 +17478,7 @@ Configuration of a private synthetic location
|
|
|
16976
17478
|
|city|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The city of the location. |
|
|
16977
17479
|
|countryCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go" target="_blank" rel="noopener noreferrer" >GET all countries</a> request.</p> |
|
|
16978
17480
|
|deploymentType|"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"|<p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
|
|
17481
|
+
|fipsMode|"ENABLED" | "DISABLED" | "ENABLED_WITH_CORPORATE_PROXY"|<p>Containerized location property indicating whether FIPS mode is enabled on this location:</p> <ul> <li><code>DISABLED</code>: FIPS is not enabled on the location.</li> <li><code>ENABLED</code>: FIPS is enabled on the location.</li> <li><code>ENABLED_WITH_CORPORATE_PROXY</code>: FIPS with corporate proxy is enabled on this location. Default: DISABLED</li> </ul> |
|
|
16979
17482
|
|latitude|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The latitude of the location in <code>DDD.dddd</code> format. |
|
|
16980
17483
|
|locationNodeOutageDelayInMinutes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
|
|
16981
17484
|
|longitude|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
@@ -17026,6 +17529,15 @@ The definition of a table column to be used in the ui.
|
|
|
17026
17529
|
| --- | --- | --- |
|
|
17027
17530
|
|pattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Pattern with references to properties to create a single value for the column. |
|
|
17028
17531
|
|
|
17532
|
+
### TargetDto
|
|
17533
|
+
|
|
17534
|
+
Target of Browser Monitor step.
|
|
17535
|
+
|
|
17536
|
+
| Name | Type | Description |
|
|
17537
|
+
| --- | --- | --- |
|
|
17538
|
+
|locators<sup>*required</sup>|Array<<a href="#locatordto">LocatorDto</a>>|List of locators. |
|
|
17539
|
+
|window<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target window. |
|
|
17540
|
+
|
|
17029
17541
|
### TenantToken
|
|
17030
17542
|
|
|
17031
17543
|
Tenant token
|
|
@@ -17043,6 +17555,36 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
17043
17555
|
|active|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token |
|
|
17044
17556
|
|old|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
17045
17557
|
|
|
17558
|
+
### TestDeviceDto
|
|
17559
|
+
|
|
17560
|
+
Test device of a Browser Monitor.
|
|
17561
|
+
|
|
17562
|
+
| Name | Type | Description |
|
|
17563
|
+
| --- | --- | --- |
|
|
17564
|
+
|height<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Device height in px. |
|
|
17565
|
+
|mobile|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Device is mobile. If not defined in request, it will be set to false by default. |
|
|
17566
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Device name. |
|
|
17567
|
+
|touchEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Device is touch enabled. If not defined in request, it will be set to false by default. |
|
|
17568
|
+
|width<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Device width in px. |
|
|
17569
|
+
|
|
17570
|
+
### TimeWaitConditionDto
|
|
17571
|
+
|
|
17572
|
+
Time wait condition for Browser Monitor step.
|
|
17573
|
+
|
|
17574
|
+
| Name | Type | Description |
|
|
17575
|
+
| --- | --- | --- |
|
|
17576
|
+
|milliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Wait time in milliseconds. |
|
|
17577
|
+
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
17578
|
+
|
|
17579
|
+
### TimeoutSettingsDto
|
|
17580
|
+
|
|
17581
|
+
Timeout settings of a Browser Monitor.
|
|
17582
|
+
|
|
17583
|
+
| Name | Type | Description |
|
|
17584
|
+
| --- | --- | --- |
|
|
17585
|
+
|temporaryActionLimit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Cascading setTimeout calls number limit. If not defined in request, it will be set to 1 by default. |
|
|
17586
|
+
|temporaryActionTotalTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|No additional timeout actions will be created once this time limit is reached. Value must be higher than 0 ms. If not defined in request, it will be set to 100 by default. |
|
|
17587
|
+
|
|
17046
17588
|
### ToPosition
|
|
17047
17589
|
|
|
17048
17590
|
The TO position of a relationship.
|
|
@@ -17365,6 +17907,40 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
17365
17907
|
|linesOk|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
17366
17908
|
|warnings|<a href="#warnings">Warnings</a>|
|
|
17367
17909
|
|
|
17910
|
+
### ValidationRuleDto
|
|
17911
|
+
|
|
17912
|
+
Validation rule of Browser Monitor step.
|
|
17913
|
+
|
|
17914
|
+
| Name | Type | Description |
|
|
17915
|
+
| --- | --- | --- |
|
|
17916
|
+
|failIfFound<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if we should fail on found pattern. If not defined in request, it will be set to false by default. |
|
|
17917
|
+
|matchingPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Text pattern that should match on the website. |
|
|
17918
|
+
|regex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if the "matchingPattern" value is a regex. If not defined in request, it will be set to false by default. |
|
|
17919
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
17920
|
+
|type<sup>*required</sup>|"TEXT_MATCH" | "CONTENT_MATCH" | "ELEMENT_MATCH"|Type of validation. |
|
|
17921
|
+
|
|
17922
|
+
### ValidationWaitConditionDto
|
|
17923
|
+
|
|
17924
|
+
Validation wait condition for Browser Monitor step.
|
|
17925
|
+
|
|
17926
|
+
| Name | Type | Description |
|
|
17927
|
+
| --- | --- | --- |
|
|
17928
|
+
|timeoutInMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Validation timeout in milliseconds. |
|
|
17929
|
+
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
17930
|
+
|validationRule|<a href="#validationruledto">ValidationRuleDto</a>|Validation rule of Browser Monitor step. |
|
|
17931
|
+
|
|
17932
|
+
### VisuallyCompleteOptionsDto
|
|
17933
|
+
|
|
17934
|
+
Visually Complete Options of a Browser Monitor.
|
|
17935
|
+
|
|
17936
|
+
| Name | Type | Description |
|
|
17937
|
+
| --- | --- | --- |
|
|
17938
|
+
|excludedElements|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Query CSS selectors to specify mutation nodes (elements that change) to ignore in Visually complete and Speed index calculation. |
|
|
17939
|
+
|excludedUrls|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Use regular expressions to define URLs for images and iFrames to exclude from detection by the Visually complete module. |
|
|
17940
|
+
|imageSizeThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Use this setting to define the minimum visible area per element (in pixels) for an element to be counted towards Visually complete and Speed index. If not defined in request, it will be set to 50 by default. |
|
|
17941
|
+
|inactivityTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time the Visually complete module waits for inactivity and no further mutations on the page after the load action. If not defined in request, it will be set to 1000 by default. |
|
|
17942
|
+
|mutationTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time the Visually complete module waits after an XHR or custom action closes to start the calculation. If not defined in request, it will be set to 50 by default. |
|
|
17943
|
+
|
|
17368
17944
|
### Vulnerability
|
|
17369
17945
|
|
|
17370
17946
|
Describes the exploited vulnerability.
|
|
@@ -17904,7 +18480,7 @@ The type of the asset.
|
|
|
17904
18480
|
|
|
17905
18481
|
<div class="padding-left--md">
|
|
17906
18482
|
|
|
17907
|
-
`Alert` | `AlertTemplate` | `AwsService` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DocumentDashboard` | `DqlLogMetric` | `DqlLogProcessingRule` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `LqlLogMetric` | `LqlLogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ProcessGroupingRules` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
18483
|
+
`Alert` | `AlertTemplate` | `AwsService` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DocumentDashboard` | `DqlLogMetric` | `DqlLogProcessingRule` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `LqlLogMetric` | `LqlLogProcessingRule` | `MetricMetadata` | `MetricQuery` | `OpenPipeline` | `ProcessGroupingRules` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
17908
18484
|
|
|
17909
18485
|
</div>
|
|
17910
18486
|
|
|
@@ -18093,6 +18669,99 @@ The type of the authentication of the **user**.
|
|
|
18093
18669
|
</div>
|
|
18094
18670
|
|
|
18095
18671
|
|
|
18672
|
+
</div>
|
|
18673
|
+
|
|
18674
|
+
<a name="authenticationdtoinputtype"></a>
|
|
18675
|
+
### ~~AuthenticationDtoInputType~~
|
|
18676
|
+
|
|
18677
|
+
> ⚠️ **Deprecated**
|
|
18678
|
+
> Use literal values.
|
|
18679
|
+
|
|
18680
|
+
<div class="padding-left--md">
|
|
18681
|
+
|
|
18682
|
+
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
18683
|
+
|
|
18684
|
+
* `SECURE` -> SecureAuthenticationDto
|
|
18685
|
+
* `PLAIN` -> PlainAuthenticationDto
|
|
18686
|
+
|
|
18687
|
+
#### Enum keys
|
|
18688
|
+
|
|
18689
|
+
<div class="padding-left--md">
|
|
18690
|
+
|
|
18691
|
+
`Plain` | `Secure`
|
|
18692
|
+
|
|
18693
|
+
</div>
|
|
18694
|
+
|
|
18695
|
+
|
|
18696
|
+
</div>
|
|
18697
|
+
|
|
18698
|
+
<a name="authenticationdtotype"></a>
|
|
18699
|
+
### ~~AuthenticationDtoType~~
|
|
18700
|
+
|
|
18701
|
+
> ⚠️ **Deprecated**
|
|
18702
|
+
> Use literal values.
|
|
18703
|
+
|
|
18704
|
+
<div class="padding-left--md">
|
|
18705
|
+
|
|
18706
|
+
Type of authentication.
|
|
18707
|
+
|
|
18708
|
+
#### Enum keys
|
|
18709
|
+
|
|
18710
|
+
<div class="padding-left--md">
|
|
18711
|
+
|
|
18712
|
+
`HttpAuthentication` | `Kerberos` | `Webform`
|
|
18713
|
+
|
|
18714
|
+
</div>
|
|
18715
|
+
|
|
18716
|
+
|
|
18717
|
+
</div>
|
|
18718
|
+
|
|
18719
|
+
<a name="basewaitconditiondtotype"></a>
|
|
18720
|
+
### ~~BaseWaitConditionDtoType~~
|
|
18721
|
+
|
|
18722
|
+
> ⚠️ **Deprecated**
|
|
18723
|
+
> Use literal values.
|
|
18724
|
+
|
|
18725
|
+
<div class="padding-left--md">
|
|
18726
|
+
|
|
18727
|
+
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
18728
|
+
|
|
18729
|
+
* `TIME` -> TimeWaitConditionDto
|
|
18730
|
+
* `VALIDATION` -> ValidationWaitConditionDto
|
|
18731
|
+
* `PAGE_COMPLETE` -> BaseWaitConditionDto
|
|
18732
|
+
* `NETWORK` -> BaseWaitConditionDto
|
|
18733
|
+
* `NEXT_EVENT` -> BaseWaitConditionDto
|
|
18734
|
+
|
|
18735
|
+
#### Enum keys
|
|
18736
|
+
|
|
18737
|
+
<div class="padding-left--md">
|
|
18738
|
+
|
|
18739
|
+
`Network` | `NextEvent` | `PageComplete` | `Time` | `Validation`
|
|
18740
|
+
|
|
18741
|
+
</div>
|
|
18742
|
+
|
|
18743
|
+
|
|
18744
|
+
</div>
|
|
18745
|
+
|
|
18746
|
+
<a name="chromiumstartupflagsdtoautoplaypolicy"></a>
|
|
18747
|
+
### ~~ChromiumStartupFlagsDtoAutoplayPolicy~~
|
|
18748
|
+
|
|
18749
|
+
> ⚠️ **Deprecated**
|
|
18750
|
+
> Use literal values.
|
|
18751
|
+
|
|
18752
|
+
<div class="padding-left--md">
|
|
18753
|
+
|
|
18754
|
+
autoplay-policy type.
|
|
18755
|
+
|
|
18756
|
+
#### Enum keys
|
|
18757
|
+
|
|
18758
|
+
<div class="padding-left--md">
|
|
18759
|
+
|
|
18760
|
+
`DocumentUserActivationRequired` | `NoUserGestureRequired`
|
|
18761
|
+
|
|
18762
|
+
</div>
|
|
18763
|
+
|
|
18764
|
+
|
|
18096
18765
|
</div>
|
|
18097
18766
|
|
|
18098
18767
|
<a name="codelevelvulnerabilitydetailstype"></a>
|
|
@@ -18560,7 +19229,7 @@ The type of the event.
|
|
|
18560
19229
|
|
|
18561
19230
|
<div class="padding-left--md">
|
|
18562
19231
|
|
|
18563
|
-
`AvailabilityEvent` | `CustomAlert` | `CustomAnnotation` | `CustomConfiguration` | `CustomDeployment` | `CustomInfo` | `ErrorEvent` | `MarkedForTermination` | `PerformanceEvent` | `ResourceContentionEvent`
|
|
19232
|
+
`AvailabilityEvent` | `CustomAlert` | `CustomAnnotation` | `CustomConfiguration` | `CustomDeployment` | `CustomInfo` | `ErrorEvent` | `MarkedForTermination` | `PerformanceEvent` | `ResourceContentionEvent` | `Warning`
|
|
18564
19233
|
|
|
18565
19234
|
</div>
|
|
18566
19235
|
|
|
@@ -18855,6 +19524,27 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
18855
19524
|
</div>
|
|
18856
19525
|
|
|
18857
19526
|
|
|
19527
|
+
</div>
|
|
19528
|
+
|
|
19529
|
+
<a name="filteredrequestsdtomode"></a>
|
|
19530
|
+
### ~~FilteredRequestsDtoMode~~
|
|
19531
|
+
|
|
19532
|
+
> ⚠️ **Deprecated**
|
|
19533
|
+
> Use literal values.
|
|
19534
|
+
|
|
19535
|
+
<div class="padding-left--md">
|
|
19536
|
+
|
|
19537
|
+
Filter mode for filtered requests.
|
|
19538
|
+
|
|
19539
|
+
#### Enum keys
|
|
19540
|
+
|
|
19541
|
+
<div class="padding-left--md">
|
|
19542
|
+
|
|
19543
|
+
`Allow` | `Block`
|
|
19544
|
+
|
|
19545
|
+
</div>
|
|
19546
|
+
|
|
19547
|
+
|
|
18858
19548
|
</div>
|
|
18859
19549
|
|
|
18860
19550
|
<a name="getallactivegatesqueryautoupdate"></a>
|
|
@@ -19595,6 +20285,72 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
19595
20285
|
</div>
|
|
19596
20286
|
|
|
19597
20287
|
|
|
20288
|
+
</div>
|
|
20289
|
+
|
|
20290
|
+
<a name="keyperformancemetricsloadactionkpm"></a>
|
|
20291
|
+
### ~~KeyPerformanceMetricsLoadActionKpm~~
|
|
20292
|
+
|
|
20293
|
+
> ⚠️ **Deprecated**
|
|
20294
|
+
> Use literal values.
|
|
20295
|
+
|
|
20296
|
+
<div class="padding-left--md">
|
|
20297
|
+
|
|
20298
|
+
Load action key performance metric.
|
|
20299
|
+
|
|
20300
|
+
#### Enum keys
|
|
20301
|
+
|
|
20302
|
+
<div class="padding-left--md">
|
|
20303
|
+
|
|
20304
|
+
`CumulativeLayoutShift` | `DomInteractive` | `LargestContentfulPaint` | `LoadEventEnd` | `LoadEventStart` | `ResponseEnd` | `ResponseStart` | `SpeedIndex` | `UserActionDuration` | `VisuallyComplete`
|
|
20305
|
+
|
|
20306
|
+
</div>
|
|
20307
|
+
|
|
20308
|
+
|
|
20309
|
+
</div>
|
|
20310
|
+
|
|
20311
|
+
<a name="keyperformancemetricsxhractionkpm"></a>
|
|
20312
|
+
### ~~KeyPerformanceMetricsXhrActionKpm~~
|
|
20313
|
+
|
|
20314
|
+
> ⚠️ **Deprecated**
|
|
20315
|
+
> Use literal values.
|
|
20316
|
+
|
|
20317
|
+
<div class="padding-left--md">
|
|
20318
|
+
|
|
20319
|
+
XHR action key performance metric.
|
|
20320
|
+
|
|
20321
|
+
#### Enum keys
|
|
20322
|
+
|
|
20323
|
+
<div class="padding-left--md">
|
|
20324
|
+
|
|
20325
|
+
`ResponseEnd` | `ResponseStart` | `UserActionDuration` | `VisuallyComplete`
|
|
20326
|
+
|
|
20327
|
+
</div>
|
|
20328
|
+
|
|
20329
|
+
|
|
20330
|
+
</div>
|
|
20331
|
+
|
|
20332
|
+
<a name="keystrokesinputdtotype"></a>
|
|
20333
|
+
### ~~KeystrokesInputDtoType~~
|
|
20334
|
+
|
|
20335
|
+
> ⚠️ **Deprecated**
|
|
20336
|
+
> Use literal values.
|
|
20337
|
+
|
|
20338
|
+
<div class="padding-left--md">
|
|
20339
|
+
|
|
20340
|
+
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
20341
|
+
|
|
20342
|
+
* `SECURE` -> SecureKeystrokesInputDto
|
|
20343
|
+
* `PLAIN` -> PlainKeystrokesInputDto
|
|
20344
|
+
|
|
20345
|
+
#### Enum keys
|
|
20346
|
+
|
|
20347
|
+
<div class="padding-left--md">
|
|
20348
|
+
|
|
20349
|
+
`Plain` | `Secure`
|
|
20350
|
+
|
|
20351
|
+
</div>
|
|
20352
|
+
|
|
20353
|
+
|
|
19598
20354
|
</div>
|
|
19599
20355
|
|
|
19600
20356
|
<a name="listcredentialsquerytype"></a>
|
|
@@ -19723,6 +20479,27 @@ The type of the location.
|
|
|
19723
20479
|
</div>
|
|
19724
20480
|
|
|
19725
20481
|
|
|
20482
|
+
</div>
|
|
20483
|
+
|
|
20484
|
+
<a name="locatordtotype"></a>
|
|
20485
|
+
### ~~LocatorDtoType~~
|
|
20486
|
+
|
|
20487
|
+
> ⚠️ **Deprecated**
|
|
20488
|
+
> Use literal values.
|
|
20489
|
+
|
|
20490
|
+
<div class="padding-left--md">
|
|
20491
|
+
|
|
20492
|
+
Enum value of the locator type.
|
|
20493
|
+
|
|
20494
|
+
#### Enum keys
|
|
20495
|
+
|
|
20496
|
+
<div class="padding-left--md">
|
|
20497
|
+
|
|
20498
|
+
`Css` | `Dom`
|
|
20499
|
+
|
|
20500
|
+
</div>
|
|
20501
|
+
|
|
20502
|
+
|
|
19726
20503
|
</div>
|
|
19727
20504
|
|
|
19728
20505
|
<a name="logrecordeventtype"></a>
|
|
@@ -20049,6 +20826,32 @@ The deployment type of the location:
|
|
|
20049
20826
|
</div>
|
|
20050
20827
|
|
|
20051
20828
|
|
|
20829
|
+
</div>
|
|
20830
|
+
|
|
20831
|
+
<a name="privatesyntheticlocationfipsmode"></a>
|
|
20832
|
+
### ~~PrivateSyntheticLocationFipsMode~~
|
|
20833
|
+
|
|
20834
|
+
> ⚠️ **Deprecated**
|
|
20835
|
+
> Use literal values.
|
|
20836
|
+
|
|
20837
|
+
<div class="padding-left--md">
|
|
20838
|
+
|
|
20839
|
+
Containerized location property indicating whether FIPS mode is enabled on this location:
|
|
20840
|
+
|
|
20841
|
+
* `DISABLED`: FIPS is not enabled on the location.
|
|
20842
|
+
* `ENABLED`: FIPS is enabled on the location.
|
|
20843
|
+
* `ENABLED_WITH_CORPORATE_PROXY`: FIPS with corporate proxy is enabled on this location.
|
|
20844
|
+
Default: DISABLED
|
|
20845
|
+
|
|
20846
|
+
#### Enum keys
|
|
20847
|
+
|
|
20848
|
+
<div class="padding-left--md">
|
|
20849
|
+
|
|
20850
|
+
`Disabled` | `Enabled` | `EnabledWithCorporateProxy`
|
|
20851
|
+
|
|
20852
|
+
</div>
|
|
20853
|
+
|
|
20854
|
+
|
|
20052
20855
|
</div>
|
|
20053
20856
|
|
|
20054
20857
|
<a name="privatesyntheticlocationstatus"></a>
|
|
@@ -20494,6 +21297,27 @@ The current state of the remediation progress entity.
|
|
|
20494
21297
|
</div>
|
|
20495
21298
|
|
|
20496
21299
|
|
|
21300
|
+
</div>
|
|
21301
|
+
|
|
21302
|
+
<a name="requestfilterdtotype"></a>
|
|
21303
|
+
### ~~RequestFilterDtoType~~
|
|
21304
|
+
|
|
21305
|
+
> ⚠️ **Deprecated**
|
|
21306
|
+
> Use literal values.
|
|
21307
|
+
|
|
21308
|
+
<div class="padding-left--md">
|
|
21309
|
+
|
|
21310
|
+
Filter type.
|
|
21311
|
+
|
|
21312
|
+
#### Enum keys
|
|
21313
|
+
|
|
21314
|
+
<div class="padding-left--md">
|
|
21315
|
+
|
|
21316
|
+
`Contains` | `EndsWith` | `Equals` | `Regex` | `StartsWith`
|
|
21317
|
+
|
|
21318
|
+
</div>
|
|
21319
|
+
|
|
21320
|
+
|
|
20497
21321
|
</div>
|
|
20498
21322
|
|
|
20499
21323
|
<a name="resourcecontextoperationsitem"></a>
|
|
@@ -21384,6 +22208,77 @@ The status of the calculated SLO.
|
|
|
21384
22208
|
</div>
|
|
21385
22209
|
|
|
21386
22210
|
|
|
22211
|
+
</div>
|
|
22212
|
+
|
|
22213
|
+
<a name="syntheticbrowsermonitorrequesttype"></a>
|
|
22214
|
+
### ~~SyntheticBrowserMonitorRequestType~~
|
|
22215
|
+
|
|
22216
|
+
> ⚠️ **Deprecated**
|
|
22217
|
+
> Use literal values.
|
|
22218
|
+
|
|
22219
|
+
<div class="padding-left--md">
|
|
22220
|
+
|
|
22221
|
+
Monitor type.
|
|
22222
|
+
|
|
22223
|
+
#### Enum keys
|
|
22224
|
+
|
|
22225
|
+
<div class="padding-left--md">
|
|
22226
|
+
|
|
22227
|
+
`Browser` | `MultiProtocol`
|
|
22228
|
+
|
|
22229
|
+
</div>
|
|
22230
|
+
|
|
22231
|
+
|
|
22232
|
+
</div>
|
|
22233
|
+
|
|
22234
|
+
<a name="syntheticbrowsermonitorresponsetype"></a>
|
|
22235
|
+
### ~~SyntheticBrowserMonitorResponseType~~
|
|
22236
|
+
|
|
22237
|
+
> ⚠️ **Deprecated**
|
|
22238
|
+
> Use literal values.
|
|
22239
|
+
|
|
22240
|
+
<div class="padding-left--md">
|
|
22241
|
+
|
|
22242
|
+
Monitor type.
|
|
22243
|
+
|
|
22244
|
+
#### Enum keys
|
|
22245
|
+
|
|
22246
|
+
<div class="padding-left--md">
|
|
22247
|
+
|
|
22248
|
+
`Browser` | `MultiProtocol`
|
|
22249
|
+
|
|
22250
|
+
</div>
|
|
22251
|
+
|
|
22252
|
+
|
|
22253
|
+
</div>
|
|
22254
|
+
|
|
22255
|
+
<a name="syntheticbrowsermonitorstepdtotype"></a>
|
|
22256
|
+
### ~~SyntheticBrowserMonitorStepDtoType~~
|
|
22257
|
+
|
|
22258
|
+
> ⚠️ **Deprecated**
|
|
22259
|
+
> Use literal values.
|
|
22260
|
+
|
|
22261
|
+
<div class="padding-left--md">
|
|
22262
|
+
|
|
22263
|
+
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
22264
|
+
|
|
22265
|
+
* `NAVIGATE` -> NavigateStepDto
|
|
22266
|
+
* `CLICK` -> InteractionStepDto
|
|
22267
|
+
* `TAP` -> InteractionStepDto
|
|
22268
|
+
* `KEYSTROKES` -> KeyStrokesStepDto
|
|
22269
|
+
* `JAVASCRIPT` -> JavaScriptStepDto
|
|
22270
|
+
* `SELECT_OPTION` -> SelectOptionStepDto
|
|
22271
|
+
* `COOKIE` -> CookieStepDto
|
|
22272
|
+
|
|
22273
|
+
#### Enum keys
|
|
22274
|
+
|
|
22275
|
+
<div class="padding-left--md">
|
|
22276
|
+
|
|
22277
|
+
`Click` | `Cookie` | `Javascript` | `Keystrokes` | `Navigate` | `SelectOption` | `Tap`
|
|
22278
|
+
|
|
22279
|
+
</div>
|
|
22280
|
+
|
|
22281
|
+
|
|
21387
22282
|
</div>
|
|
21388
22283
|
|
|
21389
22284
|
<a name="syntheticlocationstatus"></a>
|
|
@@ -21537,7 +22432,7 @@ Monitor type.
|
|
|
21537
22432
|
|
|
21538
22433
|
<div class="padding-left--md">
|
|
21539
22434
|
|
|
21540
|
-
`MultiProtocol`
|
|
22435
|
+
`Browser` | `MultiProtocol`
|
|
21541
22436
|
|
|
21542
22437
|
</div>
|
|
21543
22438
|
|
|
@@ -21558,7 +22453,7 @@ Monitor type.
|
|
|
21558
22453
|
|
|
21559
22454
|
<div class="padding-left--md">
|
|
21560
22455
|
|
|
21561
|
-
`Browser` | `
|
|
22456
|
+
`Browser` | `MultiProtocol`
|
|
21562
22457
|
|
|
21563
22458
|
</div>
|
|
21564
22459
|
|
|
@@ -21878,6 +22773,27 @@ r = read, w = write
|
|
|
21878
22773
|
</div>
|
|
21879
22774
|
|
|
21880
22775
|
|
|
22776
|
+
</div>
|
|
22777
|
+
|
|
22778
|
+
<a name="validationruledtotype"></a>
|
|
22779
|
+
### ~~ValidationRuleDtoType~~
|
|
22780
|
+
|
|
22781
|
+
> ⚠️ **Deprecated**
|
|
22782
|
+
> Use literal values.
|
|
22783
|
+
|
|
22784
|
+
<div class="padding-left--md">
|
|
22785
|
+
|
|
22786
|
+
Type of validation.
|
|
22787
|
+
|
|
22788
|
+
#### Enum keys
|
|
22789
|
+
|
|
22790
|
+
<div class="padding-left--md">
|
|
22791
|
+
|
|
22792
|
+
`ContentMatch` | `ElementMatch` | `TextMatch`
|
|
22793
|
+
|
|
22794
|
+
</div>
|
|
22795
|
+
|
|
22796
|
+
|
|
21881
22797
|
</div>
|
|
21882
22798
|
|
|
21883
22799
|
<a name="vulnerablefunctioninputsegmenttype"></a>
|