@dynatrace-sdk/client-classic-environment-v2 6.1.0 → 7.0.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 +27 -0
- package/README.md +940 -501
- package/cjs/index.js +2646 -2092
- package/dynatrace-metadata.json +1 -1
- package/esm/index.js +2797 -2225
- package/package.json +1 -1
- package/types/index.d.ts +435 -76
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/7.0.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -1370,7 +1370,19 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1370
1370
|
|
|
1371
1371
|
const data =
|
|
1372
1372
|
await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
|
|
1373
|
-
{
|
|
1373
|
+
{
|
|
1374
|
+
agId: "...",
|
|
1375
|
+
body: {
|
|
1376
|
+
setting: "INHERITED",
|
|
1377
|
+
updateWindows: {
|
|
1378
|
+
windows: [
|
|
1379
|
+
{
|
|
1380
|
+
id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1381
|
+
},
|
|
1382
|
+
],
|
|
1383
|
+
},
|
|
1384
|
+
},
|
|
1385
|
+
},
|
|
1374
1386
|
);
|
|
1375
1387
|
```
|
|
1376
1388
|
|
|
@@ -1446,7 +1458,18 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1446
1458
|
|
|
1447
1459
|
const data =
|
|
1448
1460
|
await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
|
|
1449
|
-
{
|
|
1461
|
+
{
|
|
1462
|
+
body: {
|
|
1463
|
+
globalSetting: "ENABLED",
|
|
1464
|
+
updateWindows: {
|
|
1465
|
+
windows: [
|
|
1466
|
+
{
|
|
1467
|
+
id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1468
|
+
},
|
|
1469
|
+
],
|
|
1470
|
+
},
|
|
1471
|
+
},
|
|
1472
|
+
},
|
|
1450
1473
|
);
|
|
1451
1474
|
```
|
|
1452
1475
|
|
|
@@ -1523,7 +1546,19 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1523
1546
|
|
|
1524
1547
|
const data =
|
|
1525
1548
|
await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
|
|
1526
|
-
{
|
|
1549
|
+
{
|
|
1550
|
+
agId: "...",
|
|
1551
|
+
body: {
|
|
1552
|
+
setting: "INHERITED",
|
|
1553
|
+
updateWindows: {
|
|
1554
|
+
windows: [
|
|
1555
|
+
{
|
|
1556
|
+
id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1557
|
+
},
|
|
1558
|
+
],
|
|
1559
|
+
},
|
|
1560
|
+
},
|
|
1561
|
+
},
|
|
1527
1562
|
);
|
|
1528
1563
|
```
|
|
1529
1564
|
|
|
@@ -1599,7 +1634,18 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1599
1634
|
|
|
1600
1635
|
const data =
|
|
1601
1636
|
await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
|
|
1602
|
-
{
|
|
1637
|
+
{
|
|
1638
|
+
body: {
|
|
1639
|
+
globalSetting: "ENABLED",
|
|
1640
|
+
updateWindows: {
|
|
1641
|
+
windows: [
|
|
1642
|
+
{
|
|
1643
|
+
id: "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
|
|
1644
|
+
},
|
|
1645
|
+
],
|
|
1646
|
+
},
|
|
1647
|
+
},
|
|
1648
|
+
},
|
|
1603
1649
|
);
|
|
1604
1650
|
```
|
|
1605
1651
|
|
|
@@ -2624,6 +2670,63 @@ const data =
|
|
|
2624
2670
|
|
|
2625
2671
|
|
|
2626
2672
|
|
|
2673
|
+
</div>
|
|
2674
|
+
|
|
2675
|
+
## adaptiveTrafficManagementClient
|
|
2676
|
+
|
|
2677
|
+
```js
|
|
2678
|
+
import { adaptiveTrafficManagementClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
2679
|
+
```
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
<a name="getrootspansperminute"></a>
|
|
2683
|
+
### getRootSpansPerMinute
|
|
2684
|
+
|
|
2685
|
+
<div class="padding-bottom--md">
|
|
2686
|
+
<strong>adaptiveTrafficManagementClient.getRootSpansPerMinute(config): Promise<<a href="#adaptivetrafficmanagementdto" target="_blank" rel="noopener noreferrer">AdaptiveTrafficManagementDto</a>></strong>
|
|
2687
|
+
|
|
2688
|
+
<div class="padding-left--md">
|
|
2689
|
+
|
|
2690
|
+
Gets sampling configuration.
|
|
2691
|
+
|
|
2692
|
+
**Required scope:** adaptive-traffic-management:sampling-configuration:read
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
</div>
|
|
2697
|
+
|
|
2698
|
+
|
|
2699
|
+
|
|
2700
|
+
#### Returns
|
|
2701
|
+
|
|
2702
|
+
| Return type | Status code | Description |
|
|
2703
|
+
|---|---|---|
|
|
2704
|
+
|[AdaptiveTrafficManagementDto](#adaptivetrafficmanagementdto)|200|Success|
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
#### Throws
|
|
2708
|
+
|
|
2709
|
+
| Error Type | Error Message |
|
|
2710
|
+
|---|---|
|
|
2711
|
+
|ErrorEnvelopeError|Client side error. | Server side error.|
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
<details>
|
|
2715
|
+
<summary>
|
|
2716
|
+
Code example
|
|
2717
|
+
</summary>
|
|
2718
|
+
|
|
2719
|
+
```ts
|
|
2720
|
+
import { adaptiveTrafficManagementClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2721
|
+
|
|
2722
|
+
const data =
|
|
2723
|
+
await adaptiveTrafficManagementClient.getRootSpansPerMinute();
|
|
2724
|
+
```
|
|
2725
|
+
|
|
2726
|
+
</details>
|
|
2727
|
+
|
|
2728
|
+
|
|
2729
|
+
|
|
2627
2730
|
</div>
|
|
2628
2731
|
|
|
2629
2732
|
## attacksClient
|
|
@@ -2637,7 +2740,7 @@ import { attacksClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
2637
2740
|
### getAttack
|
|
2638
2741
|
|
|
2639
2742
|
<div class="padding-bottom--md">
|
|
2640
|
-
<strong>attacksClient.getAttack(config): Promise<<a href="#attack"
|
|
2743
|
+
<strong>attacksClient.getAttack(config): Promise<<a href="#attack">Attack</a>></strong>
|
|
2641
2744
|
|
|
2642
2745
|
<div class="padding-left--md">
|
|
2643
2746
|
|
|
@@ -2699,7 +2802,7 @@ const data = await attacksClient.getAttack({ id: "..." });
|
|
|
2699
2802
|
### getAttacks
|
|
2700
2803
|
|
|
2701
2804
|
<div class="padding-bottom--md">
|
|
2702
|
-
<strong>attacksClient.getAttacks(config): Promise<<a href="#attacklist">AttackList</a>></strong>
|
|
2805
|
+
<strong>attacksClient.getAttacks(config): Promise<<a href="#attacklist" target="_blank" rel="noopener noreferrer">AttackList</a>></strong>
|
|
2703
2806
|
|
|
2704
2807
|
<div class="padding-left--md">
|
|
2705
2808
|
|
|
@@ -2772,7 +2875,7 @@ import { auditLogsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
2772
2875
|
### getLog
|
|
2773
2876
|
|
|
2774
2877
|
<div class="padding-bottom--md">
|
|
2775
|
-
<strong>auditLogsClient.getLog(config): Promise<<a href="#auditlogentry"
|
|
2878
|
+
<strong>auditLogsClient.getLog(config): Promise<<a href="#auditlogentry">AuditLogEntry</a>></strong>
|
|
2776
2879
|
|
|
2777
2880
|
<div class="padding-left--md">
|
|
2778
2881
|
|
|
@@ -2831,7 +2934,7 @@ const data = await auditLogsClient.getLog({ id: "..." });
|
|
|
2831
2934
|
### getLogs
|
|
2832
2935
|
|
|
2833
2936
|
<div class="padding-bottom--md">
|
|
2834
|
-
<strong>auditLogsClient.getLogs(config): Promise<<a href="#auditlog">AuditLog</a>></strong>
|
|
2937
|
+
<strong>auditLogsClient.getLogs(config): Promise<<a href="#auditlog" target="_blank" rel="noopener noreferrer">AuditLog</a>></strong>
|
|
2835
2938
|
|
|
2836
2939
|
<div class="padding-left--md">
|
|
2837
2940
|
|
|
@@ -2911,7 +3014,11 @@ import { businessEventsClient } from '@dynatrace-sdk/client-classic-environment-
|
|
|
2911
3014
|
|
|
2912
3015
|
Ingests a business event
|
|
2913
3016
|
|
|
2914
|
-
**
|
|
3017
|
+
**One of the following scopes is required:**
|
|
3018
|
+
+ storage:events:write
|
|
3019
|
+
+ openpipeline:bizevents:ingest
|
|
3020
|
+
|
|
3021
|
+
|
|
2915
3022
|
|
|
2916
3023
|
The maximum payload size of a single request is **5 MiB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
|
|
2917
3024
|
|
|
@@ -2926,7 +3033,7 @@ The ingestion of business events is subject to licensing (see [licensing documen
|
|
|
2926
3033
|
|
|
2927
3034
|
| Name | Type |
|
|
2928
3035
|
| --- | --- |
|
|
2929
|
-
|config.body<sup>*required</sup>|<a href="#cloudevent"
|
|
3036
|
+
|config.body<sup>*required</sup>|<a href="#cloudevent">CloudEvent</a> | Array<<a href="#cloudevent" target="_blank" rel="noopener noreferrer">CloudEvent</a>> | IngestBody|
|
|
2930
3037
|
|config.type<sup>*required</sup>|"application/cloudevent+json" | "application/cloudevents+json" | "application/cloudevent-batch+json" | "application/cloudevents-batch+json" | "application/json; charset=utf-8"|
|
|
2931
3038
|
|
|
2932
3039
|
|
|
@@ -2995,7 +3102,7 @@ import { credentialVaultClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
2995
3102
|
### createCredentials
|
|
2996
3103
|
|
|
2997
3104
|
<div class="padding-bottom--md">
|
|
2998
|
-
<strong>credentialVaultClient.createCredentials(config): Promise<<a href="#credentialsid"
|
|
3105
|
+
<strong>credentialVaultClient.createCredentials(config): Promise<<a href="#credentialsid">CredentialsId</a>></strong>
|
|
2999
3106
|
|
|
3000
3107
|
<div class="padding-left--md">
|
|
3001
3108
|
|
|
@@ -3015,7 +3122,7 @@ The body must not provide an ID. An ID is assigned automatically by the Dynatrac
|
|
|
3015
3122
|
|
|
3016
3123
|
| Name | Type |
|
|
3017
3124
|
| --- | --- |
|
|
3018
|
-
|config.body<sup>*required</sup>|<a href="#credentials">Credentials</a>|
|
|
3125
|
+
|config.body<sup>*required</sup>|<a href="#credentials" target="_blank" rel="noopener noreferrer">Credentials</a>|
|
|
3019
3126
|
|
|
3020
3127
|
|
|
3021
3128
|
|
|
@@ -3062,7 +3169,7 @@ const data = await credentialVaultClient.createCredentials({
|
|
|
3062
3169
|
### getCredentials
|
|
3063
3170
|
|
|
3064
3171
|
<div class="padding-bottom--md">
|
|
3065
|
-
<strong>credentialVaultClient.getCredentials(config): Promise<<a href="#credentialsresponseelement"
|
|
3172
|
+
<strong>credentialVaultClient.getCredentials(config): Promise<<a href="#credentialsresponseelement">CredentialsResponseElement</a>></strong>
|
|
3066
3173
|
|
|
3067
3174
|
<div class="padding-left--md">
|
|
3068
3175
|
|
|
@@ -3125,7 +3232,7 @@ const data = await credentialVaultClient.getCredentials({
|
|
|
3125
3232
|
### getCredentialsDetails
|
|
3126
3233
|
|
|
3127
3234
|
<div class="padding-bottom--md">
|
|
3128
|
-
<strong>credentialVaultClient.getCredentialsDetails(config): Promise<<a href="#abstractcredentialsresponseelement">AbstractCredentialsResponseElement</a>></strong>
|
|
3235
|
+
<strong>credentialVaultClient.getCredentialsDetails(config): Promise<<a href="#abstractcredentialsresponseelement" target="_blank" rel="noopener noreferrer">AbstractCredentialsResponseElement</a>></strong>
|
|
3129
3236
|
|
|
3130
3237
|
<div class="padding-left--md">
|
|
3131
3238
|
|
|
@@ -3189,7 +3296,7 @@ const data =
|
|
|
3189
3296
|
### getCredentialsDetailsList
|
|
3190
3297
|
|
|
3191
3298
|
<div class="padding-bottom--md">
|
|
3192
|
-
<strong>credentialVaultClient.getCredentialsDetailsList(config): Promise<<a href="#credentialsdetailslist"
|
|
3299
|
+
<strong>credentialVaultClient.getCredentialsDetailsList(config): Promise<<a href="#credentialsdetailslist">CredentialsDetailsList</a>></strong>
|
|
3193
3300
|
|
|
3194
3301
|
<div class="padding-left--md">
|
|
3195
3302
|
|
|
@@ -3248,7 +3355,7 @@ const data =
|
|
|
3248
3355
|
### listCredentials
|
|
3249
3356
|
|
|
3250
3357
|
<div class="padding-bottom--md">
|
|
3251
|
-
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist">CredentialsList</a>></strong>
|
|
3358
|
+
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist" target="_blank" rel="noopener noreferrer">CredentialsList</a>></strong>
|
|
3252
3359
|
|
|
3253
3360
|
<div class="padding-left--md">
|
|
3254
3361
|
|
|
@@ -3377,7 +3484,7 @@ const data = await credentialVaultClient.removeCredentials({
|
|
|
3377
3484
|
### updateCredentials
|
|
3378
3485
|
|
|
3379
3486
|
<div class="padding-bottom--md">
|
|
3380
|
-
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid"
|
|
3487
|
+
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid">CredentialsId</a>></strong>
|
|
3381
3488
|
|
|
3382
3489
|
<div class="padding-left--md">
|
|
3383
3490
|
|
|
@@ -3397,7 +3504,7 @@ The body must not provide an ID. The ID should be provided in the path.
|
|
|
3397
3504
|
|
|
3398
3505
|
| Name | Type | Description |
|
|
3399
3506
|
| --- | --- | --- |
|
|
3400
|
-
|config.body<sup>*required</sup>|<a href="#credentials">Credentials</a>| |
|
|
3507
|
+
|config.body<sup>*required</sup>|<a href="#credentials" target="_blank" rel="noopener noreferrer">Credentials</a>| |
|
|
3401
3508
|
|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. |
|
|
3402
3509
|
|
|
3403
3510
|
|
|
@@ -3453,7 +3560,7 @@ import { davisSecurityAdvisorClient } from '@dynatrace-sdk/client-classic-enviro
|
|
|
3453
3560
|
### getAdviceForSecurityProblems
|
|
3454
3561
|
|
|
3455
3562
|
<div class="padding-bottom--md">
|
|
3456
|
-
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist"
|
|
3563
|
+
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist">DavisSecurityAdviceList</a>></strong>
|
|
3457
3564
|
|
|
3458
3565
|
<div class="padding-left--md">
|
|
3459
3566
|
|
|
@@ -3527,20 +3634,21 @@ import { eventsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
3527
3634
|
### createEvent
|
|
3528
3635
|
|
|
3529
3636
|
<div class="padding-bottom--md">
|
|
3530
|
-
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults">EventIngestResults</a>></strong>
|
|
3637
|
+
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults" target="_blank" rel="noopener noreferrer">EventIngestResults</a>></strong>
|
|
3531
3638
|
|
|
3532
3639
|
<div class="padding-left--md">
|
|
3533
3640
|
|
|
3534
3641
|
Ingests a custom event
|
|
3535
3642
|
|
|
3536
3643
|
**One of the following scopes is required:**
|
|
3644
|
+
+ openpipeline:events.davis:ingest
|
|
3537
3645
|
+ storage:events:write
|
|
3538
3646
|
+ environment-api:events:write
|
|
3539
3647
|
|
|
3540
3648
|
|
|
3541
3649
|
**One of the following permissions is required:**
|
|
3542
3650
|
+ environment:roles:viewer
|
|
3543
|
-
+
|
|
3651
|
+
+ openpipeline:events.davis:ingest
|
|
3544
3652
|
|
|
3545
3653
|
|
|
3546
3654
|
|
|
@@ -3555,7 +3663,7 @@ The ingestion of custom events is subject to licensing (see [licensing documenta
|
|
|
3555
3663
|
|
|
3556
3664
|
| Name | Type |
|
|
3557
3665
|
| --- | --- |
|
|
3558
|
-
|config.body<sup>*required</sup>|<a href="#eventingest"
|
|
3666
|
+
|config.body<sup>*required</sup>|<a href="#eventingest">EventIngest</a>|
|
|
3559
3667
|
|
|
3560
3668
|
|
|
3561
3669
|
|
|
@@ -3598,7 +3706,7 @@ const data = await eventsClient.createEvent({
|
|
|
3598
3706
|
### getEvent
|
|
3599
3707
|
|
|
3600
3708
|
<div class="padding-bottom--md">
|
|
3601
|
-
<strong>eventsClient.getEvent(config): Promise<<a href="#event">Event</a>></strong>
|
|
3709
|
+
<strong>eventsClient.getEvent(config): Promise<<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>></strong>
|
|
3602
3710
|
|
|
3603
3711
|
<div class="padding-left--md">
|
|
3604
3712
|
|
|
@@ -3659,13 +3767,17 @@ const data = await eventsClient.getEvent({
|
|
|
3659
3767
|
### getEventProperties
|
|
3660
3768
|
|
|
3661
3769
|
<div class="padding-bottom--md">
|
|
3662
|
-
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist"
|
|
3770
|
+
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist">EventPropertiesList</a>></strong>
|
|
3663
3771
|
|
|
3664
3772
|
<div class="padding-left--md">
|
|
3665
3773
|
|
|
3666
3774
|
Lists all event properties
|
|
3667
3775
|
|
|
3668
|
-
**
|
|
3776
|
+
**One of the following scopes is required:**
|
|
3777
|
+
+ storage:events:read
|
|
3778
|
+
+ environment-api:events:read
|
|
3779
|
+
|
|
3780
|
+
|
|
3669
3781
|
**One of the following permissions is required:**
|
|
3670
3782
|
+ environment:roles:viewer
|
|
3671
3783
|
+ storage:events:read
|
|
@@ -3721,13 +3833,17 @@ const data = await eventsClient.getEventProperties();
|
|
|
3721
3833
|
### getEventProperty
|
|
3722
3834
|
|
|
3723
3835
|
<div class="padding-bottom--md">
|
|
3724
|
-
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails">EventPropertyDetails</a>></strong>
|
|
3836
|
+
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>></strong>
|
|
3725
3837
|
|
|
3726
3838
|
<div class="padding-left--md">
|
|
3727
3839
|
|
|
3728
3840
|
Gets the details of an event property
|
|
3729
3841
|
|
|
3730
|
-
**
|
|
3842
|
+
**One of the following scopes is required:**
|
|
3843
|
+
+ storage:events:read
|
|
3844
|
+
+ environment-api:events:read
|
|
3845
|
+
|
|
3846
|
+
|
|
3731
3847
|
**One of the following permissions is required:**
|
|
3732
3848
|
+ environment:roles:viewer
|
|
3733
3849
|
+ storage:events:read
|
|
@@ -3784,13 +3900,17 @@ const data = await eventsClient.getEventProperty({
|
|
|
3784
3900
|
### getEventType
|
|
3785
3901
|
|
|
3786
3902
|
<div class="padding-bottom--md">
|
|
3787
|
-
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype"
|
|
3903
|
+
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype">EventType</a>></strong>
|
|
3788
3904
|
|
|
3789
3905
|
<div class="padding-left--md">
|
|
3790
3906
|
|
|
3791
3907
|
Gets the properties of an event type
|
|
3792
3908
|
|
|
3793
|
-
**
|
|
3909
|
+
**One of the following scopes is required:**
|
|
3910
|
+
+ storage:events:read
|
|
3911
|
+
+ environment-api:events:read
|
|
3912
|
+
|
|
3913
|
+
|
|
3794
3914
|
**One of the following permissions is required:**
|
|
3795
3915
|
+ environment:roles:viewer
|
|
3796
3916
|
+ storage:events:read
|
|
@@ -3847,13 +3967,17 @@ const data = await eventsClient.getEventType({
|
|
|
3847
3967
|
### getEventTypes
|
|
3848
3968
|
|
|
3849
3969
|
<div class="padding-bottom--md">
|
|
3850
|
-
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist">EventTypeList</a>></strong>
|
|
3970
|
+
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist" target="_blank" rel="noopener noreferrer">EventTypeList</a>></strong>
|
|
3851
3971
|
|
|
3852
3972
|
<div class="padding-left--md">
|
|
3853
3973
|
|
|
3854
3974
|
Lists all event types
|
|
3855
3975
|
|
|
3856
|
-
**
|
|
3976
|
+
**One of the following scopes is required:**
|
|
3977
|
+
+ storage:events:read
|
|
3978
|
+
+ environment-api:events:read
|
|
3979
|
+
|
|
3980
|
+
|
|
3857
3981
|
**One of the following permissions is required:**
|
|
3858
3982
|
+ environment:roles:viewer
|
|
3859
3983
|
+ storage:events:read
|
|
@@ -3909,7 +4033,7 @@ const data = await eventsClient.getEventTypes();
|
|
|
3909
4033
|
### getEvents
|
|
3910
4034
|
|
|
3911
4035
|
<div class="padding-bottom--md">
|
|
3912
|
-
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist"
|
|
4036
|
+
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist">EventList</a>></strong>
|
|
3913
4037
|
|
|
3914
4038
|
<div class="padding-left--md">
|
|
3915
4039
|
|
|
@@ -3976,10 +4100,12 @@ import { extensions_2_0Client } from '@dynatrace-sdk/client-classic-environment-
|
|
|
3976
4100
|
|
|
3977
4101
|
|
|
3978
4102
|
<a name="activateextensionenvironmentconfiguration"></a>
|
|
3979
|
-
### activateExtensionEnvironmentConfiguration
|
|
4103
|
+
### ~~activateExtensionEnvironmentConfiguration~~
|
|
4104
|
+
|
|
4105
|
+
> ⚠️ **Deprecated**
|
|
3980
4106
|
|
|
3981
4107
|
<div class="padding-bottom--md">
|
|
3982
|
-
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
4108
|
+
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3983
4109
|
|
|
3984
4110
|
<div class="padding-left--md">
|
|
3985
4111
|
|
|
@@ -3992,6 +4118,10 @@ Activates the environment configuration from the specified version of the extens
|
|
|
3992
4118
|
|
|
3993
4119
|
|
|
3994
4120
|
|
|
4121
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4122
|
+
|
|
4123
|
+
|
|
4124
|
+
|
|
3995
4125
|
</div>
|
|
3996
4126
|
|
|
3997
4127
|
|
|
@@ -3999,7 +4129,7 @@ Activates the environment configuration from the specified version of the extens
|
|
|
3999
4129
|
|
|
4000
4130
|
| Name | Type | Description |
|
|
4001
4131
|
| --- | --- | --- |
|
|
4002
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion"
|
|
4132
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
4003
4133
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4004
4134
|
|
|
4005
4135
|
|
|
@@ -4044,7 +4174,7 @@ const data =
|
|
|
4044
4174
|
### createMonitoringConfiguration
|
|
4045
4175
|
|
|
4046
4176
|
<div class="padding-bottom--md">
|
|
4047
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
4177
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse" target="_blank" rel="noopener noreferrer">MonitoringConfigurationResponse</a>>></strong>
|
|
4048
4178
|
|
|
4049
4179
|
<div class="padding-left--md">
|
|
4050
4180
|
|
|
@@ -4057,6 +4187,10 @@ Creates new monitoring configuration for the specified extension 2.0
|
|
|
4057
4187
|
|
|
4058
4188
|
|
|
4059
4189
|
|
|
4190
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4191
|
+
|
|
4192
|
+
|
|
4193
|
+
|
|
4060
4194
|
</div>
|
|
4061
4195
|
|
|
4062
4196
|
|
|
@@ -4064,7 +4198,7 @@ Creates new monitoring configuration for the specified extension 2.0
|
|
|
4064
4198
|
|
|
4065
4199
|
| Name | Type | Description |
|
|
4066
4200
|
| --- | --- | --- |
|
|
4067
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto"
|
|
4201
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
4068
4202
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4069
4203
|
|
|
4070
4204
|
|
|
@@ -4108,7 +4242,7 @@ const data =
|
|
|
4108
4242
|
</div>
|
|
4109
4243
|
|
|
4110
4244
|
<div class="padding-bottom--md">
|
|
4111
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse"
|
|
4245
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope" target="_blank" rel="noopener noreferrer">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
4112
4246
|
|
|
4113
4247
|
<div class="padding-left--md">
|
|
4114
4248
|
|
|
@@ -4123,7 +4257,7 @@ const data =
|
|
|
4123
4257
|
|
|
4124
4258
|
| Name | Type | Description |
|
|
4125
4259
|
| --- | --- | --- |
|
|
4126
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
4260
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto" target="_blank" rel="noopener noreferrer">MonitoringConfigurationDto</a>>| |
|
|
4127
4261
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4128
4262
|
|
|
4129
4263
|
|
|
@@ -4144,10 +4278,12 @@ const data =
|
|
|
4144
4278
|
|
|
4145
4279
|
|
|
4146
4280
|
<a name="deleteenvironmentconfiguration"></a>
|
|
4147
|
-
### deleteEnvironmentConfiguration
|
|
4281
|
+
### ~~deleteEnvironmentConfiguration~~
|
|
4282
|
+
|
|
4283
|
+
> ⚠️ **Deprecated**
|
|
4148
4284
|
|
|
4149
4285
|
<div class="padding-bottom--md">
|
|
4150
|
-
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
4286
|
+
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
4151
4287
|
|
|
4152
4288
|
<div class="padding-left--md">
|
|
4153
4289
|
|
|
@@ -4160,6 +4296,10 @@ Deactivates the environment configuration of the specified extension 2.0
|
|
|
4160
4296
|
|
|
4161
4297
|
|
|
4162
4298
|
|
|
4299
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4300
|
+
|
|
4301
|
+
|
|
4302
|
+
|
|
4163
4303
|
</div>
|
|
4164
4304
|
|
|
4165
4305
|
|
|
@@ -4208,10 +4348,12 @@ const data =
|
|
|
4208
4348
|
|
|
4209
4349
|
|
|
4210
4350
|
<a name="executeextensionmonitoringconfigurationactions"></a>
|
|
4211
|
-
### executeExtensionMonitoringConfigurationActions
|
|
4351
|
+
### ~~executeExtensionMonitoringConfigurationActions~~
|
|
4352
|
+
|
|
4353
|
+
> ⚠️ **Deprecated**
|
|
4212
4354
|
|
|
4213
4355
|
<div class="padding-bottom--md">
|
|
4214
|
-
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse">ExecuteActionsResponse</a>></strong>
|
|
4356
|
+
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse" target="_blank" rel="noopener noreferrer">ExecuteActionsResponse</a>></strong>
|
|
4215
4357
|
|
|
4216
4358
|
<div class="padding-left--md">
|
|
4217
4359
|
|
|
@@ -4224,6 +4366,10 @@ Executes Data Source action of Active Gate or Host
|
|
|
4224
4366
|
|
|
4225
4367
|
|
|
4226
4368
|
|
|
4369
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4370
|
+
|
|
4371
|
+
|
|
4372
|
+
|
|
4227
4373
|
</div>
|
|
4228
4374
|
|
|
4229
4375
|
|
|
@@ -4231,7 +4377,7 @@ Executes Data Source action of Active Gate or Host
|
|
|
4231
4377
|
|
|
4232
4378
|
| Name | Type | Description |
|
|
4233
4379
|
| --- | --- | --- |
|
|
4234
|
-
|config.body<sup>*required</sup>|<a href="#executeactionsdto"
|
|
4380
|
+
|config.body<sup>*required</sup>|<a href="#executeactionsdto">ExecuteActionsDto</a>| |
|
|
4235
4381
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
4236
4382
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4237
4383
|
|
|
@@ -4278,10 +4424,12 @@ const data =
|
|
|
4278
4424
|
|
|
4279
4425
|
|
|
4280
4426
|
<a name="extensionconfigurationschema"></a>
|
|
4281
|
-
### extensionConfigurationSchema
|
|
4427
|
+
### ~~extensionConfigurationSchema~~
|
|
4428
|
+
|
|
4429
|
+
> ⚠️ **Deprecated**
|
|
4282
4430
|
|
|
4283
4431
|
<div class="padding-bottom--md">
|
|
4284
|
-
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto">SchemaDefinitionRestDto</a>></strong>
|
|
4432
|
+
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDto</a>></strong>
|
|
4285
4433
|
|
|
4286
4434
|
<div class="padding-left--md">
|
|
4287
4435
|
|
|
@@ -4298,6 +4446,10 @@ Gets the configuration schema of the specified version of the extension 2.0
|
|
|
4298
4446
|
|
|
4299
4447
|
|
|
4300
4448
|
|
|
4449
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4450
|
+
|
|
4451
|
+
|
|
4452
|
+
|
|
4301
4453
|
</div>
|
|
4302
4454
|
|
|
4303
4455
|
|
|
@@ -4351,7 +4503,7 @@ const data =
|
|
|
4351
4503
|
### extensionDetails
|
|
4352
4504
|
|
|
4353
4505
|
<div class="padding-bottom--md">
|
|
4354
|
-
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension"
|
|
4506
|
+
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
4355
4507
|
|
|
4356
4508
|
<div class="padding-left--md">
|
|
4357
4509
|
|
|
@@ -4364,6 +4516,10 @@ Gets details of the specified version of the extension 2.0
|
|
|
4364
4516
|
|
|
4365
4517
|
|
|
4366
4518
|
|
|
4519
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4520
|
+
|
|
4521
|
+
|
|
4522
|
+
|
|
4367
4523
|
</div>
|
|
4368
4524
|
|
|
4369
4525
|
|
|
@@ -4450,10 +4606,12 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
4450
4606
|
|
|
4451
4607
|
|
|
4452
4608
|
<a name="extensionmonitoringconfigurations"></a>
|
|
4453
|
-
### extensionMonitoringConfigurations
|
|
4609
|
+
### ~~extensionMonitoringConfigurations~~
|
|
4610
|
+
|
|
4611
|
+
> ⚠️ **Deprecated**
|
|
4454
4612
|
|
|
4455
4613
|
<div class="padding-bottom--md">
|
|
4456
|
-
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
4614
|
+
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
4457
4615
|
|
|
4458
4616
|
<div class="padding-left--md">
|
|
4459
4617
|
|
|
@@ -4466,6 +4624,10 @@ Lists all the monitoring configurations of the specified extension 2.0
|
|
|
4466
4624
|
|
|
4467
4625
|
|
|
4468
4626
|
|
|
4627
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4628
|
+
|
|
4629
|
+
|
|
4630
|
+
|
|
4469
4631
|
</div>
|
|
4470
4632
|
|
|
4471
4633
|
|
|
@@ -4518,10 +4680,12 @@ const data =
|
|
|
4518
4680
|
|
|
4519
4681
|
|
|
4520
4682
|
<a name="getactiveenvironmentconfiguration"></a>
|
|
4521
|
-
### getActiveEnvironmentConfiguration
|
|
4683
|
+
### ~~getActiveEnvironmentConfiguration~~
|
|
4684
|
+
|
|
4685
|
+
> ⚠️ **Deprecated**
|
|
4522
4686
|
|
|
4523
4687
|
<div class="padding-bottom--md">
|
|
4524
|
-
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
4688
|
+
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
4525
4689
|
|
|
4526
4690
|
<div class="padding-left--md">
|
|
4527
4691
|
|
|
@@ -4534,6 +4698,10 @@ Gets the active environment configuration version of the specified extension 2.0
|
|
|
4534
4698
|
|
|
4535
4699
|
|
|
4536
4700
|
|
|
4701
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
|
|
4537
4705
|
</div>
|
|
4538
4706
|
|
|
4539
4707
|
|
|
@@ -4582,10 +4750,12 @@ const data =
|
|
|
4582
4750
|
|
|
4583
4751
|
|
|
4584
4752
|
<a name="getactivegategroupsinfo"></a>
|
|
4585
|
-
### getActiveGateGroupsInfo
|
|
4753
|
+
### ~~getActiveGateGroupsInfo~~
|
|
4754
|
+
|
|
4755
|
+
> ⚠️ **Deprecated**
|
|
4586
4756
|
|
|
4587
4757
|
<div class="padding-bottom--md">
|
|
4588
|
-
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto">ActiveGateGroupsInfoDto</a>></strong>
|
|
4758
|
+
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto" target="_blank" rel="noopener noreferrer">ActiveGateGroupsInfoDto</a>></strong>
|
|
4589
4759
|
|
|
4590
4760
|
<div class="padding-left--md">
|
|
4591
4761
|
|
|
@@ -4598,6 +4768,10 @@ List all activeGate groups available for extension
|
|
|
4598
4768
|
|
|
4599
4769
|
|
|
4600
4770
|
|
|
4771
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4772
|
+
|
|
4773
|
+
|
|
4774
|
+
|
|
4601
4775
|
</div>
|
|
4602
4776
|
|
|
4603
4777
|
|
|
@@ -4648,10 +4822,12 @@ const data =
|
|
|
4648
4822
|
|
|
4649
4823
|
|
|
4650
4824
|
<a name="getalerttemplate"></a>
|
|
4651
|
-
### getAlertTemplate
|
|
4825
|
+
### ~~getAlertTemplate~~
|
|
4826
|
+
|
|
4827
|
+
> ⚠️ **Deprecated**
|
|
4652
4828
|
|
|
4653
4829
|
<div class="padding-bottom--md">
|
|
4654
|
-
<strong>extensions_2_0Client.getAlertTemplate(config): Promise<<a href="#alerttemplatedto"
|
|
4830
|
+
<strong>extensions_2_0Client.getAlertTemplate(config): Promise<<a href="#alerttemplatedto">AlertTemplateDto</a>></strong>
|
|
4655
4831
|
|
|
4656
4832
|
<div class="padding-left--md">
|
|
4657
4833
|
|
|
@@ -4664,6 +4840,10 @@ Gets an alert template asset for given ID
|
|
|
4664
4840
|
|
|
4665
4841
|
|
|
4666
4842
|
|
|
4843
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4844
|
+
|
|
4845
|
+
|
|
4846
|
+
|
|
4667
4847
|
</div>
|
|
4668
4848
|
|
|
4669
4849
|
|
|
@@ -4713,10 +4893,12 @@ const data = await extensions_2_0Client.getAlertTemplate({
|
|
|
4713
4893
|
|
|
4714
4894
|
|
|
4715
4895
|
<a name="getenvironmentconfigurationassetsinfo"></a>
|
|
4716
|
-
### getEnvironmentConfigurationAssetsInfo
|
|
4896
|
+
### ~~getEnvironmentConfigurationAssetsInfo~~
|
|
4897
|
+
|
|
4898
|
+
> ⚠️ **Deprecated**
|
|
4717
4899
|
|
|
4718
4900
|
<div class="padding-bottom--md">
|
|
4719
|
-
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto">ExtensionAssetsDto</a>></strong>
|
|
4901
|
+
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto" target="_blank" rel="noopener noreferrer">ExtensionAssetsDto</a>></strong>
|
|
4720
4902
|
|
|
4721
4903
|
<div class="padding-left--md">
|
|
4722
4904
|
|
|
@@ -4729,6 +4911,10 @@ Gets the information about assets in an active extension 2.0
|
|
|
4729
4911
|
|
|
4730
4912
|
|
|
4731
4913
|
|
|
4914
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4915
|
+
|
|
4916
|
+
|
|
4917
|
+
|
|
4732
4918
|
</div>
|
|
4733
4919
|
|
|
4734
4920
|
|
|
@@ -4777,10 +4963,12 @@ const data =
|
|
|
4777
4963
|
|
|
4778
4964
|
|
|
4779
4965
|
<a name="getextensionmonitoringconfigurationstatus"></a>
|
|
4780
|
-
### getExtensionMonitoringConfigurationStatus
|
|
4966
|
+
### ~~getExtensionMonitoringConfigurationStatus~~
|
|
4967
|
+
|
|
4968
|
+
> ⚠️ **Deprecated**
|
|
4781
4969
|
|
|
4782
4970
|
<div class="padding-bottom--md">
|
|
4783
|
-
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto"
|
|
4971
|
+
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto">ExtensionStatusDto</a>></strong>
|
|
4784
4972
|
|
|
4785
4973
|
<div class="padding-left--md">
|
|
4786
4974
|
|
|
@@ -4793,6 +4981,10 @@ Gets the most recent status of the execution of given monitoring configuration
|
|
|
4793
4981
|
|
|
4794
4982
|
|
|
4795
4983
|
|
|
4984
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
4985
|
+
|
|
4986
|
+
|
|
4987
|
+
|
|
4796
4988
|
</div>
|
|
4797
4989
|
|
|
4798
4990
|
|
|
@@ -4842,10 +5034,12 @@ const data =
|
|
|
4842
5034
|
|
|
4843
5035
|
|
|
4844
5036
|
<a name="getextensionstatus"></a>
|
|
4845
|
-
### getExtensionStatus
|
|
5037
|
+
### ~~getExtensionStatus~~
|
|
5038
|
+
|
|
5039
|
+
> ⚠️ **Deprecated**
|
|
4846
5040
|
|
|
4847
5041
|
<div class="padding-bottom--md">
|
|
4848
|
-
<strong>extensions_2_0Client.getExtensionStatus(config): Promise<Array<<a href="#extensionstatuswithiddto">ExtensionStatusWithIdDto</a>>></strong>
|
|
5042
|
+
<strong>extensions_2_0Client.getExtensionStatus(config): Promise<Array<<a href="#extensionstatuswithiddto" target="_blank" rel="noopener noreferrer">ExtensionStatusWithIdDto</a>>></strong>
|
|
4849
5043
|
|
|
4850
5044
|
<div class="padding-left--md">
|
|
4851
5045
|
|
|
@@ -4858,6 +5052,10 @@ Gets the most recent status of the execution of monitoring configurations of giv
|
|
|
4858
5052
|
|
|
4859
5053
|
|
|
4860
5054
|
|
|
5055
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5056
|
+
|
|
5057
|
+
|
|
5058
|
+
|
|
4861
5059
|
</div>
|
|
4862
5060
|
|
|
4863
5061
|
|
|
@@ -4905,7 +5103,9 @@ const data = await extensions_2_0Client.getExtensionStatus({
|
|
|
4905
5103
|
|
|
4906
5104
|
|
|
4907
5105
|
<a name="getjmxprocess"></a>
|
|
4908
|
-
### getJmxProcess
|
|
5106
|
+
### ~~getJmxProcess~~
|
|
5107
|
+
|
|
5108
|
+
> ⚠️ **Deprecated**
|
|
4909
5109
|
|
|
4910
5110
|
<div class="padding-bottom--md">
|
|
4911
5111
|
<strong>extensions_2_0Client.getJmxProcess(config): Promise<JavaProcessDetails></strong>
|
|
@@ -4916,6 +5116,8 @@ Retrieves details of a specified Java process discovered in the environment for
|
|
|
4916
5116
|
|
|
4917
5117
|
**Required scope:** extensions:discovery.jmx:read
|
|
4918
5118
|
|
|
5119
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5120
|
+
|
|
4919
5121
|
|
|
4920
5122
|
|
|
4921
5123
|
</div>
|
|
@@ -4966,7 +5168,9 @@ const data = await extensions_2_0Client.getJmxProcess({
|
|
|
4966
5168
|
|
|
4967
5169
|
|
|
4968
5170
|
<a name="getpmiprocess"></a>
|
|
4969
|
-
### getPmiProcess
|
|
5171
|
+
### ~~getPmiProcess~~
|
|
5172
|
+
|
|
5173
|
+
> ⚠️ **Deprecated**
|
|
4970
5174
|
|
|
4971
5175
|
<div class="padding-bottom--md">
|
|
4972
5176
|
<strong>extensions_2_0Client.getPmiProcess(config): Promise<PmiProcessDetails></strong>
|
|
@@ -4977,6 +5181,8 @@ Retrieves details of a specified Java process discovered in the environment for
|
|
|
4977
5181
|
|
|
4978
5182
|
**Required scope:** extensions:discovery.pmi:read
|
|
4979
5183
|
|
|
5184
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5185
|
+
|
|
4980
5186
|
|
|
4981
5187
|
|
|
4982
5188
|
</div>
|
|
@@ -5027,7 +5233,9 @@ const data = await extensions_2_0Client.getPmiProcess({
|
|
|
5027
5233
|
|
|
5028
5234
|
|
|
5029
5235
|
<a name="getschemafile"></a>
|
|
5030
|
-
### getSchemaFile
|
|
5236
|
+
### ~~getSchemaFile~~
|
|
5237
|
+
|
|
5238
|
+
> ⚠️ **Deprecated**
|
|
5031
5239
|
|
|
5032
5240
|
<div class="padding-bottom--md">
|
|
5033
5241
|
<strong>extensions_2_0Client.getSchemaFile(config): Promise<JsonNode></strong>
|
|
@@ -5043,6 +5251,10 @@ Gets the extension 2.0 schema file in the specified version
|
|
|
5043
5251
|
|
|
5044
5252
|
|
|
5045
5253
|
|
|
5254
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5255
|
+
|
|
5256
|
+
|
|
5257
|
+
|
|
5046
5258
|
</div>
|
|
5047
5259
|
|
|
5048
5260
|
|
|
@@ -5092,10 +5304,12 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
5092
5304
|
|
|
5093
5305
|
|
|
5094
5306
|
<a name="installextension"></a>
|
|
5095
|
-
### installExtension
|
|
5307
|
+
### ~~installExtension~~
|
|
5308
|
+
|
|
5309
|
+
> ⚠️ **Deprecated**
|
|
5096
5310
|
|
|
5097
5311
|
<div class="padding-bottom--md">
|
|
5098
|
-
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto"
|
|
5312
|
+
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto">RegisteredExtensionResultDto</a>></strong>
|
|
5099
5313
|
|
|
5100
5314
|
<div class="padding-left--md">
|
|
5101
5315
|
|
|
@@ -5108,6 +5322,10 @@ Installs Extension from HUB
|
|
|
5108
5322
|
|
|
5109
5323
|
|
|
5110
5324
|
|
|
5325
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5326
|
+
|
|
5327
|
+
|
|
5328
|
+
|
|
5111
5329
|
</div>
|
|
5112
5330
|
|
|
5113
5331
|
|
|
@@ -5156,10 +5374,12 @@ const data = await extensions_2_0Client.installExtension({
|
|
|
5156
5374
|
|
|
5157
5375
|
|
|
5158
5376
|
<a name="listextensioninfos"></a>
|
|
5159
|
-
### listExtensionInfos
|
|
5377
|
+
### ~~listExtensionInfos~~
|
|
5378
|
+
|
|
5379
|
+
> ⚠️ **Deprecated**
|
|
5160
5380
|
|
|
5161
5381
|
<div class="padding-bottom--md">
|
|
5162
|
-
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist">ExtensionInfoList</a>></strong>
|
|
5382
|
+
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist" target="_blank" rel="noopener noreferrer">ExtensionInfoList</a>></strong>
|
|
5163
5383
|
|
|
5164
5384
|
<div class="padding-left--md">
|
|
5165
5385
|
|
|
@@ -5172,6 +5392,10 @@ Lists all the extensions 2.0 available in your environment with additional metad
|
|
|
5172
5392
|
|
|
5173
5393
|
|
|
5174
5394
|
|
|
5395
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5396
|
+
|
|
5397
|
+
|
|
5398
|
+
|
|
5175
5399
|
</div>
|
|
5176
5400
|
|
|
5177
5401
|
|
|
@@ -5220,10 +5444,12 @@ const data =
|
|
|
5220
5444
|
|
|
5221
5445
|
|
|
5222
5446
|
<a name="listextensionversions"></a>
|
|
5223
|
-
### listExtensionVersions
|
|
5447
|
+
### ~~listExtensionVersions~~
|
|
5448
|
+
|
|
5449
|
+
> ⚠️ **Deprecated**
|
|
5224
5450
|
|
|
5225
5451
|
<div class="padding-bottom--md">
|
|
5226
|
-
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist"
|
|
5452
|
+
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
5227
5453
|
|
|
5228
5454
|
<div class="padding-left--md">
|
|
5229
5455
|
|
|
@@ -5236,6 +5462,10 @@ Lists all versions of the extension 2.0
|
|
|
5236
5462
|
|
|
5237
5463
|
|
|
5238
5464
|
|
|
5465
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5466
|
+
|
|
5467
|
+
|
|
5468
|
+
|
|
5239
5469
|
</div>
|
|
5240
5470
|
|
|
5241
5471
|
|
|
@@ -5286,10 +5516,12 @@ const data =
|
|
|
5286
5516
|
|
|
5287
5517
|
|
|
5288
5518
|
<a name="listextensions"></a>
|
|
5289
|
-
### listExtensions
|
|
5519
|
+
### ~~listExtensions~~
|
|
5520
|
+
|
|
5521
|
+
> ⚠️ **Deprecated**
|
|
5290
5522
|
|
|
5291
5523
|
<div class="padding-bottom--md">
|
|
5292
|
-
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
5524
|
+
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist" target="_blank" rel="noopener noreferrer">ExtensionList</a>></strong>
|
|
5293
5525
|
|
|
5294
5526
|
<div class="padding-left--md">
|
|
5295
5527
|
|
|
@@ -5302,6 +5534,10 @@ Lists all the extensions 2.0 available in your environment
|
|
|
5302
5534
|
|
|
5303
5535
|
|
|
5304
5536
|
|
|
5537
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5538
|
+
|
|
5539
|
+
|
|
5540
|
+
|
|
5305
5541
|
</div>
|
|
5306
5542
|
|
|
5307
5543
|
|
|
@@ -5349,10 +5585,12 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
5349
5585
|
|
|
5350
5586
|
|
|
5351
5587
|
<a name="listjmxprocesses"></a>
|
|
5352
|
-
### listJmxProcesses
|
|
5588
|
+
### ~~listJmxProcesses~~
|
|
5589
|
+
|
|
5590
|
+
> ⚠️ **Deprecated**
|
|
5353
5591
|
|
|
5354
5592
|
<div class="padding-bottom--md">
|
|
5355
|
-
<strong>extensions_2_0Client.listJmxProcesses(config): Promise<Array<<a href="#javaprocesscontainerlist"
|
|
5593
|
+
<strong>extensions_2_0Client.listJmxProcesses(config): Promise<Array<<a href="#javaprocesscontainerlist">JavaProcessContainerList</a>>></strong>
|
|
5356
5594
|
|
|
5357
5595
|
<div class="padding-left--md">
|
|
5358
5596
|
|
|
@@ -5360,6 +5598,8 @@ Lists all Java processes discovered in the environment that are available for JM
|
|
|
5360
5598
|
|
|
5361
5599
|
**Required scope:** extensions:discovery.jmx:read
|
|
5362
5600
|
|
|
5601
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5602
|
+
|
|
5363
5603
|
|
|
5364
5604
|
|
|
5365
5605
|
</div>
|
|
@@ -5407,10 +5647,12 @@ const data = await extensions_2_0Client.listJmxProcesses();
|
|
|
5407
5647
|
|
|
5408
5648
|
|
|
5409
5649
|
<a name="listpmiprocesses"></a>
|
|
5410
|
-
### listPmiProcesses
|
|
5650
|
+
### ~~listPmiProcesses~~
|
|
5651
|
+
|
|
5652
|
+
> ⚠️ **Deprecated**
|
|
5411
5653
|
|
|
5412
5654
|
<div class="padding-bottom--md">
|
|
5413
|
-
<strong>extensions_2_0Client.listPmiProcesses(config): Promise<Array<<a href="#javaprocesscontainerlist">JavaProcessContainerList</a>>></strong>
|
|
5655
|
+
<strong>extensions_2_0Client.listPmiProcesses(config): Promise<Array<<a href="#javaprocesscontainerlist" target="_blank" rel="noopener noreferrer">JavaProcessContainerList</a>>></strong>
|
|
5414
5656
|
|
|
5415
5657
|
<div class="padding-left--md">
|
|
5416
5658
|
|
|
@@ -5418,6 +5660,8 @@ Lists all Java processes discovered in the environment that are available for PM
|
|
|
5418
5660
|
|
|
5419
5661
|
**Required scope:** extensions:discovery.pmi:read
|
|
5420
5662
|
|
|
5663
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5664
|
+
|
|
5421
5665
|
|
|
5422
5666
|
|
|
5423
5667
|
</div>
|
|
@@ -5468,7 +5712,7 @@ const data = await extensions_2_0Client.listPmiProcesses();
|
|
|
5468
5712
|
### listSchemaFiles
|
|
5469
5713
|
|
|
5470
5714
|
<div class="padding-bottom--md">
|
|
5471
|
-
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles"
|
|
5715
|
+
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles">SchemaFiles</a>></strong>
|
|
5472
5716
|
|
|
5473
5717
|
<div class="padding-left--md">
|
|
5474
5718
|
|
|
@@ -5481,6 +5725,10 @@ Lists all the files available for the specified extension 2.0 schema version
|
|
|
5481
5725
|
|
|
5482
5726
|
|
|
5483
5727
|
|
|
5728
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5729
|
+
|
|
5730
|
+
|
|
5731
|
+
|
|
5484
5732
|
</div>
|
|
5485
5733
|
|
|
5486
5734
|
|
|
@@ -5564,10 +5812,12 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
5564
5812
|
|
|
5565
5813
|
|
|
5566
5814
|
<a name="listschemas"></a>
|
|
5567
|
-
### listSchemas
|
|
5815
|
+
### ~~listSchemas~~
|
|
5816
|
+
|
|
5817
|
+
> ⚠️ **Deprecated**
|
|
5568
5818
|
|
|
5569
5819
|
<div class="padding-bottom--md">
|
|
5570
|
-
<strong>extensions_2_0Client.listSchemas(config): Promise<<a href="#schemaslist">SchemasList</a>></strong>
|
|
5820
|
+
<strong>extensions_2_0Client.listSchemas(config): Promise<<a href="#schemaslist" target="_blank" rel="noopener noreferrer">SchemasList</a>></strong>
|
|
5571
5821
|
|
|
5572
5822
|
<div class="padding-left--md">
|
|
5573
5823
|
|
|
@@ -5580,6 +5830,10 @@ Lists all the extension 2.0 schemas versions available in your environment
|
|
|
5580
5830
|
|
|
5581
5831
|
|
|
5582
5832
|
|
|
5833
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5834
|
+
|
|
5835
|
+
|
|
5836
|
+
|
|
5583
5837
|
</div>
|
|
5584
5838
|
|
|
5585
5839
|
|
|
@@ -5617,10 +5871,12 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
5617
5871
|
|
|
5618
5872
|
|
|
5619
5873
|
<a name="monitoringconfigurationaudit"></a>
|
|
5620
|
-
### monitoringConfigurationAudit
|
|
5874
|
+
### ~~monitoringConfigurationAudit~~
|
|
5875
|
+
|
|
5876
|
+
> ⚠️ **Deprecated**
|
|
5621
5877
|
|
|
5622
5878
|
<div class="padding-bottom--md">
|
|
5623
|
-
<strong>extensions_2_0Client.monitoringConfigurationAudit(config): Promise<<a href="#auditlog"
|
|
5879
|
+
<strong>extensions_2_0Client.monitoringConfigurationAudit(config): Promise<<a href="#auditlog">AuditLog</a>></strong>
|
|
5624
5880
|
|
|
5625
5881
|
<div class="padding-left--md">
|
|
5626
5882
|
|
|
@@ -5633,6 +5889,10 @@ Gets the audit logs of monitoring configuration of given extension
|
|
|
5633
5889
|
|
|
5634
5890
|
|
|
5635
5891
|
|
|
5892
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5893
|
+
|
|
5894
|
+
|
|
5895
|
+
|
|
5636
5896
|
</div>
|
|
5637
5897
|
|
|
5638
5898
|
|
|
@@ -5688,10 +5948,12 @@ const data =
|
|
|
5688
5948
|
|
|
5689
5949
|
|
|
5690
5950
|
<a name="monitoringconfigurationdetails"></a>
|
|
5691
|
-
### monitoringConfigurationDetails
|
|
5951
|
+
### ~~monitoringConfigurationDetails~~
|
|
5952
|
+
|
|
5953
|
+
> ⚠️ **Deprecated**
|
|
5692
5954
|
|
|
5693
5955
|
<div class="padding-bottom--md">
|
|
5694
|
-
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>></strong>
|
|
5956
|
+
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfiguration</a>></strong>
|
|
5695
5957
|
|
|
5696
5958
|
<div class="padding-left--md">
|
|
5697
5959
|
|
|
@@ -5704,6 +5966,10 @@ Gets the details of the specified monitoring configuration
|
|
|
5704
5966
|
|
|
5705
5967
|
|
|
5706
5968
|
|
|
5969
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
5970
|
+
|
|
5971
|
+
|
|
5972
|
+
|
|
5707
5973
|
</div>
|
|
5708
5974
|
|
|
5709
5975
|
|
|
@@ -5753,10 +6019,12 @@ const data =
|
|
|
5753
6019
|
|
|
5754
6020
|
|
|
5755
6021
|
<a name="removeextension"></a>
|
|
5756
|
-
### removeExtension
|
|
6022
|
+
### ~~removeExtension~~
|
|
6023
|
+
|
|
6024
|
+
> ⚠️ **Deprecated**
|
|
5757
6025
|
|
|
5758
6026
|
<div class="padding-bottom--md">
|
|
5759
|
-
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension"
|
|
6027
|
+
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
5760
6028
|
|
|
5761
6029
|
<div class="padding-left--md">
|
|
5762
6030
|
|
|
@@ -5769,6 +6037,10 @@ Deletes the specified version of the extension 2.0
|
|
|
5769
6037
|
|
|
5770
6038
|
|
|
5771
6039
|
|
|
6040
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
6041
|
+
|
|
6042
|
+
|
|
6043
|
+
|
|
5772
6044
|
</div>
|
|
5773
6045
|
|
|
5774
6046
|
|
|
@@ -5818,7 +6090,9 @@ const data = await extensions_2_0Client.removeExtension({
|
|
|
5818
6090
|
|
|
5819
6091
|
|
|
5820
6092
|
<a name="removemonitoringconfiguration"></a>
|
|
5821
|
-
### removeMonitoringConfiguration
|
|
6093
|
+
### ~~removeMonitoringConfiguration~~
|
|
6094
|
+
|
|
6095
|
+
> ⚠️ **Deprecated**
|
|
5822
6096
|
|
|
5823
6097
|
<div class="padding-bottom--md">
|
|
5824
6098
|
<strong>extensions_2_0Client.removeMonitoringConfiguration(config): Promise<void></strong>
|
|
@@ -5834,6 +6108,10 @@ Deletes the specified monitoring configuration
|
|
|
5834
6108
|
|
|
5835
6109
|
|
|
5836
6110
|
|
|
6111
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
6112
|
+
|
|
6113
|
+
|
|
6114
|
+
|
|
5837
6115
|
</div>
|
|
5838
6116
|
|
|
5839
6117
|
|
|
@@ -5884,10 +6162,12 @@ const data =
|
|
|
5884
6162
|
|
|
5885
6163
|
|
|
5886
6164
|
<a name="updateextensionenvironmentconfiguration"></a>
|
|
5887
|
-
### updateExtensionEnvironmentConfiguration
|
|
6165
|
+
### ~~updateExtensionEnvironmentConfiguration~~
|
|
6166
|
+
|
|
6167
|
+
> ⚠️ **Deprecated**
|
|
5888
6168
|
|
|
5889
6169
|
<div class="padding-bottom--md">
|
|
5890
|
-
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
6170
|
+
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
5891
6171
|
|
|
5892
6172
|
<div class="padding-left--md">
|
|
5893
6173
|
|
|
@@ -5900,6 +6180,10 @@ Updates the active environment configuration version of the extension 2.0
|
|
|
5900
6180
|
|
|
5901
6181
|
|
|
5902
6182
|
|
|
6183
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
6184
|
+
|
|
6185
|
+
|
|
6186
|
+
|
|
5903
6187
|
</div>
|
|
5904
6188
|
|
|
5905
6189
|
|
|
@@ -5907,7 +6191,7 @@ Updates the active environment configuration version of the extension 2.0
|
|
|
5907
6191
|
|
|
5908
6192
|
| Name | Type | Description |
|
|
5909
6193
|
| --- | --- | --- |
|
|
5910
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion"
|
|
6194
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
5911
6195
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
5912
6196
|
|
|
5913
6197
|
|
|
@@ -5949,10 +6233,12 @@ const data =
|
|
|
5949
6233
|
|
|
5950
6234
|
|
|
5951
6235
|
<a name="updatemonitoringconfiguration"></a>
|
|
5952
|
-
### updateMonitoringConfiguration
|
|
6236
|
+
### ~~updateMonitoringConfiguration~~
|
|
6237
|
+
|
|
6238
|
+
> ⚠️ **Deprecated**
|
|
5953
6239
|
|
|
5954
6240
|
<div class="padding-bottom--md">
|
|
5955
|
-
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>></strong>
|
|
6241
|
+
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse" target="_blank" rel="noopener noreferrer">MonitoringConfigurationResponse</a>></strong>
|
|
5956
6242
|
|
|
5957
6243
|
<div class="padding-left--md">
|
|
5958
6244
|
|
|
@@ -5965,6 +6251,10 @@ Updates the specified monitoring configuration
|
|
|
5965
6251
|
|
|
5966
6252
|
|
|
5967
6253
|
|
|
6254
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
6255
|
+
|
|
6256
|
+
|
|
6257
|
+
|
|
5968
6258
|
</div>
|
|
5969
6259
|
|
|
5970
6260
|
|
|
@@ -5972,7 +6262,7 @@ Updates the specified monitoring configuration
|
|
|
5972
6262
|
|
|
5973
6263
|
| Name | Type | Description |
|
|
5974
6264
|
| --- | --- | --- |
|
|
5975
|
-
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto"
|
|
6265
|
+
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto">MonitoringConfigurationUpdateDto</a>| |
|
|
5976
6266
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
5977
6267
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
5978
6268
|
|
|
@@ -6017,10 +6307,12 @@ const data =
|
|
|
6017
6307
|
|
|
6018
6308
|
|
|
6019
6309
|
<a name="uploadextension"></a>
|
|
6020
|
-
### uploadExtension
|
|
6310
|
+
### ~~uploadExtension~~
|
|
6311
|
+
|
|
6312
|
+
> ⚠️ **Deprecated**
|
|
6021
6313
|
|
|
6022
6314
|
<div class="padding-bottom--md">
|
|
6023
|
-
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto">ExtensionUploadResponseDto</a>></strong>
|
|
6315
|
+
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto" target="_blank" rel="noopener noreferrer">ExtensionUploadResponseDto</a>></strong>
|
|
6024
6316
|
|
|
6025
6317
|
<div class="padding-left--md">
|
|
6026
6318
|
|
|
@@ -6033,6 +6325,10 @@ Uploads or verifies a new extension 2.0
|
|
|
6033
6325
|
|
|
6034
6326
|
|
|
6035
6327
|
|
|
6328
|
+
Deprecated since version 1.342. Use the successor API `/platform/extensions/v2` instead.
|
|
6329
|
+
|
|
6330
|
+
|
|
6331
|
+
|
|
6036
6332
|
</div>
|
|
6037
6333
|
|
|
6038
6334
|
|
|
@@ -6078,6 +6374,79 @@ const data = await extensions_2_0Client.uploadExtension({
|
|
|
6078
6374
|
|
|
6079
6375
|
|
|
6080
6376
|
|
|
6377
|
+
</div>
|
|
6378
|
+
|
|
6379
|
+
## fleetManagementContainerImagesClient
|
|
6380
|
+
|
|
6381
|
+
```js
|
|
6382
|
+
import { fleetManagementContainerImagesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
6383
|
+
```
|
|
6384
|
+
|
|
6385
|
+
|
|
6386
|
+
<a name="getcontainerimages"></a>
|
|
6387
|
+
### getContainerImages
|
|
6388
|
+
|
|
6389
|
+
<div class="padding-bottom--md">
|
|
6390
|
+
<strong>fleetManagementContainerImagesClient.getContainerImages(config): Promise<<a href="#containerimagedata">ContainerImageData</a>></strong>
|
|
6391
|
+
|
|
6392
|
+
<div class="padding-left--md">
|
|
6393
|
+
|
|
6394
|
+
Returns container images data
|
|
6395
|
+
|
|
6396
|
+
**One of the following scopes is required:**
|
|
6397
|
+
+ environment-api:deployment:download
|
|
6398
|
+
+ fleet-management:container-images:read
|
|
6399
|
+
|
|
6400
|
+
|
|
6401
|
+
**One of the following permissions is required:**
|
|
6402
|
+
+ environment:roles:agent-install
|
|
6403
|
+
+ fleet-management:container-images:read
|
|
6404
|
+
|
|
6405
|
+
|
|
6406
|
+
|
|
6407
|
+
</div>
|
|
6408
|
+
|
|
6409
|
+
|
|
6410
|
+
#### Parameters
|
|
6411
|
+
|
|
6412
|
+
| Name | Type | Description |
|
|
6413
|
+
| --- | --- | --- |
|
|
6414
|
+
|config.registry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry name containing the container images. For a list of registries, see <a href="https://dt-url.net/mf239va" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a> |
|
|
6415
|
+
|config.registryFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Partial registry name filter. Returns images for the first registry whose name contains this value. Ignored when 'registry' is provided. |
|
|
6416
|
+
|
|
6417
|
+
|
|
6418
|
+
|
|
6419
|
+
|
|
6420
|
+
#### Returns
|
|
6421
|
+
|
|
6422
|
+
| Return type | Status code | Description |
|
|
6423
|
+
|---|---|---|
|
|
6424
|
+
|[ContainerImageData](#containerimagedata)|200|Container images data returned|
|
|
6425
|
+
|
|
6426
|
+
|
|
6427
|
+
#### Throws
|
|
6428
|
+
|
|
6429
|
+
| Error Type | Error Message |
|
|
6430
|
+
|---|---|
|
|
6431
|
+
|ErrorEnvelopeError|Failed. The input is invalid. | Internal server error. | Client side error. | Server side error.|
|
|
6432
|
+
|
|
6433
|
+
|
|
6434
|
+
<details>
|
|
6435
|
+
<summary>
|
|
6436
|
+
Code example
|
|
6437
|
+
</summary>
|
|
6438
|
+
|
|
6439
|
+
```ts
|
|
6440
|
+
import { fleetManagementContainerImagesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
6441
|
+
|
|
6442
|
+
const data =
|
|
6443
|
+
await fleetManagementContainerImagesClient.getContainerImages();
|
|
6444
|
+
```
|
|
6445
|
+
|
|
6446
|
+
</details>
|
|
6447
|
+
|
|
6448
|
+
|
|
6449
|
+
|
|
6081
6450
|
</div>
|
|
6082
6451
|
|
|
6083
6452
|
## javaScriptMappingFilesClient
|
|
@@ -6882,7 +7251,11 @@ const data = await logsClient.getLogRecords();
|
|
|
6882
7251
|
|
|
6883
7252
|
Pushes log records to Dynatrace
|
|
6884
7253
|
|
|
6885
|
-
**
|
|
7254
|
+
**One of the following scopes is required:**
|
|
7255
|
+
+ openpipeline:logs:ingest
|
|
7256
|
+
+ storage:logs:write
|
|
7257
|
+
|
|
7258
|
+
|
|
6886
7259
|
|
|
6887
7260
|
Ingested logs are stored in Dynatrace.
|
|
6888
7261
|
|
|
@@ -7205,7 +7578,9 @@ const data = await metricsClient.delete({
|
|
|
7205
7578
|
|
|
7206
7579
|
Pushes metric data points to Dynatrace
|
|
7207
7580
|
|
|
7208
|
-
**
|
|
7581
|
+
**One of the following scopes is required:**
|
|
7582
|
+
+ storage:metrics:write
|
|
7583
|
+
+ openpipeline:metrics:ingest
|
|
7209
7584
|
|
|
7210
7585
|
|
|
7211
7586
|
|
|
@@ -9583,8 +9958,14 @@ import { problemsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
9583
9958
|
|
|
9584
9959
|
Closes the specified problem and adds a closing comment on it
|
|
9585
9960
|
|
|
9586
|
-
**
|
|
9587
|
-
|
|
9961
|
+
**One of the following scopes is required:**
|
|
9962
|
+
+ openpipeline:events.davis:ingest
|
|
9963
|
+
+ environment-api:problems:write
|
|
9964
|
+
|
|
9965
|
+
|
|
9966
|
+
**One of the following permissions is required:**
|
|
9967
|
+
+ environment:roles:viewer
|
|
9968
|
+
+ openpipeline:events.davis:ingest
|
|
9588
9969
|
|
|
9589
9970
|
|
|
9590
9971
|
|
|
@@ -14388,9 +14769,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
14388
14769
|
Creates a synthetic monitor definition. | maturity=EARLY_ADOPTER
|
|
14389
14770
|
|
|
14390
14771
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
14391
|
-
**
|
|
14392
|
-
+ environment:roles:manage-settings
|
|
14393
|
-
+ synthetic:monitors:write
|
|
14772
|
+
**Required permission:** environment:roles:manage-settings
|
|
14394
14773
|
|
|
14395
14774
|
|
|
14396
14775
|
|
|
@@ -15161,7 +15540,7 @@ Parameters of the ActiveGate.
|
|
|
15161
15540
|
| Name | Type | Description |
|
|
15162
15541
|
| --- | --- | --- |
|
|
15163
15542
|
|activeGateTokens|Array<<a href="#activegatetokeninfodto">ActiveGateTokenInfoDto</a>>|A list of the ActiveGate tokens. |
|
|
15164
|
-
|autoUpdateSettings|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>|
|
|
15543
|
+
|autoUpdateSettings|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>|Auto-update configuration for an individual environment ActiveGate. |
|
|
15165
15544
|
|autoUpdateStatus|"UNKNOWN" | "INCOMPATIBLE" | "OUTDATED" | "SCHEDULED" | "SUPPRESSED" | "UP2DATE" | "UPDATE_IN_PROGRESS" | "UPDATE_PENDING" | "UPDATE_PROBLEM"|The current status of auto-updates of the ActiveGate. |
|
|
15166
15545
|
|connectedHosts|<a href="#activegateconnectedhosts">ActiveGateConnectedHosts</a>|Information about hosts currently connected to the ActiveGate |
|
|
15167
15546
|
|containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ActiveGate is deployed in container (<code>true</code>) or not (<code>false</code>). |
|
|
@@ -15184,12 +15563,14 @@ Parameters of the ActiveGate.
|
|
|
15184
15563
|
|
|
15185
15564
|
### ActiveGateAutoUpdateConfig
|
|
15186
15565
|
|
|
15187
|
-
|
|
15566
|
+
Auto-update configuration for an individual environment ActiveGate.
|
|
15188
15567
|
|
|
15189
15568
|
| Name | Type | Description |
|
|
15190
15569
|
| --- | --- | --- |
|
|
15191
15570
|
|effectiveSetting|"ENABLED" | "DISABLED"|<p>The actual state of the ActiveGate auto-update.</p> <p>Applicable only if the <strong>setting</strong> parameter is set to <code>INHERITED</code>. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the <strong>setting</strong> value.</p> |
|
|
15192
|
-
|setting<sup>*required</sup>|"ENABLED" | "DISABLED" | "INHERITED"|<p>The state of the ActiveGate auto-update: enabled, disabled, or inherited.</p> <p>If set to <code>INHERITED</code>, the setting is inherited from the global
|
|
15571
|
+
|setting<sup>*required</sup>|"ENABLED" | "DISABLED" | "INHERITED"|<p>The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.</p> <p>If set to <code>INHERITED</code>, the setting is inherited from the global environment ActiveGate auto-update configuration.</p> |
|
|
15572
|
+
|targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The target version of the ActiveGate.</p> <p>Specify the version in the <code><major>.<minor></code> format (for example <code>1.342</code>) or <code>latest</code>, <code>previous</code>, or <code>older</code>.</p> |
|
|
15573
|
+
|updateWindows|<a href="#updatewindowsconfig">UpdateWindowsConfig</a>|Basic information about all configured update windows |
|
|
15193
15574
|
|
|
15194
15575
|
### ActiveGateConnectedHosts
|
|
15195
15576
|
|
|
@@ -15201,12 +15582,14 @@ Information about hosts currently connected to the ActiveGate
|
|
|
15201
15582
|
|
|
15202
15583
|
### ActiveGateGlobalAutoUpdateConfig
|
|
15203
15584
|
|
|
15204
|
-
Global configuration
|
|
15585
|
+
Global auto-update configuration for environment ActiveGates. Applies to all environment ActiveGates that have the `INHERITED` auto-update setting.
|
|
15205
15586
|
|
|
15206
15587
|
| Name | Type | Description |
|
|
15207
15588
|
| --- | --- | --- |
|
|
15208
|
-
|globalSetting<sup>*required</sup>|"ENABLED" | "DISABLED"|<p>The state of auto-updates for all
|
|
15209
|
-
|metadata|<a href="#configurationmetadata">ConfigurationMetadata</a>|Metadata useful for debugging |
|
|
15589
|
+
|globalSetting<sup>*required</sup>|"ENABLED" | "DISABLED"|<p>The state of auto-updates for all environment ActiveGates.</p> <p>This setting is inherited by all environment ActiveGates that have the <code>INHERITED</code> setting.</p> |
|
|
15590
|
+
|metadata|<a href="#configurationmetadata" target="_blank" rel="noopener noreferrer">ConfigurationMetadata</a>|Metadata useful for debugging |
|
|
15591
|
+
|targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Version to update a ActiveGate to when automatic updates are enabled.</p> <p>Supports relative versions <code>latest</code>, <code>previous</code> and <code>older</code> as well as specific version in <code><major>.<minor></code> format (for example <code>1.261</code>).</p> <p>Only applicable when the <strong>setting</strong> parameter is set to <code>ENABLED</code>.</p> |
|
|
15592
|
+
|updateWindows|<a href="#updatewindowsconfig">UpdateWindowsConfig</a>|Basic information about all configured update windows |
|
|
15210
15593
|
|
|
15211
15594
|
### ActiveGateGroup
|
|
15212
15595
|
|
|
@@ -15344,6 +15727,12 @@ A list of ActiveGate tokens.
|
|
|
15344
15727
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
15345
15728
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
15346
15729
|
|
|
15730
|
+
### AdaptiveTrafficManagementDto
|
|
15731
|
+
|
|
15732
|
+
| Name | Type |
|
|
15733
|
+
| --- | --- |
|
|
15734
|
+
|rootSpansPerMinute|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
15735
|
+
|
|
15347
15736
|
### AddEntityTag
|
|
15348
15737
|
|
|
15349
15738
|
The custom tag to be added to monitored entities.
|
|
@@ -15443,7 +15832,7 @@ Metadata of an API token.
|
|
|
15443
15832
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
15444
15833
|
|owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the token. |
|
|
15445
15834
|
|personalAccessToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is a <a href="https://dt-url.net/wm03sop" target="_blank" rel="noopener noreferrer" >personal access token</a> (<code>true</code>) or an API token (<code>false</code>). |
|
|
15446
|
-
|scopes|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DiagnosticExport" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "MemoryDump" | "Mobile" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "ViewDashboard" | "ViewReport" | "WriteConfig" | "WriteSyntheticData" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|A list of scopes assigned to the token. |
|
|
15835
|
+
|scopes|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DiagnosticExport" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "MemoryDump" | "Mobile" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "ViewDashboard" | "ViewReport" | "WriteConfig" | "WriteSyntheticData" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|A list of scopes assigned to the token. |
|
|
15447
15836
|
|
|
15448
15837
|
### ApiTokenCreate
|
|
15449
15838
|
|
|
@@ -15454,7 +15843,7 @@ Parameters of a new API token.
|
|
|
15454
15843
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</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 token never expires. Ensure that the expiration date is not set in the past.</p> |
|
|
15455
15844
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
15456
15845
|
|personalAccessToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p> |
|
|
15457
|
-
|scopes<sup>*required</sup>|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events (Built-in).</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>agentTokenManagement.read</code>: Read Agent tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> <li><code>rumManualInsertionTags.read</code>: Read RUM manual insertion tags.</li> <li><code>extensionDiscoveryJmx.read</code>: Read discovered JMX metrics via extensions.</li> <li><code>extensionDiscoveryPmi.read</code>: Read discovered PMI metrics via extensions.</li> </ul> |
|
|
15846
|
+
|scopes<sup>*required</sup>|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events (Built-in).</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).</li> <li><code>openpipeline.events_smartscape</code>: OpenPipeline - Ingest Smartscape Events (Built-in).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>agentTokenManagement.read</code>: Read Agent tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> <li><code>rumManualInsertionTags.read</code>: Read RUM manual insertion tags.</li> <li><code>extensionDiscoveryJmx.read</code>: Read discovered JMX metrics via extensions.</li> <li><code>extensionDiscoveryPmi.read</code>: Read discovered PMI metrics via extensions.</li> </ul> |
|
|
15458
15847
|
|
|
15459
15848
|
### ApiTokenCreated
|
|
15460
15849
|
|
|
@@ -15491,7 +15880,7 @@ The update of the API token.
|
|
|
15491
15880
|
| --- | --- | --- |
|
|
15492
15881
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
15493
15882
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
15494
|
-
|scopes|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|<p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events (Built-in).</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>agentTokenManagement.read</code>: Read Agent tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> <li><code>rumManualInsertionTags.read</code>: Read RUM manual insertion tags.</li> <li><code>extensionDiscoveryJmx.read</code>: Read discovered JMX metrics via extensions.</li> <li><code>extensionDiscoveryPmi.read</code>: Read discovered PMI metrics via extensions.</li> </ul> |
|
|
15883
|
+
|scopes|Array<"ActiveGateCertManagement" | "AdvancedSyntheticIntegration" | "CaptureRequestData" | "DTAQLAccess" | "DataExport" | "DataImport" | "DataPrivacy" | "Davis" | "DssFileManagement" | "ExternalSyntheticIntegration" | "InstallerDownload" | "LogExport" | "PluginUpload" | "ReadConfig" | "ReadSyntheticData" | "RestRequestForwarding" | "RumBrowserExtension" | "RumJavaScriptTagManagement" | "SupportAlert" | "TenantTokenManagement" | "UserSessionAnonymization" | "WriteConfig" | "activeGateTokenManagement.create" | "activeGateTokenManagement.read" | "activeGateTokenManagement.write" | "activeGates.read" | "activeGates.write" | "adaptiveTrafficManagement.read" | "agentTokenManagement.read" | "apiTokens.read" | "apiTokens.write" | "attacks.read" | "attacks.write" | "auditLogs.read" | "bizevents.ingest" | "credentialVault.read" | "credentialVault.write" | "entities.read" | "entities.write" | "events.ingest" | "events.read" | "extensionConfigurationActions.write" | "extensionConfigurations.read" | "extensionConfigurations.write" | "extensionDiscoveryJmx.read" | "extensionDiscoveryPmi.read" | "extensionEnvironment.read" | "extensionEnvironment.write" | "extensions.read" | "extensions.write" | "geographicRegions.read" | "hub.install" | "hub.read" | "hub.write" | "javaScriptMappingFiles.read" | "javaScriptMappingFiles.write" | "logs.ingest" | "logs.read" | "metrics.ingest" | "metrics.read" | "metrics.write" | "networkZones.read" | "networkZones.write" | "oneAgents.read" | "oneAgents.write" | "openTelemetryTrace.ingest" | "openpipeline.events" | "openpipeline.events.custom" | "openpipeline.events_sdlc" | "openpipeline.events_sdlc.custom" | "openpipeline.events_security" | "openpipeline.events_security.custom" | "openpipeline.events_smartscape" | "problems.read" | "problems.write" | "releases.read" | "rumCookieNames.read" | "rumManualInsertionTags.read" | "securityProblems.read" | "securityProblems.write" | "settings.read" | "settings.write" | "slo.read" | "slo.write" | "syntheticExecutions.read" | "syntheticExecutions.write" | "syntheticLocations.read" | "syntheticLocations.write" | "tenantTokenRotation.write" | "traces.lookup" | "unifiedAnalysis.read">|<p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events (Built-in).</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).</li> <li><code>openpipeline.events_smartscape</code>: OpenPipeline - Ingest Smartscape Events (Built-in).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>agentTokenManagement.read</code>: Read Agent tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> <li><code>rumManualInsertionTags.read</code>: Read RUM manual insertion tags.</li> <li><code>extensionDiscoveryJmx.read</code>: Read discovered JMX metrics via extensions.</li> <li><code>extensionDiscoveryPmi.read</code>: Read discovered PMI metrics via extensions.</li> </ul> |
|
|
15495
15884
|
|
|
15496
15885
|
### ApplicationImpact
|
|
15497
15886
|
|
|
@@ -15538,7 +15927,7 @@ Metadata for an extension asset.
|
|
|
15538
15927
|
|assetSchemaDetails|<a href="#assetschemadetailsdto">AssetSchemaDetailsDto</a>|Settings schema details for asset |
|
|
15539
15928
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-friendly name of the asset. |
|
|
15540
15929
|
|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). |
|
|
15541
|
-
|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. |
|
|
15930
|
+
|type|"ALERT" | "ALERT_TEMPLATE" | "AWS_SERVICE" | "CUSTOM_CARDS" | "DASHBOARD" | "DECLARATIVE_PROCESSES" | "DOCUMENT_DASHBOARD" | "DOCUMENT_SCREEN" | "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. |
|
|
15542
15931
|
|
|
15543
15932
|
### AssetSchemaDetailsDto
|
|
15544
15933
|
|
|
@@ -16041,13 +16430,31 @@ A list of constraint violations
|
|
|
16041
16430
|
|parameterLocation|"HEADER" | "PATH" | "PAYLOAD_BODY" | "QUERY"|
|
|
16042
16431
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
16043
16432
|
|
|
16433
|
+
### ContainerImageComponent
|
|
16434
|
+
|
|
16435
|
+
Information about component type and images registry URI.
|
|
16436
|
+
|
|
16437
|
+
| Name | Type | Description |
|
|
16438
|
+
| --- | --- | --- |
|
|
16439
|
+
|imageUri|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry URI of the container image component. |
|
|
16440
|
+
|type|"activegate" | "codemodules" | "database-datasource-executor" | "dynatrace-sql-extension-executor" | "eec" | "logmodule" | "oneagent"|Container image component type. |
|
|
16441
|
+
|
|
16442
|
+
### ContainerImageData
|
|
16443
|
+
|
|
16444
|
+
Information about images registry and components with URI.
|
|
16445
|
+
|
|
16446
|
+
| Name | Type | Description |
|
|
16447
|
+
| --- | --- | --- |
|
|
16448
|
+
|components|Array<<a href="#containerimagecomponent">ContainerImageComponent</a>>|List of container image components. |
|
|
16449
|
+
|registry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry name containing container images. |
|
|
16450
|
+
|
|
16044
16451
|
### CookieStepDto
|
|
16045
16452
|
|
|
16046
16453
|
Cookie step of Browser Monitor.
|
|
16047
16454
|
|
|
16048
16455
|
| Name | Type | Description |
|
|
16049
16456
|
| --- | --- | --- |
|
|
16050
|
-
|cookies<sup>*required</sup>|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies. |
|
|
16457
|
+
|cookies<sup>*required</sup>|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies. |
|
|
16051
16458
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
16052
16459
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
16053
16460
|
|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> |
|
|
@@ -16079,7 +16486,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
16079
16486
|
| Name | Type | Description |
|
|
16080
16487
|
| --- | --- | --- |
|
|
16081
16488
|
|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). |
|
|
16082
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
16489
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
16083
16490
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
16084
16491
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
16085
16492
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
@@ -16096,9 +16503,9 @@ Details of certificate credentials set.
|
|
|
16096
16503
|
| --- | --- | --- |
|
|
16097
16504
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Base64 encoded certificate bytes |
|
|
16098
16505
|
|certificateType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Certificate type: PEM, PKCS12 or UNKNOWN |
|
|
16099
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
16506
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler" target="_blank" rel="noopener noreferrer">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
16100
16507
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
16101
|
-
|externalVault|<a href="#externalvaultconfig"
|
|
16508
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16102
16509
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
16103
16510
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
16104
16511
|
|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). |
|
|
@@ -16114,7 +16521,7 @@ A list of detailed credentials sets for Synthetic monitors.
|
|
|
16114
16521
|
| Name | Type | Description |
|
|
16115
16522
|
| --- | --- | --- |
|
|
16116
16523
|
|allowPlaybackWithPrefilledCredentials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |
|
|
16117
|
-
|credentials<sup>*required</sup>|Array<<a href="#abstractcredentialsresponseelement">AbstractCredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors. |
|
|
16524
|
+
|credentials<sup>*required</sup>|Array<<a href="#abstractcredentialsresponseelement" target="_blank" rel="noopener noreferrer">AbstractCredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors. |
|
|
16118
16525
|
|
|
16119
16526
|
### CredentialsDetailsTokenResponseElement
|
|
16120
16527
|
|
|
@@ -16122,9 +16529,9 @@ Details of the token credentials set.
|
|
|
16122
16529
|
|
|
16123
16530
|
| Name | Type | Description |
|
|
16124
16531
|
| --- | --- | --- |
|
|
16125
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16532
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
16126
16533
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
16127
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16534
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16128
16535
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
16129
16536
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
16130
16537
|
|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). |
|
|
@@ -16139,9 +16546,9 @@ Details of username and password credentials set.
|
|
|
16139
16546
|
|
|
16140
16547
|
| Name | Type | Description |
|
|
16141
16548
|
| --- | --- | --- |
|
|
16142
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16549
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
16143
16550
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
16144
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16551
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16145
16552
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
16146
16553
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
16147
16554
|
|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). |
|
|
@@ -16165,7 +16572,7 @@ A list of credentials sets for Synthetic monitors.
|
|
|
16165
16572
|
|
|
16166
16573
|
| Name | Type | Description |
|
|
16167
16574
|
| --- | --- | --- |
|
|
16168
|
-
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement"
|
|
16575
|
+
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement">CredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors. |
|
|
16169
16576
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
16170
16577
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
16171
16578
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
@@ -16177,10 +16584,10 @@ Metadata of the credentials set.
|
|
|
16177
16584
|
| Name | Type | Description |
|
|
16178
16585
|
| --- | --- | --- |
|
|
16179
16586
|
|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). |
|
|
16180
|
-
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
16181
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16587
|
+
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
16588
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
16182
16589
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
16183
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16590
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
16184
16591
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
16185
16592
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
16186
16593
|
|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). |
|
|
@@ -16197,7 +16604,7 @@ Analysis of problem impact to a custom application.
|
|
|
16197
16604
|
| --- | --- | --- |
|
|
16198
16605
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
16199
16606
|
|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> |
|
|
16200
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
16607
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16201
16608
|
|
|
16202
16609
|
### CustomDeviceCreation
|
|
16203
16610
|
|
|
@@ -16213,7 +16620,7 @@ Configuration of a custom device.
|
|
|
16213
16620
|
|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> |
|
|
16214
16621
|
|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> |
|
|
16215
16622
|
|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> |
|
|
16216
|
-
|properties|<a href="#customdevicecreationproperties">CustomDeviceCreationProperties</a>|The list of key-value pair properties that will be shown beneath the infographics of your custom device. |
|
|
16623
|
+
|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. |
|
|
16217
16624
|
|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> |
|
|
16218
16625
|
|
|
16219
16626
|
### CustomDeviceCreationProperties
|
|
@@ -16237,7 +16644,7 @@ A list of custom tags.
|
|
|
16237
16644
|
|
|
16238
16645
|
| Name | Type | Description |
|
|
16239
16646
|
| --- | --- | --- |
|
|
16240
|
-
|tags<sup>*required</sup>|Array<<a href="#metag"
|
|
16647
|
+
|tags<sup>*required</sup>|Array<<a href="#metag">METag</a>>|A list of custom tags. |
|
|
16241
16648
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of tags in the response. |
|
|
16242
16649
|
|
|
16243
16650
|
### CustomLogLine
|
|
@@ -16361,7 +16768,7 @@ A list of advice from the Davis security advisor.
|
|
|
16361
16768
|
|
|
16362
16769
|
| Name | Type | Description |
|
|
16363
16770
|
| --- | --- | --- |
|
|
16364
|
-
|advices|Array<<a href="#davissecurityadvice">DavisSecurityAdvice</a>>| |
|
|
16771
|
+
|advices|Array<<a href="#davissecurityadvice" target="_blank" rel="noopener noreferrer">DavisSecurityAdvice</a>>| |
|
|
16365
16772
|
|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> |
|
|
16366
16773
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16367
16774
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16399,7 +16806,7 @@ Defines a period of time.
|
|
|
16399
16806
|
|
|
16400
16807
|
| Name | Type | Description |
|
|
16401
16808
|
| --- | --- | --- |
|
|
16402
|
-
|context|<a href="#permissioncontext"
|
|
16809
|
+
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
16403
16810
|
|granted<sup>*required</sup>|"condition" | "false" | "true"| |
|
|
16404
16811
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
16405
16812
|
|
|
@@ -16426,7 +16833,7 @@ A list of effective settings values.
|
|
|
16426
16833
|
|
|
16427
16834
|
| Name | Type | Description |
|
|
16428
16835
|
| --- | --- | --- |
|
|
16429
|
-
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue">EffectiveSettingsValue</a>>|A list of effective settings values. |
|
|
16836
|
+
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue" target="_blank" rel="noopener noreferrer">EffectiveSettingsValue</a>>|A list of effective settings values. |
|
|
16430
16837
|
|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> |
|
|
16431
16838
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16432
16839
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16465,7 +16872,7 @@ A list of monitored entities along with their properties.
|
|
|
16465
16872
|
|
|
16466
16873
|
| Name | Type | Description |
|
|
16467
16874
|
| --- | --- | --- |
|
|
16468
|
-
|entities|Array<<a href="#entity"
|
|
16875
|
+
|entities|Array<<a href="#entity">Entity</a>>|A list of monitored entities. |
|
|
16469
16876
|
|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> |
|
|
16470
16877
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16471
16878
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16479,13 +16886,13 @@ The properties of a monitored entity.
|
|
|
16479
16886
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the entity, displayed in the UI. |
|
|
16480
16887
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the entity. |
|
|
16481
16888
|
|firstSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was first seen, in UTC milliseconds. |
|
|
16482
|
-
|fromRelationships|<a href="#entityfromrelationships">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position. |
|
|
16483
|
-
|icon|<a href="#entityicon"
|
|
16889
|
+
|fromRelationships|<a href="#entityfromrelationships" target="_blank" rel="noopener noreferrer">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position. |
|
|
16890
|
+
|icon|<a href="#entityicon">EntityIcon</a>|The icon of a monitored entity. |
|
|
16484
16891
|
|lastSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was last seen, in UTC milliseconds. |
|
|
16485
|
-
|managementZones|Array<<a href="#enrichedmanagementzonedto">EnrichedManagementZoneDto</a>>|A set of management zones to which the entity belongs. |
|
|
16486
|
-
|properties|<a href="#entityproperties"
|
|
16487
|
-
|tags|Array<<a href="#enrichedtagdto">EnrichedTagDto</a>>|A set of tags assigned to the entity. |
|
|
16488
|
-
|toRelationships|<a href="#entitytorelationships"
|
|
16892
|
+
|managementZones|Array<<a href="#enrichedmanagementzonedto" target="_blank" rel="noopener noreferrer">EnrichedManagementZoneDto</a>>|A set of management zones to which the entity belongs. |
|
|
16893
|
+
|properties|<a href="#entityproperties">EntityProperties</a>|A list of additional properties of the entity. |
|
|
16894
|
+
|tags|Array<<a href="#enrichedtagdto" target="_blank" rel="noopener noreferrer">EnrichedTagDto</a>>|A set of tags assigned to the entity. |
|
|
16895
|
+
|toRelationships|<a href="#entitytorelationships">EntityToRelationships</a>|A list of relationships where the entity occupies the TO position. |
|
|
16489
16896
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the entity. |
|
|
16490
16897
|
|
|
16491
16898
|
### EntityFromRelationships
|
|
@@ -16535,7 +16942,7 @@ A short representation of a monitored entity.
|
|
|
16535
16942
|
|
|
16536
16943
|
| Name | Type | Description |
|
|
16537
16944
|
| --- | --- | --- |
|
|
16538
|
-
|entityId|<a href="#entityid">EntityId</a>|A short representation of a monitored entity. |
|
|
16945
|
+
|entityId|<a href="#entityid" target="_blank" rel="noopener noreferrer">EntityId</a>|A short representation of a monitored entity. |
|
|
16539
16946
|
|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> |
|
|
16540
16947
|
|
|
16541
16948
|
### EntityToRelationships
|
|
@@ -16553,11 +16960,11 @@ A list of properties of the monitored entity type.
|
|
|
16553
16960
|
|dimensionKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dimension key used within metrics for this monitored entity. |
|
|
16554
16961
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the monitored entity. |
|
|
16555
16962
|
|entityLimitExceeded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether the entity creation limit for this type has been exceeded. When true, Dynatrace automatically triggers a cleanup process for this entity type. New entities will still be created, and no action is required. This applies only for builtin-types. For generic types creation and update gets blocked. You can recognize a generic type by containing ':' in the name for example my:type. |
|
|
16556
|
-
|fromRelationships|Array<<a href="#toposition"
|
|
16963
|
+
|fromRelationships|Array<<a href="#toposition">ToPosition</a>>|A list of possible relationships where the monitored entity type occupies the FROM position |
|
|
16557
16964
|
|managementZones|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of management zones of an actual entity. |
|
|
16558
|
-
|properties|Array<<a href="#entitytypepropertydto">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type. |
|
|
16965
|
+
|properties|Array<<a href="#entitytypepropertydto" target="_blank" rel="noopener noreferrer">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type. |
|
|
16559
16966
|
|tags|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of tags of an actual entity. |
|
|
16560
|
-
|toRelationships|Array<<a href="#fromposition"
|
|
16967
|
+
|toRelationships|Array<<a href="#fromposition">FromPosition</a>>|A list of possible relationships where the monitored entity type occupies the TO position. |
|
|
16561
16968
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the monitored entity. |
|
|
16562
16969
|
|
|
16563
16970
|
### EntityTypeList
|
|
@@ -16569,7 +16976,7 @@ A list of properties of all available entity types.
|
|
|
16569
16976
|
|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> |
|
|
16570
16977
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16571
16978
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
16572
|
-
|types|Array<<a href="#entitytype">EntityType</a>>|The list of meta information for all available entity-types |
|
|
16979
|
+
|types|Array<<a href="#entitytype" target="_blank" rel="noopener noreferrer">EntityType</a>>|The list of meta information for all available entity-types |
|
|
16573
16980
|
|
|
16574
16981
|
### EntityTypePropertyDto
|
|
16575
16982
|
|
|
@@ -16588,7 +16995,7 @@ Information about an entry point of a code-level vulnerability.
|
|
|
16588
16995
|
| Name | Type | Description |
|
|
16589
16996
|
| --- | --- | --- |
|
|
16590
16997
|
|sourceHttpPath|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Source HTTP path of entry points. |
|
|
16591
|
-
|usageSegments|Array<<a href="#entrypointusagesegment"
|
|
16998
|
+
|usageSegments|Array<<a href="#entrypointusagesegment">EntryPointUsageSegment</a>>|List of entry point usage segments. |
|
|
16592
16999
|
|
|
16593
17000
|
### EntryPointUsageSegment
|
|
16594
17001
|
|
|
@@ -16607,7 +17014,7 @@ A list of entry points and a flag which indicates whether this list was truncate
|
|
|
16607
17014
|
|
|
16608
17015
|
| Name | Type | Description |
|
|
16609
17016
|
| --- | --- | --- |
|
|
16610
|
-
|items|Array<<a href="#entrypoint">EntryPoint</a>>|A list of entry points. |
|
|
17017
|
+
|items|Array<<a href="#entrypoint" target="_blank" rel="noopener noreferrer">EntryPoint</a>>|A list of entry points. |
|
|
16611
17018
|
|truncated|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether the list of entry points was truncated or not. |
|
|
16612
17019
|
|
|
16613
17020
|
### EntrypointPayload
|
|
@@ -16630,7 +17037,7 @@ Definition of an enum property.
|
|
|
16630
17037
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
16631
17038
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
16632
17039
|
|enumClass|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An existing Java enum class that holds the allowed values of the enum. |
|
|
16633
|
-
|items<sup>*required</sup>|Array<<a href="#enumvalue"
|
|
17040
|
+
|items<sup>*required</sup>|Array<<a href="#enumvalue">EnumValue</a>>|A list of allowed values of the enum. |
|
|
16634
17041
|
|type<sup>*required</sup>|"enum"|The type of the property. |
|
|
16635
17042
|
|
|
16636
17043
|
### EnumValue
|
|
@@ -16650,14 +17057,14 @@ An allowed value for an enum property.
|
|
|
16650
17057
|
| Name | Type | Description |
|
|
16651
17058
|
| --- | --- | --- |
|
|
16652
17059
|
|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |
|
|
16653
|
-
|constraintViolations|Array<<a href="#constraintviolation">ConstraintViolation</a>>|A list of constraint violations |
|
|
17060
|
+
|constraintViolations|Array<<a href="#constraintviolation" target="_blank" rel="noopener noreferrer">ConstraintViolation</a>>|A list of constraint violations |
|
|
16654
17061
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
|
|
16655
17062
|
|
|
16656
17063
|
### ErrorEnvelope
|
|
16657
17064
|
|
|
16658
17065
|
| Name | Type |
|
|
16659
17066
|
| --- | --- |
|
|
16660
|
-
|error|<a href="#error"
|
|
17067
|
+
|error|<a href="#error">Error</a>|
|
|
16661
17068
|
|
|
16662
17069
|
### Event
|
|
16663
17070
|
|
|
@@ -16667,13 +17074,13 @@ Configuration of an event.
|
|
|
16667
17074
|
| --- | --- | --- |
|
|
16668
17075
|
|correlationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The correlation ID of the event. |
|
|
16669
17076
|
|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> |
|
|
16670
|
-
|entityId|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16671
|
-
|entityTags|Array<<a href="#metag"
|
|
17077
|
+
|entityId|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
17078
|
+
|entityTags|Array<<a href="#metag">METag</a>>|A list of tags of the related entity. |
|
|
16672
17079
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
16673
17080
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
16674
17081
|
|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> |
|
|
16675
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the event belongs to. |
|
|
16676
|
-
|properties|Array<<a href="#eventproperty"
|
|
17082
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of all management zones that the event belongs to. |
|
|
17083
|
+
|properties|Array<<a href="#eventproperty">EventProperty</a>>|A list of event properties. |
|
|
16677
17084
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event was raised, in UTC milliseconds. |
|
|
16678
17085
|
|status|"CLOSED" | "OPEN"|The status of the event. |
|
|
16679
17086
|
|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> |
|
|
@@ -16689,14 +17096,14 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
16689
17096
|
|
|
16690
17097
|
| Name | Type | Description |
|
|
16691
17098
|
| --- | --- | --- |
|
|
16692
|
-
|data|<a href="#event">Event</a>|Configuration of an event. |
|
|
17099
|
+
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>|Configuration of an event. |
|
|
16693
17100
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
16694
17101
|
|endTime<sup>*required</sup>|[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> |
|
|
16695
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
17102
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16696
17103
|
|eventId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
16697
17104
|
|eventType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
16698
17105
|
|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> |
|
|
16699
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17106
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
16700
17107
|
|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. |
|
|
16701
17108
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
16702
17109
|
|
|
@@ -16709,7 +17116,7 @@ The configuration of an event to be ingested.
|
|
|
16709
17116
|
|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> |
|
|
16710
17117
|
|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> |
|
|
16711
17118
|
|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. |
|
|
16712
|
-
|properties|<a href="#eventingestproperties"
|
|
17119
|
+
|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> |
|
|
16713
17120
|
|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> |
|
|
16714
17121
|
|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> |
|
|
16715
17122
|
|title<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the event. |
|
|
@@ -16743,7 +17150,7 @@ The results of an event ingest.
|
|
|
16743
17150
|
|
|
16744
17151
|
| Name | Type | Description |
|
|
16745
17152
|
| --- | --- | --- |
|
|
16746
|
-
|eventIngestResults|Array<<a href="#eventingestresult">EventIngestResult</a>>|The result of each created event report. |
|
|
17153
|
+
|eventIngestResults|Array<<a href="#eventingestresult" target="_blank" rel="noopener noreferrer">EventIngestResult</a>>|The result of each created event report. |
|
|
16747
17154
|
|reportCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of created event reports. |
|
|
16748
17155
|
|
|
16749
17156
|
### EventList
|
|
@@ -16752,7 +17159,7 @@ A list of events.
|
|
|
16752
17159
|
|
|
16753
17160
|
| Name | Type | Description |
|
|
16754
17161
|
| --- | --- | --- |
|
|
16755
|
-
|events|Array<<a href="#event"
|
|
17162
|
+
|events|Array<<a href="#event">Event</a>>|A list of events. |
|
|
16756
17163
|
|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> |
|
|
16757
17164
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16758
17165
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16764,7 +17171,7 @@ A list of event properties.
|
|
|
16764
17171
|
|
|
16765
17172
|
| Name | Type | Description |
|
|
16766
17173
|
| --- | --- | --- |
|
|
16767
|
-
|eventProperties|Array<<a href="#eventpropertydetails">EventPropertyDetails</a>>|A list of event properties. |
|
|
17174
|
+
|eventProperties|Array<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>>|A list of event properties. |
|
|
16768
17175
|
|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> |
|
|
16769
17176
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16770
17177
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16807,7 +17214,7 @@ A list of event types.
|
|
|
16807
17214
|
|
|
16808
17215
|
| Name | Type | Description |
|
|
16809
17216
|
| --- | --- | --- |
|
|
16810
|
-
|eventTypeInfos|Array<<a href="#eventtype"
|
|
17217
|
+
|eventTypeInfos|Array<<a href="#eventtype">EventType</a>>|A list of event types. |
|
|
16811
17218
|
|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> |
|
|
16812
17219
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16813
17220
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16821,9 +17228,9 @@ An evidence of a root cause.
|
|
|
16821
17228
|
| Name | Type | Description |
|
|
16822
17229
|
| --- | --- | --- |
|
|
16823
17230
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
16824
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17231
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
16825
17232
|
|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> |
|
|
16826
|
-
|groupingEntity|<a href="#entitystub"
|
|
17233
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16827
17234
|
|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. |
|
|
16828
17235
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
16829
17236
|
|
|
@@ -16833,14 +17240,14 @@ The evidence details of a problem.
|
|
|
16833
17240
|
|
|
16834
17241
|
| Name | Type | Description |
|
|
16835
17242
|
| --- | --- | --- |
|
|
16836
|
-
|details<sup>*required</sup>|Array<<a href="#evidence">Evidence</a>>|A list of all evidence. |
|
|
17243
|
+
|details<sup>*required</sup>|Array<<a href="#evidence" target="_blank" rel="noopener noreferrer">Evidence</a>>|A list of all evidence. |
|
|
16837
17244
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of evidence of a problem. |
|
|
16838
17245
|
|
|
16839
17246
|
### ExecuteActionsDto
|
|
16840
17247
|
|
|
16841
17248
|
| Name | Type | Description |
|
|
16842
17249
|
| --- | --- | --- |
|
|
16843
|
-
|actions|<a href="#executeactionsdtoactions"
|
|
17250
|
+
|actions|<a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a>|Data Source defined action objects |
|
|
16844
17251
|
|
|
16845
17252
|
### ExecuteActionsDtoActions
|
|
16846
17253
|
|
|
@@ -16864,7 +17271,7 @@ Contains extended monitor's execution details.
|
|
|
16864
17271
|
| --- | --- | --- |
|
|
16865
17272
|
|errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Error code. |
|
|
16866
17273
|
|executionStepCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number executed steps. |
|
|
16867
|
-
|executionSteps|Array<<a href="#executionstep">ExecutionStep</a>>|Details about the monitor's step execution. |
|
|
17274
|
+
|executionSteps|Array<<a href="#executionstep" target="_blank" rel="noopener noreferrer">ExecutionStep</a>>|Details about the monitor's step execution. |
|
|
16868
17275
|
|failedStepName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failed step name. |
|
|
16869
17276
|
|failedStepSequenceId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Failed step sequence id. |
|
|
16870
17277
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failure message. |
|
|
@@ -16913,7 +17320,7 @@ A list of exported log records.
|
|
|
16913
17320
|
| --- | --- | --- |
|
|
16914
17321
|
|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> |
|
|
16915
17322
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16916
|
-
|results|Array<<a href="#logrecord"
|
|
17323
|
+
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records. |
|
|
16917
17324
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
16918
17325
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
16919
17326
|
|
|
@@ -16921,11 +17328,11 @@ A list of exported log records.
|
|
|
16921
17328
|
|
|
16922
17329
|
| Name | Type | Description |
|
|
16923
17330
|
| --- | --- | --- |
|
|
16924
|
-
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author |
|
|
17331
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author |
|
|
16925
17332
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
16926
17333
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
16927
17334
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
16928
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails"
|
|
17335
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails">ExtensionFeatureSetsDetails</a>|Details of feature sets |
|
|
16929
17336
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
16930
17337
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
16931
17338
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -16938,7 +17345,7 @@ List of assets imported with the active extension environment configuration.
|
|
|
16938
17345
|
|
|
16939
17346
|
| Name | Type | Description |
|
|
16940
17347
|
| --- | --- | --- |
|
|
16941
|
-
|assets<sup>*required</sup>|Array<<a href="#assetinfodto">AssetInfoDto</a>>|The list of the imported assets. |
|
|
17348
|
+
|assets<sup>*required</sup>|Array<<a href="#assetinfodto" target="_blank" rel="noopener noreferrer">AssetInfoDto</a>>|The list of the imported assets. |
|
|
16942
17349
|
|errors<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of errors during asset import |
|
|
16943
17350
|
|status<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The status of the assets list. |
|
|
16944
17351
|
|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>|
|
|
@@ -16970,7 +17377,7 @@ A list of extensions with additional metadata.
|
|
|
16970
17377
|
|
|
16971
17378
|
| Name | Type | Description |
|
|
16972
17379
|
| --- | --- | --- |
|
|
16973
|
-
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo"
|
|
17380
|
+
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo">ExtensionInfo</a>>|A list of extensions with additional metadata. |
|
|
16974
17381
|
|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> |
|
|
16975
17382
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16976
17383
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16979,7 +17386,7 @@ A list of extensions with additional metadata.
|
|
|
16979
17386
|
|
|
16980
17387
|
| Name | Type | Description |
|
|
16981
17388
|
| --- | --- | --- |
|
|
16982
|
-
|extensions<sup>*required</sup>|Array<<a href="#minimalextension">MinimalExtension</a>>|A list of extensions. |
|
|
17389
|
+
|extensions<sup>*required</sup>|Array<<a href="#minimalextension" target="_blank" rel="noopener noreferrer">MinimalExtension</a>>|A list of extensions. |
|
|
16983
17390
|
|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> |
|
|
16984
17391
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
16985
17392
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -16996,7 +17403,7 @@ A list of extensions with additional metadata.
|
|
|
16996
17403
|
|
|
16997
17404
|
| Name | Type | Description |
|
|
16998
17405
|
| --- | --- | --- |
|
|
16999
|
-
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration"
|
|
17406
|
+
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>>|A list of extension monitoring configurations. |
|
|
17000
17407
|
|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> |
|
|
17001
17408
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
17002
17409
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -17020,12 +17427,12 @@ A list of extensions with additional metadata.
|
|
|
17020
17427
|
|
|
17021
17428
|
| Name | Type | Description |
|
|
17022
17429
|
| --- | --- | --- |
|
|
17023
|
-
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo">AssetInfo</a>>|Information about extension assets included |
|
|
17024
|
-
|author<sup>*required</sup>|<a href="#authordto"
|
|
17430
|
+
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo" target="_blank" rel="noopener noreferrer">AssetInfo</a>>|Information about extension assets included |
|
|
17431
|
+
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author |
|
|
17025
17432
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
17026
17433
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
17027
17434
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
17028
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets |
|
|
17435
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails" target="_blank" rel="noopener noreferrer">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets |
|
|
17029
17436
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
17030
17437
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
17031
17438
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -17074,7 +17481,7 @@ Additional information about a Feature Set
|
|
|
17074
17481
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional description for the feature set |
|
|
17075
17482
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional display name of the feature set |
|
|
17076
17483
|
|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) |
|
|
17077
|
-
|metrics|Array<<a href="#metricdto"
|
|
17484
|
+
|metrics|Array<<a href="#metricdto">MetricDto</a>>|Feature set metrics |
|
|
17078
17485
|
|
|
17079
17486
|
### Filter
|
|
17080
17487
|
|
|
@@ -17082,11 +17489,11 @@ A dimensional or series filter on a metric.
|
|
|
17082
17489
|
|
|
17083
17490
|
| Name | Type | Description |
|
|
17084
17491
|
| --- | --- | --- |
|
|
17085
|
-
|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. |
|
|
17086
|
-
|referenceInvocation|<a href="#invocation"
|
|
17492
|
+
|operands|Array<<a href="#filter" target="_blank" rel="noopener noreferrer">Filter</a>>|If the type is <code>not</code>, <code>and</code> or <code>or</code>, then holds the contained filters. |
|
|
17493
|
+
|referenceInvocation|<a href="#invocation">Invocation</a>|Invocation of a function, e.g. the <code>entitySelector</code> function. |
|
|
17087
17494
|
|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. |
|
|
17088
17495
|
|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. |
|
|
17089
|
-
|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. |
|
|
17496
|
+
|rollup|<a href="#rollup" target="_blank" rel="noopener noreferrer">Rollup</a>|A way of viewing a series as a single value for the purpose of sorting or series-based filters. |
|
|
17090
17497
|
|targetDimension|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If the type applies to a dimension, then holds the target dimension. |
|
|
17091
17498
|
|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. |
|
|
17092
17499
|
|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> |
|
|
@@ -17118,7 +17525,7 @@ Filtered requests of a Browser Monitor.
|
|
|
17118
17525
|
| Name | Type | Description |
|
|
17119
17526
|
| --- | --- | --- |
|
|
17120
17527
|
|mode<sup>*required</sup>|"BLOCK" | "ALLOW"|Filter mode for filtered requests. |
|
|
17121
|
-
|requests<sup>*required</sup>|Array<<a href="#requestfilterdto"
|
|
17528
|
+
|requests<sup>*required</sup>|Array<<a href="#requestfilterdto">RequestFilterDto</a>>|Requests to be filtered. |
|
|
17122
17529
|
|
|
17123
17530
|
### FrameworkOptionsDto
|
|
17124
17531
|
|
|
@@ -17154,7 +17561,7 @@ Information about a function definition.
|
|
|
17154
17561
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A human readable string representation of the function definition. |
|
|
17155
17562
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the function definition. |
|
|
17156
17563
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the function definition. |
|
|
17157
|
-
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
17564
|
+
|parameterTypes|<a href="#truncatableliststring" target="_blank" rel="noopener noreferrer">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
17158
17565
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function. |
|
|
17159
17566
|
|
|
17160
17567
|
### GlobalCountsDto
|
|
@@ -17258,8 +17665,8 @@ HTTP specific request details.
|
|
|
17258
17665
|
|
|
17259
17666
|
| Name | Type | Description |
|
|
17260
17667
|
| --- | --- | --- |
|
|
17261
|
-
|headers|<a href="#truncatablelistattackrequestheader"
|
|
17262
|
-
|parameters|<a href="#truncatablelisthttprequestparameter">TruncatableListHttpRequestParameter</a>|A list of values that has possibly been truncated. |
|
|
17668
|
+
|headers|<a href="#truncatablelistattackrequestheader">TruncatableListAttackRequestHeader</a>|A list of values that has possibly been truncated. |
|
|
17669
|
+
|parameters|<a href="#truncatablelisthttprequestparameter" target="_blank" rel="noopener noreferrer">TruncatableListHttpRequestParameter</a>|A list of values that has possibly been truncated. |
|
|
17263
17670
|
|requestMethod|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The HTTP request method. |
|
|
17264
17671
|
|
|
17265
17672
|
### HttpRequestParameter
|
|
@@ -17299,7 +17706,7 @@ The impact analysis of the problem on other entities/users.
|
|
|
17299
17706
|
| --- | --- | --- |
|
|
17300
17707
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
17301
17708
|
|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> |
|
|
17302
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
17709
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17303
17710
|
|
|
17304
17711
|
### ImpactAnalysis
|
|
17305
17712
|
|
|
@@ -17307,7 +17714,7 @@ A list of all impacts of the problem.
|
|
|
17307
17714
|
|
|
17308
17715
|
| Name | Type | Description |
|
|
17309
17716
|
| --- | --- | --- |
|
|
17310
|
-
|impacts<sup>*required</sup>|Array<<a href="#impact">Impact</a>>|A list of all impacts of the problem. |
|
|
17717
|
+
|impacts<sup>*required</sup>|Array<<a href="#impact" target="_blank" rel="noopener noreferrer">Impact</a>>|A list of all impacts of the problem. |
|
|
17311
17718
|
|
|
17312
17719
|
### InsertPosition
|
|
17313
17720
|
|
|
@@ -17326,10 +17733,10 @@ Interaction step of Browser Monitor.
|
|
|
17326
17733
|
|button<sup>*required</sup>|"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"|Integer containing the button index. |
|
|
17327
17734
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
17328
17735
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
17329
|
-
|target|<a href="#targetdto"
|
|
17736
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
17330
17737
|
|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> |
|
|
17331
|
-
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
17332
|
-
|waitCondition|<a href="#basewaitconditiondto"
|
|
17738
|
+
|validationRules|Array<<a href="#validationruledto" target="_blank" rel="noopener noreferrer">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
17739
|
+
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17333
17740
|
|
|
17334
17741
|
### InvalidLine
|
|
17335
17742
|
|
|
@@ -17353,16 +17760,16 @@ An item of a collection property.
|
|
|
17353
17760
|
|
|
17354
17761
|
| Name | Type | Description |
|
|
17355
17762
|
| --- | --- | --- |
|
|
17356
|
-
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
17357
|
-
|datasource|<a href="#datasourcedefinition"
|
|
17763
|
+
|constraints|Array<<a href="#constraint" target="_blank" rel="noopener noreferrer">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
17764
|
+
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
17358
17765
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the item. |
|
|
17359
17766
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the item. |
|
|
17360
17767
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
17361
|
-
|metadata|<a href="#itemmetadata">ItemMetadata</a>|Metadata of the items. |
|
|
17768
|
+
|metadata|<a href="#itemmetadata" target="_blank" rel="noopener noreferrer">ItemMetadata</a>|Metadata of the items. |
|
|
17362
17769
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the item's value. |
|
|
17363
17770
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the item's value. |
|
|
17364
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer"
|
|
17365
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
17771
|
+
|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. |
|
|
17772
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
17366
17773
|
|
|
17367
17774
|
### ItemMetadata
|
|
17368
17775
|
|
|
@@ -17377,13 +17784,13 @@ Metadata of the items.
|
|
|
17377
17784
|
|agentVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17378
17785
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17379
17786
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17380
|
-
|properties|<a href="#javaprocesscontainerproperties"
|
|
17787
|
+
|properties|<a href="#javaprocesscontainerproperties">JavaProcessContainerProperties</a>|
|
|
17381
17788
|
|
|
17382
17789
|
### JavaProcessContainerList
|
|
17383
17790
|
|
|
17384
17791
|
| Name | Type |
|
|
17385
17792
|
| --- | --- |
|
|
17386
|
-
|items<sup>*required</sup>|Array<<a href="#javaprocesscontainer">JavaProcessContainer</a>>|
|
|
17793
|
+
|items<sup>*required</sup>|Array<<a href="#javaprocesscontainer" target="_blank" rel="noopener noreferrer">JavaProcessContainer</a>>|
|
|
17387
17794
|
|
|
17388
17795
|
### JavaProcessContainerProperties
|
|
17389
17796
|
|
|
@@ -17399,10 +17806,10 @@ JavaScript Agent Settings.
|
|
|
17399
17806
|
|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. |
|
|
17400
17807
|
|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. |
|
|
17401
17808
|
|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. |
|
|
17402
|
-
|javaScriptFrameworkSupport|<a href="#frameworkoptionsdto"
|
|
17809
|
+
|javaScriptFrameworkSupport|<a href="#frameworkoptionsdto">FrameworkOptionsDto</a>|JS framework options of a JS Agent. |
|
|
17403
17810
|
|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. |
|
|
17404
|
-
|timeoutSettings|<a href="#timeoutsettingsdto">TimeoutSettingsDto</a>|Timeout settings of a Browser Monitor. |
|
|
17405
|
-
|visuallyCompleteOptions|<a href="#visuallycompleteoptionsdto"
|
|
17811
|
+
|timeoutSettings|<a href="#timeoutsettingsdto" target="_blank" rel="noopener noreferrer">TimeoutSettingsDto</a>|Timeout settings of a Browser Monitor. |
|
|
17812
|
+
|visuallyCompleteOptions|<a href="#visuallycompleteoptionsdto">VisuallyCompleteOptionsDto</a>|Visually Complete Options of a Browser Monitor. |
|
|
17406
17813
|
|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. |
|
|
17407
17814
|
|
|
17408
17815
|
### JavaScriptMappingFileDto
|
|
@@ -17422,7 +17829,7 @@ JavaScript Agent Settings.
|
|
|
17422
17829
|
|
|
17423
17830
|
| Name | Type | Description |
|
|
17424
17831
|
| --- | --- | --- |
|
|
17425
|
-
|jsMappingFiles|Array<<a href="#javascriptmappingfiledto">JavaScriptMappingFileDto</a>>|A list of JavaScript mapping files. |
|
|
17832
|
+
|jsMappingFiles|Array<<a href="#javascriptmappingfiledto" target="_blank" rel="noopener noreferrer">JavaScriptMappingFileDto</a>>|A list of JavaScript mapping files. |
|
|
17426
17833
|
|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> |
|
|
17427
17834
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
17428
17835
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -17442,9 +17849,9 @@ JavaScript step of Browser Monitor.
|
|
|
17442
17849
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
17443
17850
|
|javaScript<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing a script in JavaScript. |
|
|
17444
17851
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
17445
|
-
|target|<a href="#targetdto"
|
|
17852
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
17446
17853
|
|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> |
|
|
17447
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17854
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17448
17855
|
|
|
17449
17856
|
### KeyPerformanceMetrics
|
|
17450
17857
|
|
|
@@ -17462,14 +17869,14 @@ Key strokes step of Browser Monitor.
|
|
|
17462
17869
|
| Name | Type | Description |
|
|
17463
17870
|
| --- | --- | --- |
|
|
17464
17871
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
17465
|
-
|input<sup>*required</sup>|<a href="#keystrokesinputdto"
|
|
17872
|
+
|input<sup>*required</sup>|<a href="#keystrokesinputdto">KeystrokesInputDto</a>|Key strokes step input. |
|
|
17466
17873
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
17467
17874
|
|simulateBlurEvent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if blur event should be simulated. |
|
|
17468
17875
|
|simulateReturnKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if return key should be simulated. |
|
|
17469
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
17876
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
17470
17877
|
|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> |
|
|
17471
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
17472
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17878
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
17879
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17473
17880
|
|
|
17474
17881
|
### KeystrokesInputDto
|
|
17475
17882
|
|
|
@@ -17520,7 +17927,7 @@ Results of the execution HTTP monitor's requests at a given location
|
|
|
17520
17927
|
| --- | --- | --- |
|
|
17521
17928
|
|executionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Execution id. |
|
|
17522
17929
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location id. |
|
|
17523
|
-
|requestResults|Array<<a href="#monitorrequestexecutionresult"
|
|
17930
|
+
|requestResults|Array<<a href="#monitorrequestexecutionresult">MonitorRequestExecutionResult</a>>|The list of the monitor's request results executed on this location. |
|
|
17524
17931
|
|
|
17525
17932
|
### LocatorDto
|
|
17526
17933
|
|
|
@@ -17537,7 +17944,7 @@ A single log record.
|
|
|
17537
17944
|
|
|
17538
17945
|
| Name | Type | Description |
|
|
17539
17946
|
| --- | --- | --- |
|
|
17540
|
-
|additionalColumns|<a href="#logrecordadditionalcolumns">LogRecordAdditionalColumns</a>|Additional columns of the log record. |
|
|
17947
|
+
|additionalColumns|<a href="#logrecordadditionalcolumns" target="_blank" rel="noopener noreferrer">LogRecordAdditionalColumns</a>|Additional columns of the log record. |
|
|
17541
17948
|
|content|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The content of the log record. |
|
|
17542
17949
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Type of event |
|
|
17543
17950
|
|status|"ERROR" | "INFO" | "NONE" | "NOT_APPLICABLE" | "WARN"|The log status (based on the log level). |
|
|
@@ -17556,7 +17963,7 @@ A list of retrieved log records.
|
|
|
17556
17963
|
| Name | Type | Description |
|
|
17557
17964
|
| --- | --- | --- |
|
|
17558
17965
|
|nextSliceKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next slice of log records. Always null on <em>Log Management and Analytics, powered by Grail</em>. |
|
|
17559
|
-
|results|Array<<a href="#logrecord"
|
|
17966
|
+
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records. |
|
|
17560
17967
|
|sliceSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of records in a slice. |
|
|
17561
17968
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
17562
17969
|
|
|
@@ -17581,9 +17988,9 @@ The maintenance window during which the problem occurred.
|
|
|
17581
17988
|
| --- | --- | --- |
|
|
17582
17989
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
17583
17990
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds. |
|
|
17584
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17991
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
17585
17992
|
|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> |
|
|
17586
|
-
|groupingEntity|<a href="#entitystub"
|
|
17993
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17587
17994
|
|maintenanceWindowConfigId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the related maintenance window. |
|
|
17588
17995
|
|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. |
|
|
17589
17996
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
@@ -17613,7 +18020,7 @@ A list of metrics and their data points.
|
|
|
17613
18020
|
| --- | --- | --- |
|
|
17614
18021
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Deprecated. This field is returned for compatibility reasons. It always has the value of <code>null</code>. |
|
|
17615
18022
|
|resolution<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The timeslot resolution in the result. |
|
|
17616
|
-
|result<sup>*required</sup>|Array<<a href="#metricseriescollection">MetricSeriesCollection</a>>|A list of metrics and their data points. |
|
|
18023
|
+
|result<sup>*required</sup>|Array<<a href="#metricseriescollection" target="_blank" rel="noopener noreferrer">MetricSeriesCollection</a>>|A list of metrics and their data points. |
|
|
17617
18024
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The total number of primary entities in the result.</p> <p>Has the <code>0</code> value if none of the requested metrics is suitable for pagination.</p> |
|
|
17618
18025
|
|warnings<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of warnings |
|
|
17619
18026
|
|
|
@@ -17636,10 +18043,10 @@ The descriptor of a metric.
|
|
|
17636
18043
|
|billable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code>the usage of metric is billable.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
17637
18044
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp of metric creation.</p> <p>Built-in metrics and metric expressions have the value of <code>null</code>.</p> |
|
|
17638
18045
|
|dduBillable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the usage of metric consumes <a href="https://dt-url.net/ddu" target="_blank" rel="noopener noreferrer" >Davis data units</a>. Deprecated and always <code>false</code> for Dynatrace Platform Subscription. Superseded by <code>isBillable</code>.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
17639
|
-
|defaultAggregation|<a href="#metricdefaultaggregation"
|
|
18046
|
+
|defaultAggregation|<a href="#metricdefaultaggregation">MetricDefaultAggregation</a>|The default aggregation of a metric. |
|
|
17640
18047
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the metric. |
|
|
17641
|
-
|dimensionCardinalities|Array<<a href="#metricdimensioncardinality">MetricDimensionCardinality</a>>|The cardinalities of MINT metric dimensions. |
|
|
17642
|
-
|dimensionDefinitions|Array<<a href="#metricdimensiondefinition"
|
|
18048
|
+
|dimensionCardinalities|Array<<a href="#metricdimensioncardinality" target="_blank" rel="noopener noreferrer">MetricDimensionCardinality</a>>|The cardinalities of MINT metric dimensions. |
|
|
18049
|
+
|dimensionDefinitions|Array<<a href="#metricdimensiondefinition">MetricDimensionDefinition</a>>|<p>The fine metric division (for example, process group and process ID for some process-related metric).</p> <p>For <a href="https://dt-url.net/5d63ic1" target="_blank" rel="noopener noreferrer" >ingested metrics</a>, dimensions that doesn't have have any data within the last 15 days are omitted.</p> |
|
|
17643
18050
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the metric in the user interface. |
|
|
17644
18051
|
|entityType|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of admissible primary entity types for this metric. Can be used for the <code>type</code> predicate in the <code>entitySelector</code>. |
|
|
17645
18052
|
|impactRelevant|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The metric is (<code>true</code>) or is not (<code>false</code>) impact relevant.</p> <p>An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
@@ -17648,7 +18055,7 @@ The descriptor of a metric.
|
|
|
17648
18055
|
|maximumValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum allowed value of the metric.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
17649
18056
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The fully qualified key of the metric.</p> <p>If a transformation has been used it is reflected in the metric key.</p> |
|
|
17650
18057
|
|metricSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The metric selector that is used when querying a func: metric. |
|
|
17651
|
-
|metricValueType|<a href="#metricvaluetype">MetricValueType</a>|The value type for the metric. |
|
|
18058
|
+
|metricValueType|<a href="#metricvaluetype" target="_blank" rel="noopener noreferrer">MetricValueType</a>|The value type for the metric. |
|
|
17652
18059
|
|minimumValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The minimum allowed value of the metric.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
17653
18060
|
|resolutionInfSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If 'true', resolution=Inf can be applied to the metric query. |
|
|
17654
18061
|
|rootCauseRelevant|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The metric is (<code>true</code>) or is not (<code>false</code>) root cause relevant.</p> <p>A root-cause relevant metric represents a strong indicator for a faulty component.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
@@ -17665,7 +18072,7 @@ A list of metrics along with their descriptors.
|
|
|
17665
18072
|
|
|
17666
18073
|
| Name | Type | Description |
|
|
17667
18074
|
| --- | --- | --- |
|
|
17668
|
-
|metrics<sup>*required</sup>|Array<<a href="#metricdescriptor"
|
|
18075
|
+
|metrics<sup>*required</sup>|Array<<a href="#metricdescriptor">MetricDescriptor</a>>|A list of metric along with their descriptors |
|
|
17669
18076
|
|nextPageKey|null | [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> |
|
|
17670
18077
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of metrics in the result. |
|
|
17671
18078
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of potential warnings about the query. For example deprecated feature usage etc. |
|
|
@@ -17699,7 +18106,7 @@ Metric gathered by an extension
|
|
|
17699
18106
|
| Name | Type | Description |
|
|
17700
18107
|
| --- | --- | --- |
|
|
17701
18108
|
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Metric key |
|
|
17702
|
-
|metadata|<a href="#metricmetadatadto">MetricMetadataDto</a>|Metric metadata |
|
|
18109
|
+
|metadata|<a href="#metricmetadatadto" target="_blank" rel="noopener noreferrer">MetricMetadataDto</a>|Metric metadata |
|
|
17703
18110
|
|
|
17704
18111
|
### MetricEvidence
|
|
17705
18112
|
|
|
@@ -17711,9 +18118,9 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
17711
18118
|
| --- | --- | --- |
|
|
17712
18119
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
17713
18120
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end time of the evidence, in UTC milliseconds.</p> <p>The value <code>null</code> indicates that the evidence is still open.</p> |
|
|
17714
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
18121
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17715
18122
|
|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> |
|
|
17716
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
18123
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
17717
18124
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the metric. |
|
|
17718
18125
|
|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. |
|
|
17719
18126
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
@@ -17726,7 +18133,7 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
17726
18133
|
| Name | Type |
|
|
17727
18134
|
| --- | --- |
|
|
17728
18135
|
|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
17729
|
-
|invalidLines|Array<<a href="#invalidline"
|
|
18136
|
+
|invalidLines|Array<<a href="#invalidline">InvalidLine</a>>|
|
|
17730
18137
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17731
18138
|
|
|
17732
18139
|
### MetricMetadataDto
|
|
@@ -17757,7 +18164,7 @@ The data is represented by two arrays of the same length: **timestamps** and **v
|
|
|
17757
18164
|
|
|
17758
18165
|
| Name | Type | Description |
|
|
17759
18166
|
| --- | --- | --- |
|
|
17760
|
-
|dimensionMap<sup>*required</sup>|<a href="#metricseriesdimensionmap">MetricSeriesDimensionMap</a>| |
|
|
18167
|
+
|dimensionMap<sup>*required</sup>|<a href="#metricseriesdimensionmap" target="_blank" rel="noopener noreferrer">MetricSeriesDimensionMap</a>| |
|
|
17761
18168
|
|dimensions<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>Deprecated, refer to <code>dimensionMap</code> instead.</p> <p>The ordered list of dimensions to which the data point list belongs.</p> <p>Each metric can have a certain number of dimensions. Dimensions exceeding this number are aggregated into one, which is shown as <code>null</code> here.</p> |
|
|
17762
18169
|
|timestamps<sup>*required</sup>|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>A list of timestamps of data points.</p> <p>The value of data point for each time from this array is located in <strong>values</strong> array at the same index.</p> |
|
|
17763
18170
|
|values<sup>*required</sup>|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>A list of values of data points.</p> <p>The timestamp of data point for each value from this array is located in <strong>timestamps</strong> array at the same index.</p> |
|
|
@@ -17768,11 +18175,11 @@ Data points of a metric.
|
|
|
17768
18175
|
|
|
17769
18176
|
| Name | Type | Description |
|
|
17770
18177
|
| --- | --- | --- |
|
|
17771
|
-
|appliedOptionalFilters|Array<<a href="#appliedfilter"
|
|
17772
|
-
|data<sup>*required</sup>|Array<<a href="#metricseries">MetricSeries</a>>|Data points of the metric. |
|
|
18178
|
+
|appliedOptionalFilters|Array<<a href="#appliedfilter">AppliedFilter</a>>|A list of filtered metric keys along with filters that have been applied to these keys, from the <code>optionalFilter</code> parameter. |
|
|
18179
|
+
|data<sup>*required</sup>|Array<<a href="#metricseries" target="_blank" rel="noopener noreferrer">MetricSeries</a>>|Data points of the metric. |
|
|
17773
18180
|
|dataPointCountRatio<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query. |
|
|
17774
18181
|
|dimensionCountRatio<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query. |
|
|
17775
|
-
|dql|<a href="#metricquerydqltranslation"
|
|
18182
|
+
|dql|<a href="#metricquerydqltranslation">MetricQueryDQLTranslation</a>|Metric query translation to DQL. |
|
|
17776
18183
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The key of the metric.</p> <p>If any transformation is applied, it is included here.</p> |
|
|
17777
18184
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of potential warnings that affect this ID. For example deprecated feature usage etc. |
|
|
17778
18185
|
|
|
@@ -17805,7 +18212,7 @@ Analysis of problem impact to a mobile application.
|
|
|
17805
18212
|
| --- | --- | --- |
|
|
17806
18213
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
17807
18214
|
|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> |
|
|
17808
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
18215
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
17809
18216
|
|
|
17810
18217
|
### Modification
|
|
17811
18218
|
|
|
@@ -17847,7 +18254,7 @@ Results of the execution of all HTTP monitor's requests.
|
|
|
17847
18254
|
|
|
17848
18255
|
| Name | Type | Description |
|
|
17849
18256
|
| --- | --- | --- |
|
|
17850
|
-
|locationsExecutionResults|Array<<a href="#locationexecutionresults"
|
|
18257
|
+
|locationsExecutionResults|Array<<a href="#locationexecutionresults">LocationExecutionResults</a>>|The list with the results of the requests executed on assigned locations. |
|
|
17851
18258
|
|monitorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor id. |
|
|
17852
18259
|
|
|
17853
18260
|
### MonitorPropertyDto
|
|
@@ -17866,7 +18273,7 @@ A result of the execution HTTP monitor's request.
|
|
|
17866
18273
|
| Name | Type | Description |
|
|
17867
18274
|
| --- | --- | --- |
|
|
17868
18275
|
|cloudPlatform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cloud platform of the location. |
|
|
17869
|
-
|customLogs|Array<<a href="#customlogline">CustomLogLine</a>>|Custom log messages. |
|
|
18276
|
+
|customLogs|Array<<a href="#customlogline" target="_blank" rel="noopener noreferrer">CustomLogLine</a>>|Custom log messages. |
|
|
17870
18277
|
|engineId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|VUC's id on which monitor's request was executed. |
|
|
17871
18278
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's failure message. |
|
|
17872
18279
|
|healthStatus|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's health status. |
|
|
@@ -17880,13 +18287,13 @@ A result of the execution HTTP monitor's request.
|
|
|
17880
18287
|
|redirectionTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total number of milliseconds spent on handling all redirect requests, measured in ms. |
|
|
17881
18288
|
|redirectsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request's redirects. |
|
|
17882
18289
|
|requestBody|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's request body. |
|
|
17883
|
-
|requestHeaders|Array<<a href="#monitorrequestheader"
|
|
18290
|
+
|requestHeaders|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|A list of request's headers |
|
|
17884
18291
|
|requestId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request id. |
|
|
17885
18292
|
|requestName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request name. |
|
|
17886
18293
|
|resolvedIps|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Request's resolved ips.' |
|
|
17887
18294
|
|responseBody|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's response body. |
|
|
17888
18295
|
|responseBodySizeLimitExceeded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|A flag indicating that the response payload size limit of 10MB has been exceeded. |
|
|
17889
|
-
|responseHeaders|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|A list of request's response headers |
|
|
18296
|
+
|responseHeaders|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|A list of request's response headers |
|
|
17890
18297
|
|responseMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's response message.' |
|
|
17891
18298
|
|responseSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request's response size in bytes. |
|
|
17892
18299
|
|responseStatusCode|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request's response status code. |
|
|
@@ -17924,7 +18331,7 @@ Monitoring state of the process group instance.
|
|
|
17924
18331
|
| Name | Type | Description |
|
|
17925
18332
|
| --- | --- | --- |
|
|
17926
18333
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the process group instance. |
|
|
17927
|
-
|params|Array<<a href="#monitoredentitystateparam"
|
|
18334
|
+
|params|Array<<a href="#monitoredentitystateparam">MonitoredEntityStateParam</a>>|Additional parameters of the monitoring state. |
|
|
17928
18335
|
|severity|"deep_monitoring_ok" | "info" | "ok" | "warning"|The type of the monitoring state. |
|
|
17929
18336
|
|state|"ok" | "agent_injection_status_go_dynamizer_failed" | "agent_injection_status_go_fips_detected_but_feature_disabled" | "agent_injection_status_go_pclntab_failed" | "agent_injection_status_go_vertigo_support_added" | "agent_injection_status_nginx_patched_binary_detected" | "agent_injection_status_php_opcache_disabled" | "agent_injection_status_php_stack_size_too_low" | "agent_injection_suppression" | "aix_enable_full_monitoring_needed" | "bad_installer" | "boshbpm_disabled" | "container_injection_failed" | "containerd_disabled" | "crio_disabled" | "custom_pg_rule_required" | "deep_monitoring_successful" | "deep_monitoring_unsuccessful" | "docker_disabled" | "garden_disabled" | "host_infra_structure_only" | "host_monitoring_disabled" | "network_agent_inactive" | "parent_process_restart_required" | "podman_disabled" | "process_group_different_id_due_to_declarative_grouping" | "process_group_disabled" | "process_group_disabled_via_container_injection_rule" | "process_group_disabled_via_container_injection_rule_restart" | "process_group_disabled_via_global_settings" | "process_group_disabled_via_injection_rule" | "process_group_disabled_via_injection_rule_restart" | "process_group_pgr_group_update_suppressed" | "restart_required" | "restart_required_apache" | "restart_required_docker_deamon" | "restart_required_host_group_inconsistent" | "restart_required_host_id_inconsistent" | "restart_required_outdated_agent_apache_update" | "restart_required_outdated_agent_injected" | "restart_required_using_different_data_storage_dir" | "restart_required_using_different_log_path" | "restart_required_virtualized_container" | "unsupported_state" | "winc_disabled"|The name of the monitoring state. |
|
|
17930
18337
|
|
|
@@ -17934,7 +18341,7 @@ A list of process group instances and their monitoring states.
|
|
|
17934
18341
|
|
|
17935
18342
|
| Name | Type | Description |
|
|
17936
18343
|
| --- | --- | --- |
|
|
17937
|
-
|monitoringStates|Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>>|A list of process group instances and their monitoring states. |
|
|
18344
|
+
|monitoringStates|Array<<a href="#monitoredentitystates" target="_blank" rel="noopener noreferrer">MonitoredEntityStates</a>>|A list of process group instances and their monitoring states. |
|
|
17938
18345
|
|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> |
|
|
17939
18346
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
17940
18347
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of unique process group instances in the response. |
|
|
@@ -17975,14 +18382,14 @@ Step of Browser Monitor that navigates to a website.
|
|
|
17975
18382
|
|
|
17976
18383
|
| Name | Type | Description |
|
|
17977
18384
|
| --- | --- | --- |
|
|
17978
|
-
|authentication|<a href="#authenticationdto"
|
|
18385
|
+
|authentication|<a href="#authenticationdto">AuthenticationDto</a>|Authentication dto for Browser Monitor step. |
|
|
17979
18386
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
17980
18387
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
17981
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
18388
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
17982
18389
|
|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> |
|
|
17983
18390
|
|url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Field containing the url that the monitor should navigate to. |
|
|
17984
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
17985
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
18391
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
18392
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
17986
18393
|
|
|
17987
18394
|
### NetworkThrottlingDto
|
|
17988
18395
|
|
|
@@ -18029,7 +18436,7 @@ A list of network zones.
|
|
|
18029
18436
|
|
|
18030
18437
|
| Name | Type | Description |
|
|
18031
18438
|
| --- | --- | --- |
|
|
18032
|
-
|networkZones<sup>*required</sup>|Array<<a href="#networkzone"
|
|
18439
|
+
|networkZones<sup>*required</sup>|Array<<a href="#networkzone">NetworkZone</a>>|A list of network zones. |
|
|
18033
18440
|
|
|
18034
18441
|
### NetworkZoneSettings
|
|
18035
18442
|
|
|
@@ -18089,7 +18496,7 @@ A list of synthetic nodes
|
|
|
18089
18496
|
|
|
18090
18497
|
| Name | Type | Description |
|
|
18091
18498
|
| --- | --- | --- |
|
|
18092
|
-
|nodes<sup>*required</sup>|Array<<a href="#nodecollectionelement">NodeCollectionElement</a>>|A list of synthetic nodes |
|
|
18499
|
+
|nodes<sup>*required</sup>|Array<<a href="#nodecollectionelement" target="_blank" rel="noopener noreferrer">NodeCollectionElement</a>>|A list of synthetic nodes |
|
|
18093
18500
|
|
|
18094
18501
|
### ObjectsList
|
|
18095
18502
|
|
|
@@ -18097,7 +18504,7 @@ A list of settings objects.
|
|
|
18097
18504
|
|
|
18098
18505
|
| Name | Type | Description |
|
|
18099
18506
|
| --- | --- | --- |
|
|
18100
|
-
|items<sup>*required</sup>|Array<<a href="#settingsobject"
|
|
18507
|
+
|items<sup>*required</sup>|Array<<a href="#settingsobject">SettingsObject</a>>|A list of settings objects. |
|
|
18101
18508
|
|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> |
|
|
18102
18509
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
18103
18510
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -18143,8 +18550,8 @@ A precondition for visibility of a property.
|
|
|
18143
18550
|
|expectedValue|AnyValue|<p>The expected value of the property.</p> <p>Only applicable to properties of the <code>EQUALS</code> type.</p> |
|
|
18144
18551
|
|expectedValues|Array<AnyValue>|<p>A list of valid values of the property.</p> <p>Only applicable to properties of the <code>IN</code> type.</p> |
|
|
18145
18552
|
|pattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The Regular expression which is matched against the property.</p> <p>Only applicable to properties of the <code>REGEX_MATCH</code> type.</p> |
|
|
18146
|
-
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property. |
|
|
18147
|
-
|preconditions|Array<<a href="#precondition"
|
|
18553
|
+
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property. |
|
|
18554
|
+
|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> |
|
|
18148
18555
|
|property|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The property to be evaluated. |
|
|
18149
18556
|
|type<sup>*required</sup>|"EQUALS" | "AND" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"|The type of the precondition. |
|
|
18150
18557
|
|
|
@@ -18173,7 +18580,7 @@ Configuration of a private synthetic location.
|
|
|
18173
18580
|
|longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
18174
18581
|
|namExecutionSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Containerized location property. Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
|
|
18175
18582
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
18176
|
-
|nodeNames|<a href="#privatesyntheticlocationnodenames">PrivateSyntheticLocationNodeNames</a>|A mapping id to name of the nodes belonging to the location. |
|
|
18583
|
+
|nodeNames|<a href="#privatesyntheticlocationnodenames" target="_blank" rel="noopener noreferrer">PrivateSyntheticLocationNodeNames</a>|A mapping id to name of the nodes belonging to the location. |
|
|
18177
18584
|
|nodes<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl" target="_blank" rel="noopener noreferrer" >GET all nodes</a> call.</p> |
|
|
18178
18585
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
18179
18586
|
|regionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The region name of the location. |
|
|
@@ -18193,23 +18600,23 @@ The properties of a problem.
|
|
|
18193
18600
|
|
|
18194
18601
|
| Name | Type | Description |
|
|
18195
18602
|
| --- | --- | --- |
|
|
18196
|
-
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub"
|
|
18603
|
+
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are affected by the problem. |
|
|
18197
18604
|
|displayId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the problem. |
|
|
18198
18605
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end timestamp of the problem, in UTC milliseconds.</p> <p>Has <code>-1</code> value, if the problem is still open.</p> |
|
|
18199
|
-
|entityTags|Array<<a href="#metag">METag</a>>|A list of all entity tags of the problem. |
|
|
18200
|
-
|evidenceDetails|<a href="#evidencedetails"
|
|
18201
|
-
|impactAnalysis|<a href="#impactanalysis">ImpactAnalysis</a>|A list of all impacts of the problem. |
|
|
18606
|
+
|entityTags|Array<<a href="#metag" target="_blank" rel="noopener noreferrer">METag</a>>|A list of all entity tags of the problem. |
|
|
18607
|
+
|evidenceDetails|<a href="#evidencedetails">EvidenceDetails</a>|The evidence details of a problem. |
|
|
18608
|
+
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>|A list of all impacts of the problem. |
|
|
18202
18609
|
|impactLevel<sup>*required</sup>|"ENVIRONMENT" | "APPLICATION" | "INFRASTRUCTURE" | "SERVICES"|The impact level of the problem. It shows what is affected by the problem. |
|
|
18203
|
-
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub"
|
|
18610
|
+
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are impacted by the problem. |
|
|
18204
18611
|
|k8s.cluster.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster names. |
|
|
18205
18612
|
|k8s.cluster.uid|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster UIDs. |
|
|
18206
18613
|
|k8s.namespace.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes namespace names. |
|
|
18207
|
-
|linkedProblemInfo|<a href="#linkedproblem">LinkedProblem</a>|The properties of the linked problem. |
|
|
18208
|
-
|managementZones<sup>*required</sup>|Array<<a href="#managementzone"
|
|
18209
|
-
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub">AlertingProfileStub</a>>|A list of alerting profiles that match the problem. |
|
|
18614
|
+
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>|The properties of the linked problem. |
|
|
18615
|
+
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
18616
|
+
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub" target="_blank" rel="noopener noreferrer">AlertingProfileStub</a>>|A list of alerting profiles that match the problem. |
|
|
18210
18617
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
18211
|
-
|recentComments|<a href="#commentslist"
|
|
18212
|
-
|rootCauseEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
18618
|
+
|recentComments|<a href="#commentslist">CommentsList</a>|A list of comments. |
|
|
18619
|
+
|rootCauseEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
18213
18620
|
|severityLevel<sup>*required</sup>|"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"|The severity of the problem. |
|
|
18214
18621
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start timestamp of the problem, in UTC milliseconds. |
|
|
18215
18622
|
|status<sup>*required</sup>|"CLOSED" | "OPEN"|The status of the problem. |
|
|
@@ -18229,7 +18636,7 @@ The result of closing a problem.
|
|
|
18229
18636
|
| --- | --- | --- |
|
|
18230
18637
|
|closeTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the user triggered the closing. |
|
|
18231
18638
|
|closing<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True, if the problem is being closed. |
|
|
18232
|
-
|comment|<a href="#comment"
|
|
18639
|
+
|comment|<a href="#comment">Comment</a>|The comment to a problem. |
|
|
18233
18640
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
18234
18641
|
|
|
18235
18642
|
### Problems
|
|
@@ -18240,7 +18647,7 @@ A list of problems.
|
|
|
18240
18647
|
| --- | --- | --- |
|
|
18241
18648
|
|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> |
|
|
18242
18649
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
18243
|
-
|problems<sup>*required</sup>|Array<<a href="#problem">Problem</a>>|The result entries. |
|
|
18650
|
+
|problems<sup>*required</sup>|Array<<a href="#problem" target="_blank" rel="noopener noreferrer">Problem</a>>|The result entries. |
|
|
18244
18651
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
18245
18652
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of warnings |
|
|
18246
18653
|
|
|
@@ -18250,9 +18657,9 @@ The vulnerable functions of a process group including their usage.
|
|
|
18250
18657
|
|
|
18251
18658
|
| Name | Type | Description |
|
|
18252
18659
|
| --- | --- | --- |
|
|
18253
|
-
|functionsInUse|Array<<a href="#vulnerablefunction"
|
|
18254
|
-
|functionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions with unknown state. |
|
|
18255
|
-
|functionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
18660
|
+
|functionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions in use. |
|
|
18661
|
+
|functionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions with unknown state. |
|
|
18662
|
+
|functionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions not in use. |
|
|
18256
18663
|
|processGroup|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The process group identifier. |
|
|
18257
18664
|
|
|
18258
18665
|
### PropertyDefinition
|
|
@@ -18261,25 +18668,25 @@ Configuration of a property in a settings schema.
|
|
|
18261
18668
|
|
|
18262
18669
|
| Name | Type | Description |
|
|
18263
18670
|
| --- | --- | --- |
|
|
18264
|
-
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
18265
|
-
|datasource|<a href="#datasourcedefinition"
|
|
18671
|
+
|constraints|Array<<a href="#constraint" target="_blank" rel="noopener noreferrer">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
18672
|
+
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
18266
18673
|
|default|AnyValue|<p>The default value to be used when no value is provided.</p> <p>If a non-singleton has the value of <code>null</code>, it means an empty collection.</p> |
|
|
18267
18674
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
18268
18675
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
18269
18676
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
18270
18677
|
|forceSecretResubmission|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if value is allowed to be modified when secret properties are not |
|
|
18271
|
-
|items|<a href="#item">Item</a>|An item of a collection property. |
|
|
18678
|
+
|items|<a href="#item" target="_blank" rel="noopener noreferrer">Item</a>|An item of a collection property. |
|
|
18272
18679
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
|
|
18273
|
-
|metadata|<a href="#propertydefinitionmetadata"
|
|
18680
|
+
|metadata|<a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>|Metadata of the property. |
|
|
18274
18681
|
|migrationPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Pattern with references to properties to create a new value. |
|
|
18275
18682
|
|minObjects|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of <strong>objects</strong> in a collection property. |
|
|
18276
18683
|
|modificationPolicy|"DEFAULT" | "ALWAYS" | "NEVER"|Modification policy of the property. |
|
|
18277
18684
|
|nullable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
|
|
18278
|
-
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property. |
|
|
18685
|
+
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property. |
|
|
18279
18686
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the property value |
|
|
18280
18687
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the property's value. |
|
|
18281
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer"
|
|
18282
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
18688
|
+
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer">RefPointer</a>|The type of the property's value. |
|
|
18689
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
18283
18690
|
|
|
18284
18691
|
### PropertyDefinitionMetadata
|
|
18285
18692
|
|
|
@@ -18293,7 +18700,7 @@ Details that are specific to the used protocol.
|
|
|
18293
18700
|
|
|
18294
18701
|
| Name | Type | Description |
|
|
18295
18702
|
| --- | --- | --- |
|
|
18296
|
-
|http|<a href="#httpprotocoldetails"
|
|
18703
|
+
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|HTTP specific request details. |
|
|
18297
18704
|
|
|
18298
18705
|
### ProxyDto
|
|
18299
18706
|
|
|
@@ -18310,7 +18717,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
18310
18717
|
| Name | Type | Description |
|
|
18311
18718
|
| --- | --- | --- |
|
|
18312
18719
|
|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). |
|
|
18313
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
18720
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
18314
18721
|
|certificate<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The certificate in the string format. |
|
|
18315
18722
|
|certificateFormat<sup>*required</sup>|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format. |
|
|
18316
18723
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
@@ -18366,14 +18773,14 @@ A list of React Native mapping files.
|
|
|
18366
18773
|
|bundleName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the bundle. |
|
|
18367
18774
|
|bundleVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the bundle. |
|
|
18368
18775
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the mapping file. |
|
|
18369
|
-
|metadata|<a href="#reactnativemappingfilemetadatadto"
|
|
18776
|
+
|metadata|<a href="#reactnativemappingfilemetadatadto">ReactNativeMappingFileMetadataDto</a>| |
|
|
18370
18777
|
|platform|"ANDROID" | "IOS"|The platform (operating system) the mapping file belongs to. |
|
|
18371
18778
|
|
|
18372
18779
|
### ReactNativeMappingFileListDto
|
|
18373
18780
|
|
|
18374
18781
|
| Name | Type | Description |
|
|
18375
18782
|
| --- | --- | --- |
|
|
18376
|
-
|mappingFiles|Array<<a href="#reactnativemappingfiledto">ReactNativeMappingFileDto</a>>|A list of React Native mapping files. |
|
|
18783
|
+
|mappingFiles|Array<<a href="#reactnativemappingfiledto" target="_blank" rel="noopener noreferrer">ReactNativeMappingFileDto</a>>|A list of React Native mapping files. |
|
|
18377
18784
|
|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> |
|
|
18378
18785
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
18379
18786
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -18434,7 +18841,7 @@ A list of related container images.
|
|
|
18434
18841
|
|
|
18435
18842
|
| Name | Type | Description |
|
|
18436
18843
|
| --- | --- | --- |
|
|
18437
|
-
|containerImages|Array<<a href="#relatedcontainerimage"
|
|
18844
|
+
|containerImages|Array<<a href="#relatedcontainerimage">RelatedContainerImage</a>>|A list of related container images. |
|
|
18438
18845
|
|
|
18439
18846
|
### RelatedEntitiesList
|
|
18440
18847
|
|
|
@@ -18446,12 +18853,12 @@ Each related entity contains a list of corresponding affected entities (for exam
|
|
|
18446
18853
|
|
|
18447
18854
|
| Name | Type | Description |
|
|
18448
18855
|
| --- | --- | --- |
|
|
18449
|
-
|applications|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related applications. |
|
|
18856
|
+
|applications|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related applications. |
|
|
18450
18857
|
|databases|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of related databases. |
|
|
18451
|
-
|hosts|Array<<a href="#relatedentity"
|
|
18452
|
-
|kubernetesClusters|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes clusters. |
|
|
18453
|
-
|kubernetesWorkloads|Array<<a href="#relatedentity"
|
|
18454
|
-
|services|Array<<a href="#relatedservice">RelatedService</a>>|A list of related services. |
|
|
18858
|
+
|hosts|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related hosts. |
|
|
18859
|
+
|kubernetesClusters|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related Kubernetes clusters. |
|
|
18860
|
+
|kubernetesWorkloads|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes workloads. |
|
|
18861
|
+
|services|Array<<a href="#relatedservice" target="_blank" rel="noopener noreferrer">RelatedService</a>>|A list of related services. |
|
|
18455
18862
|
|
|
18456
18863
|
### RelatedEntity
|
|
18457
18864
|
|
|
@@ -18487,7 +18894,7 @@ The tuple <name, product, stage, version> is always unique.
|
|
|
18487
18894
|
| --- | --- | --- |
|
|
18488
18895
|
|affectedByProblems|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more problems |
|
|
18489
18896
|
|affectedBySecurityVulnerabilities|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more security vulnerabilities |
|
|
18490
|
-
|instances|Array<<a href="#releaseinstance"
|
|
18897
|
+
|instances|Array<<a href="#releaseinstance">ReleaseInstance</a>>|The instances entityIds included in this release |
|
|
18491
18898
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity name |
|
|
18492
18899
|
|problemCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of problems of the entity |
|
|
18493
18900
|
|product|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The product name |
|
|
@@ -18495,7 +18902,7 @@ The tuple <name, product, stage, version> is always unique.
|
|
|
18495
18902
|
|running|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The related PGI is still running/monitored |
|
|
18496
18903
|
|securityVulnerabilitiesCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of security vulnerabilities of the entity |
|
|
18497
18904
|
|securityVulnerabilitiesEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates that the security vulnerabilities feature is enabled |
|
|
18498
|
-
|softwareTechs|Array<<a href="#softwaretechs">SoftwareTechs</a>>|The software technologies of the release |
|
|
18905
|
+
|softwareTechs|Array<<a href="#softwaretechs" target="_blank" rel="noopener noreferrer">SoftwareTechs</a>>|The software technologies of the release |
|
|
18499
18906
|
|stage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The stage name |
|
|
18500
18907
|
|throughput|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The count of bytes per second of the entity |
|
|
18501
18908
|
|version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identified release version |
|
|
@@ -18520,7 +18927,7 @@ A list of releases.
|
|
|
18520
18927
|
| --- | --- | --- |
|
|
18521
18928
|
|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> |
|
|
18522
18929
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
18523
|
-
|releases|Array<<a href="#release"
|
|
18930
|
+
|releases|Array<<a href="#release">Release</a>>|A list of releases. |
|
|
18524
18931
|
|releasesWithProblems|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of releases with problems. |
|
|
18525
18932
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
18526
18933
|
|
|
@@ -18531,15 +18938,15 @@ Assessment of the remediation item.
|
|
|
18531
18938
|
| Name | Type | Description |
|
|
18532
18939
|
| --- | --- | --- |
|
|
18533
18940
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
18534
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
18941
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
18535
18942
|
|dataAssets|"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"|The reachability of related data assets by affected entities. |
|
|
18536
18943
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities. |
|
|
18537
18944
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets. |
|
|
18538
18945
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
18539
18946
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions |
|
|
18540
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction"
|
|
18541
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
18542
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
18947
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
18948
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
18949
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
18543
18950
|
|
|
18544
18951
|
### RemediationDetailsItem
|
|
18545
18952
|
|
|
@@ -18547,17 +18954,17 @@ Detailed information of a remediation item for a security problem.
|
|
|
18547
18954
|
|
|
18548
18955
|
| Name | Type | Description |
|
|
18549
18956
|
| --- | --- | --- |
|
|
18550
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
18957
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
18551
18958
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
18552
18959
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
18553
18960
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
18554
|
-
|muteState|<a href="#remediationitemmutestate"
|
|
18961
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
18555
18962
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
18556
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
18963
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
18557
18964
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
18558
|
-
|trackingLink|<a href="#trackinglink"
|
|
18965
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
18559
18966
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"| |
|
|
18560
|
-
|vulnerableComponents|Array<<a href="#remediationitemdetailsvulnerablecomponent">RemediationItemDetailsVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
18967
|
+
|vulnerableComponents|Array<<a href="#remediationitemdetailsvulnerablecomponent" target="_blank" rel="noopener noreferrer">RemediationItemDetailsVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
18561
18968
|
|
|
18562
18969
|
### RemediationItem
|
|
18563
18970
|
|
|
@@ -18565,17 +18972,17 @@ A possible remediation for a security problem.
|
|
|
18565
18972
|
|
|
18566
18973
|
| Name | Type | Description |
|
|
18567
18974
|
| --- | --- | --- |
|
|
18568
|
-
|assessment|<a href="#remediationassessment"
|
|
18975
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
18569
18976
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
18570
18977
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
18571
18978
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
18572
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
18979
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
18573
18980
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
18574
|
-
|remediationProgress|<a href="#remediationprogress"
|
|
18981
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
18575
18982
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
18576
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
18983
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
18577
18984
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"| |
|
|
18578
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent"
|
|
18985
|
+
|vulnerableComponents|Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
18579
18986
|
|
|
18580
18987
|
### RemediationItemDetailsVulnerableComponent
|
|
18581
18988
|
|
|
@@ -18597,7 +19004,7 @@ A list of remediation items.
|
|
|
18597
19004
|
|
|
18598
19005
|
| Name | Type | Description |
|
|
18599
19006
|
| --- | --- | --- |
|
|
18600
|
-
|remediationItems|Array<<a href="#remediationitem">RemediationItem</a>>|A list of remediation items. |
|
|
19007
|
+
|remediationItems|Array<<a href="#remediationitem" target="_blank" rel="noopener noreferrer">RemediationItem</a>>|A list of remediation items. |
|
|
18601
19008
|
|
|
18602
19009
|
### RemediationItemMuteState
|
|
18603
19010
|
|
|
@@ -18647,7 +19054,7 @@ Response of muting several remediation items.
|
|
|
18647
19054
|
|
|
18648
19055
|
| Name | Type | Description |
|
|
18649
19056
|
| --- | --- | --- |
|
|
18650
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary"
|
|
19057
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were muted and which already were muted previously. |
|
|
18651
19058
|
|
|
18652
19059
|
### RemediationItemsBulkUnmute
|
|
18653
19060
|
|
|
@@ -18665,7 +19072,7 @@ Response of un-muting several remediation items.
|
|
|
18665
19072
|
|
|
18666
19073
|
| Name | Type | Description |
|
|
18667
19074
|
| --- | --- | --- |
|
|
18668
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
19075
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary" target="_blank" rel="noopener noreferrer">RemediationItemMutingSummary</a>>|The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
18669
19076
|
|
|
18670
19077
|
### RemediationItemsBulkUpdateDeleteDto
|
|
18671
19078
|
|
|
@@ -18674,7 +19081,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
18674
19081
|
| Name | Type | Description |
|
|
18675
19082
|
| --- | --- | --- |
|
|
18676
19083
|
|deletes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>Tracking links to remove from the security problem.</p> <p>List of remediation item IDs of the security problem for which to remove the tracking links.</p> |
|
|
18677
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates"
|
|
19084
|
+
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a>|<p>Tracking links to set for the security problem.</p> <p>Map of remediation item ID to tracking link objects.</p> <p>Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.</p> |
|
|
18678
19085
|
|
|
18679
19086
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
18680
19087
|
|
|
@@ -18701,12 +19108,12 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
18701
19108
|
|
|
18702
19109
|
| Name | Type | Description |
|
|
18703
19110
|
| --- | --- | --- |
|
|
18704
|
-
|assessment|<a href="#remediationprogressentityassessment">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity. |
|
|
19111
|
+
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity. |
|
|
18705
19112
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the remediation progress entity has first been related to the vulnerability. |
|
|
18706
19113
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity. |
|
|
18707
19114
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity. |
|
|
18708
19115
|
|state|"AFFECTED" | "UNAFFECTED"|The current state of the remediation progress entity. |
|
|
18709
|
-
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent"
|
|
19116
|
+
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent">RemediationProgressVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
18710
19117
|
|
|
18711
19118
|
### RemediationProgressEntityAssessment
|
|
18712
19119
|
|
|
@@ -18716,9 +19123,9 @@ Assessment of the remediation progress entity.
|
|
|
18716
19123
|
| --- | --- | --- |
|
|
18717
19124
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
18718
19125
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions |
|
|
18719
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
18720
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
18721
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
19126
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
19127
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
19128
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
18722
19129
|
|
|
18723
19130
|
### RemediationProgressEntityList
|
|
18724
19131
|
|
|
@@ -18726,7 +19133,7 @@ A list of remediation progress entities.
|
|
|
18726
19133
|
|
|
18727
19134
|
| Name | Type | Description |
|
|
18728
19135
|
| --- | --- | --- |
|
|
18729
|
-
|remediationProgressEntities|Array<<a href="#remediationprogressentity"
|
|
19136
|
+
|remediationProgressEntities|Array<<a href="#remediationprogressentity">RemediationProgressEntity</a>>|A list of remediation progress entities. |
|
|
18730
19137
|
|
|
18731
19138
|
### RemediationProgressVulnerableComponent
|
|
18732
19139
|
|
|
@@ -18757,10 +19164,10 @@ Remote configuration management job.
|
|
|
18757
19164
|
| --- | --- | --- |
|
|
18758
19165
|
|endTime|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs. |
|
|
18759
19166
|
|entityType|"ACTIVE_GATE" | "ONE_AGENT"|Type of entities modified by remote configuration management. |
|
|
18760
|
-
|failedEntities|Array<<a href="#remoteidentityoperationfailedentitydto">RemoteIdentityOperationFailedEntityDto</a>>|A list of failed remote configuration management jobs. |
|
|
19167
|
+
|failedEntities|Array<<a href="#remoteidentityoperationfailedentitydto" target="_blank" rel="noopener noreferrer">RemoteIdentityOperationFailedEntityDto</a>>|A list of failed remote configuration management jobs. |
|
|
18761
19168
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remote configuration management job. |
|
|
18762
19169
|
|inProgressEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of in-progress remote configuration management jobs. |
|
|
18763
|
-
|operations|Array<<a href="#remoteconfigurationmanagementoperation"
|
|
19170
|
+
|operations|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of executed (successful and failed) remote configuration management jobs. |
|
|
18764
19171
|
|processedEntitiesCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of entities that were already processed at the time the response was created. |
|
|
18765
19172
|
|startTime|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started. |
|
|
18766
19173
|
|timeoutTime|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the running remote configuration management job will time-out. This field is present only for running jobs. |
|
|
@@ -18772,7 +19179,7 @@ A list of remote configuration management jobs.
|
|
|
18772
19179
|
|
|
18773
19180
|
| Name | Type | Description |
|
|
18774
19181
|
| --- | --- | --- |
|
|
18775
|
-
|jobs|Array<<a href="#remoteconfigurationmanagementjobsummary">RemoteConfigurationManagementJobSummary</a>>|A list of remote configuration management jobs. |
|
|
19182
|
+
|jobs|Array<<a href="#remoteconfigurationmanagementjobsummary" target="_blank" rel="noopener noreferrer">RemoteConfigurationManagementJobSummary</a>>|A list of remote configuration management jobs. |
|
|
18776
19183
|
|
|
18777
19184
|
### RemoteConfigurationManagementJobPreview
|
|
18778
19185
|
|
|
@@ -18814,7 +19221,7 @@ Remote configuration management operation creation request.
|
|
|
18814
19221
|
| Name | Type | Description |
|
|
18815
19222
|
| --- | --- | --- |
|
|
18816
19223
|
|entities<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of entities IDs for which remote configuration management is to be executed. |
|
|
18817
|
-
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation"
|
|
19224
|
+
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of remote configuration management operations to be executed. |
|
|
18818
19225
|
|
|
18819
19226
|
### RemoteConfigurationManagementOperationOneAgentRequest
|
|
18820
19227
|
|
|
@@ -18823,7 +19230,7 @@ Remote configuration management operation creation request.
|
|
|
18823
19230
|
| Name | Type | Description |
|
|
18824
19231
|
| --- | --- | --- |
|
|
18825
19232
|
|entities<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of entities IDs for which remote configuration management is to be executed. |
|
|
18826
|
-
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of remote configuration management operations to be executed. |
|
|
19233
|
+
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation" target="_blank" rel="noopener noreferrer">RemoteConfigurationManagementOperation</a>>|A list of remote configuration management operations to be executed. |
|
|
18827
19234
|
|
|
18828
19235
|
### RemoteConfigurationManagementOperationValidationError
|
|
18829
19236
|
|
|
@@ -18842,7 +19249,7 @@ A list of remote configuration management jobs previews.
|
|
|
18842
19249
|
|
|
18843
19250
|
| Name | Type | Description |
|
|
18844
19251
|
| --- | --- | --- |
|
|
18845
|
-
|previews|Array<<a href="#remoteconfigurationmanagementjobpreview"
|
|
19252
|
+
|previews|Array<<a href="#remoteconfigurationmanagementjobpreview">RemoteConfigurationManagementJobPreview</a>>|A list of remote configuration management jobs previews. |
|
|
18846
19253
|
|
|
18847
19254
|
### RemoteConfigurationManagementValidationResult
|
|
18848
19255
|
|
|
@@ -18850,8 +19257,8 @@ The result of remote configuration management validation.
|
|
|
18850
19257
|
|
|
18851
19258
|
| Name | Type | Description |
|
|
18852
19259
|
| --- | --- | --- |
|
|
18853
|
-
|invalidEntities|Array<<a href="#remoteconfigurationmanagemententityvalidationerror">RemoteConfigurationManagementEntityValidationError</a>>|A list of validation errors for entities. |
|
|
18854
|
-
|invalidOperations|Array<<a href="#remoteconfigurationmanagementoperationvalidationerror"
|
|
19260
|
+
|invalidEntities|Array<<a href="#remoteconfigurationmanagemententityvalidationerror" target="_blank" rel="noopener noreferrer">RemoteConfigurationManagementEntityValidationError</a>>|A list of validation errors for entities. |
|
|
19261
|
+
|invalidOperations|Array<<a href="#remoteconfigurationmanagementoperationvalidationerror">RemoteConfigurationManagementOperationValidationError</a>>|A list of validation errors for operations. |
|
|
18855
19262
|
|
|
18856
19263
|
### RemoteIdentityOperationFailedEntityDto
|
|
18857
19264
|
|
|
@@ -18879,7 +19286,7 @@ Header Options of a Browser Monitor.
|
|
|
18879
19286
|
| Name | Type | Description |
|
|
18880
19287
|
| --- | --- | --- |
|
|
18881
19288
|
|matchingPatterns<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Apply headers to requests matching pattern. |
|
|
18882
|
-
|requestHeaders<sup>*required</sup>|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|Request headers list. |
|
|
19289
|
+
|requestHeaders<sup>*required</sup>|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|Request headers list. |
|
|
18883
19290
|
|
|
18884
19291
|
### RequestInformation
|
|
18885
19292
|
|
|
@@ -18889,14 +19296,14 @@ Describes the complete request information of an attack.
|
|
|
18889
19296
|
| --- | --- | --- |
|
|
18890
19297
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
18891
19298
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
18892
|
-
|protocolDetails|<a href="#protocoldetails"
|
|
19299
|
+
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>|Details that are specific to the used protocol. |
|
|
18893
19300
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
18894
19301
|
|
|
18895
19302
|
### ResolutionRequest
|
|
18896
19303
|
|
|
18897
19304
|
| Name | Type |
|
|
18898
19305
|
| --- | --- |
|
|
18899
|
-
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest">SinglePermissionRequest</a>>|
|
|
19306
|
+
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest" target="_blank" rel="noopener noreferrer">SinglePermissionRequest</a>>|
|
|
18900
19307
|
|
|
18901
19308
|
### ResourceContext
|
|
18902
19309
|
|
|
@@ -18904,7 +19311,7 @@ The resource context, which contains additional permission information about the
|
|
|
18904
19311
|
|
|
18905
19312
|
| Name | Type | Description |
|
|
18906
19313
|
| --- | --- | --- |
|
|
18907
|
-
|modifications<sup>*required</sup>|<a href="#modification"
|
|
19314
|
+
|modifications<sup>*required</sup>|<a href="#modification">Modification</a>|The additional modification details for this settings object. |
|
|
18908
19315
|
|operations<sup>*required</sup>|Array<"delete" | "read" | "write">|The allowed operations on this settings object. |
|
|
18909
19316
|
|
|
18910
19317
|
### RevisionDiff
|
|
@@ -18917,10 +19324,10 @@ The diff between two revisions.
|
|
|
18917
19324
|
|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. |
|
|
18918
19325
|
|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. |
|
|
18919
19326
|
|jsonPatch|AnyValue|The JSON Patch for this value. May be null if the diff type is not UPDATE. |
|
|
18920
|
-
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
19327
|
+
|modificationInfo|<a href="#historymodificationinfo" target="_blank" rel="noopener noreferrer">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
18921
19328
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
18922
|
-
|ownerAfter|<a href="#identity"
|
|
18923
|
-
|ownerBefore|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
19329
|
+
|ownerAfter|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
19330
|
+
|ownerBefore|<a href="#identity" target="_blank" rel="noopener noreferrer">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
18924
19331
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
18925
19332
|
|schemaDisplayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema to which the revision belongs. |
|
|
18926
19333
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Schema ID to which the revision belongs. |
|
|
@@ -18936,7 +19343,7 @@ The paged response payload for diff between revisions of settings.
|
|
|
18936
19343
|
| Name | Type | Description |
|
|
18937
19344
|
| --- | --- | --- |
|
|
18938
19345
|
|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. |
|
|
18939
|
-
|items<sup>*required</sup>|Array<<a href="#revisiondiff"
|
|
19346
|
+
|items<sup>*required</sup>|Array<<a href="#revisiondiff">RevisionDiff</a>>|The list of revisions changes in the current page. |
|
|
18940
19347
|
|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> |
|
|
18941
19348
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
18942
19349
|
|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. |
|
|
@@ -18948,7 +19355,7 @@ Risk assessment of a security problem.
|
|
|
18948
19355
|
| Name | Type | Description |
|
|
18949
19356
|
| --- | --- | --- |
|
|
18950
19357
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
18951
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
19358
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
18952
19359
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
18953
19360
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
18954
19361
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -18983,7 +19390,7 @@ Risk assessment of a security problem.
|
|
|
18983
19390
|
| Name | Type | Description |
|
|
18984
19391
|
| --- | --- | --- |
|
|
18985
19392
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment. |
|
|
18986
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails"
|
|
19393
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
18987
19394
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score. |
|
|
18988
19395
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
18989
19396
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -19003,7 +19410,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
19003
19410
|
| Name | Type | Description |
|
|
19004
19411
|
| --- | --- | --- |
|
|
19005
19412
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
19006
|
-
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
19413
|
+
|changes|<a href="#riskassessmentchanges" target="_blank" rel="noopener noreferrer">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
19007
19414
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities. |
|
|
19008
19415
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
19009
19416
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
@@ -19036,7 +19443,7 @@ Parameters of a service-level objective (SLO).
|
|
|
19036
19443
|
|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>). |
|
|
19037
19444
|
|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> |
|
|
19038
19445
|
|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> |
|
|
19039
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate"
|
|
19446
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>|Error budget burn rate evaluation of a service-level objective (SLO). |
|
|
19040
19447
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric. |
|
|
19041
19448
|
|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> |
|
|
19042
19449
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
@@ -19068,7 +19475,7 @@ Contains SLOs and paging information.
|
|
|
19068
19475
|
| --- | --- | --- |
|
|
19069
19476
|
|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> |
|
|
19070
19477
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
19071
|
-
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs. |
|
|
19478
|
+
|slo<sup>*required</sup>|Array<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>>|The list of SLOs. |
|
|
19072
19479
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
19073
19480
|
|
|
19074
19481
|
### SNMPV3Credentials
|
|
@@ -19078,7 +19485,7 @@ A credentials set of the `SNMPV3` type.
|
|
|
19078
19485
|
| Name | Type | Description |
|
|
19079
19486
|
| --- | --- | --- |
|
|
19080
19487
|
|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). |
|
|
19081
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
19488
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
19082
19489
|
|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) |
|
|
19083
19490
|
|authenticationProtocol|"MD5" | "SHA" | "SHA224" | "SHA256" | "SHA384" | "SHA512"|The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512 |
|
|
19084
19491
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
@@ -19110,26 +19517,26 @@ A credentials set of the `SNMPV3` type.
|
|
|
19110
19517
|
| Name | Type | Description |
|
|
19111
19518
|
| --- | --- | --- |
|
|
19112
19519
|
|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. |
|
|
19113
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
19114
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
19520
|
+
|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. |
|
|
19521
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted. |
|
|
19115
19522
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema. |
|
|
19116
19523
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
19117
19524
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
19118
19525
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
19119
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
19526
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
19120
19527
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
19121
19528
|
|maturity|"EARLY_ADOPTER" | "GENERAL_AVAILABILITY" | "PREVIEW"|<p>The maturity of the schema. Possible values:</p> <ul> <li>PREVIEW: Preview features are not generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways.</li> <li>EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but are not mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but please be aware, that these are not fully stable yet and incompatible changes may be necessary in rare cases.</li> <li>GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.</li> </ul> <p>In any case, automations should make use of the <code>schemaVersion</code> field when writing settings objects.</p> |
|
|
19122
19529
|
|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> |
|
|
19123
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
19530
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting. |
|
|
19124
19531
|
|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. |
|
|
19125
19532
|
|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> |
|
|
19126
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
19127
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
19533
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
19534
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
19128
19535
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
19129
19536
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
19130
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
19131
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
19132
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
19537
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
19538
|
+
|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> |
|
|
19539
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
19133
19540
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
19134
19541
|
|
|
19135
19542
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -19176,7 +19583,7 @@ The list of available settings schemas.
|
|
|
19176
19583
|
|
|
19177
19584
|
| Name | Type | Description |
|
|
19178
19585
|
| --- | --- | --- |
|
|
19179
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
19586
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas. |
|
|
19180
19587
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list. |
|
|
19181
19588
|
|
|
19182
19589
|
### SchemaStub
|
|
@@ -19201,11 +19608,11 @@ A list of definitions of types.
|
|
|
19201
19608
|
|
|
19202
19609
|
| Name | Type | Description |
|
|
19203
19610
|
| --- | --- | --- |
|
|
19204
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
19611
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
19205
19612
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
19206
19613
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
19207
19614
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
19208
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
19615
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>|Definition of properties that can be persisted. |
|
|
19209
19616
|
|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. |
|
|
19210
19617
|
|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. |
|
|
19211
19618
|
|type<sup>*required</sup>|"object"|Type of the reference type. |
|
|
@@ -19267,19 +19674,19 @@ Parameters of a security problem
|
|
|
19267
19674
|
|
|
19268
19675
|
| Name | Type | Description |
|
|
19269
19676
|
| --- | --- | --- |
|
|
19270
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
19677
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
19271
19678
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
19272
19679
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
19273
19680
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
19274
19681
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
19275
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
19682
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
19276
19683
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
19277
19684
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
19278
19685
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
19279
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
19686
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
19280
19687
|
|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. |
|
|
19281
19688
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
19282
|
-
|riskAssessment|<a href="#riskassessment"
|
|
19689
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>|Risk assessment of a security problem. |
|
|
19283
19690
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
19284
19691
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
19285
19692
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
@@ -19304,37 +19711,37 @@ Parameters of a security problem
|
|
|
19304
19711
|
| Name | Type | Description |
|
|
19305
19712
|
| --- | --- | --- |
|
|
19306
19713
|
|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> |
|
|
19307
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
19714
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
19308
19715
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
19309
19716
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
19310
19717
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
19311
|
-
|entryPoints|<a href="#entrypoints"
|
|
19312
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
19718
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>|A list of entry points and a flag which indicates whether this list was truncated or not. |
|
|
19719
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
19313
19720
|
|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> |
|
|
19314
19721
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
19315
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
19722
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>|Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters. |
|
|
19316
19723
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
19317
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
19724
|
+
|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. |
|
|
19318
19725
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
19319
19726
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
19320
19727
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
19321
|
-
|managementZones|Array<<a href="#managementzone"
|
|
19728
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
19322
19729
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress. |
|
|
19323
19730
|
|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. |
|
|
19324
19731
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
19325
19732
|
|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> |
|
|
19326
|
-
|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> |
|
|
19327
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
19328
|
-
|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> |
|
|
19733
|
+
|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> |
|
|
19734
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>|A list of related container images. |
|
|
19735
|
+
|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> |
|
|
19329
19736
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
19330
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
19737
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>|Risk assessment of a security problem. |
|
|
19331
19738
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
19332
19739
|
|status|"OPEN" | "RESOLVED"|The status of the security problem. |
|
|
19333
19740
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem. |
|
|
19334
19741
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
19335
19742
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
19336
19743
|
|vulnerabilityType|"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"|The type of the vulnerability. |
|
|
19337
|
-
|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> |
|
|
19744
|
+
|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> |
|
|
19338
19745
|
|
|
19339
19746
|
### SecurityProblemEvent
|
|
19340
19747
|
|
|
@@ -19342,9 +19749,9 @@ The event of a security problem.
|
|
|
19342
19749
|
|
|
19343
19750
|
| Name | Type | Description |
|
|
19344
19751
|
| --- | --- | --- |
|
|
19345
|
-
|muteState|<a href="#mutestate"
|
|
19752
|
+
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event. |
|
|
19346
19753
|
|reason|"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED" | "VULNERABILITY_DEPRECATED" | "VULNERABILITY_ID_CHANGED"|The reason of the event creation. |
|
|
19347
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
19754
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
19348
19755
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
19349
19756
|
|
|
19350
19757
|
### SecurityProblemEventsList
|
|
@@ -19353,7 +19760,7 @@ A list of events for a security problem.
|
|
|
19353
19760
|
|
|
19354
19761
|
| Name | Type | Description |
|
|
19355
19762
|
| --- | --- | --- |
|
|
19356
|
-
|events|Array<<a href="#securityproblemevent"
|
|
19763
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem. |
|
|
19357
19764
|
|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> |
|
|
19358
19765
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
19359
19766
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -19366,7 +19773,7 @@ A list of security problems.
|
|
|
19366
19773
|
| --- | --- | --- |
|
|
19367
19774
|
|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> |
|
|
19368
19775
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
19369
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems. |
|
|
19776
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems. |
|
|
19370
19777
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
19371
19778
|
|
|
19372
19779
|
### SecurityProblemMute
|
|
@@ -19403,7 +19810,7 @@ Response of muting several security problems.
|
|
|
19403
19810
|
|
|
19404
19811
|
| Name | Type | Description |
|
|
19405
19812
|
| --- | --- | --- |
|
|
19406
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
19813
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously. |
|
|
19407
19814
|
|
|
19408
19815
|
### SecurityProblemsBulkUnmute
|
|
19409
19816
|
|
|
@@ -19421,7 +19828,7 @@ Response of un-muting several security problems.
|
|
|
19421
19828
|
|
|
19422
19829
|
| Name | Type | Description |
|
|
19423
19830
|
| --- | --- | --- |
|
|
19424
|
-
|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. |
|
|
19831
|
+
|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. |
|
|
19425
19832
|
|
|
19426
19833
|
### SelectOptionStepDto
|
|
19427
19834
|
|
|
@@ -19431,11 +19838,11 @@ Select option step of Browser Monitor.
|
|
|
19431
19838
|
| --- | --- | --- |
|
|
19432
19839
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
19433
19840
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
19434
|
-
|selections<sup>*required</sup>|Array<<a href="#selectiondto"
|
|
19435
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
19841
|
+
|selections<sup>*required</sup>|Array<<a href="#selectiondto">SelectionDto</a>>|Field containing the credential. |
|
|
19842
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
19436
19843
|
|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> |
|
|
19437
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
19438
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
19844
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
19845
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
19439
19846
|
|
|
19440
19847
|
### SelectionDto
|
|
19441
19848
|
|
|
@@ -19454,7 +19861,7 @@ Analysis of problem impact to a service.
|
|
|
19454
19861
|
| --- | --- | --- |
|
|
19455
19862
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
19456
19863
|
|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> |
|
|
19457
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
19864
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
19458
19865
|
|numberOfPotentiallyAffectedServiceCalls<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
19459
19866
|
|
|
19460
19867
|
### SettingsObject
|
|
@@ -19467,12 +19874,12 @@ A settings object.
|
|
|
19467
19874
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
19468
19875
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
19469
19876
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
19470
|
-
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
19877
|
+
|~~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>. |
|
|
19471
19878
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
19472
19879
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
19473
19880
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
19474
|
-
|owner|<a href="#identity"
|
|
19475
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
19881
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
19882
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
19476
19883
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
19477
19884
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
19478
19885
|
|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>. |
|
|
@@ -19494,8 +19901,8 @@ The response to a get by objectId request.
|
|
|
19494
19901
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
19495
19902
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
19496
19903
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
19497
|
-
|owner|<a href="#identity"
|
|
19498
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
19904
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
19905
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
19499
19906
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
19500
19907
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
19501
19908
|
|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>. |
|
|
@@ -19525,7 +19932,7 @@ The response to a creation- or update-request.
|
|
|
19525
19932
|
| Name | Type | Description |
|
|
19526
19933
|
| --- | --- | --- |
|
|
19527
19934
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object. |
|
|
19528
|
-
|error|<a href="#error"
|
|
19935
|
+
|error|<a href="#error">Error</a>| |
|
|
19529
19936
|
|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> |
|
|
19530
19937
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object. |
|
|
19531
19938
|
|
|
@@ -19547,7 +19954,7 @@ A list of permissions.
|
|
|
19547
19954
|
|
|
19548
19955
|
| Name | Type | Description |
|
|
19549
19956
|
| --- | --- | --- |
|
|
19550
|
-
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data |
|
|
19957
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>|Optional context data |
|
|
19551
19958
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed |
|
|
19552
19959
|
|
|
19553
19960
|
### SloBurnRate
|
|
@@ -19578,7 +19985,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
19578
19985
|
| --- | --- | --- |
|
|
19579
19986
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
19580
19987
|
|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> |
|
|
19581
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig"
|
|
19988
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>|Error budget burn rate configuration of a service-level objective (SLO). |
|
|
19582
19989
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO. |
|
|
19583
19990
|
|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>. |
|
|
19584
19991
|
|~~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> |
|
|
@@ -19624,7 +20031,7 @@ Parameters of a status alert.
|
|
|
19624
20031
|
|
|
19625
20032
|
| Name | Type |
|
|
19626
20033
|
| --- | --- |
|
|
19627
|
-
|details|<a href="#success">Success</a>|
|
|
20034
|
+
|details|<a href="#success" target="_blank" rel="noopener noreferrer">Success</a>|
|
|
19628
20035
|
|
|
19629
20036
|
### SyntheticBrowserMonitorConfigurationDto
|
|
19630
20037
|
|
|
@@ -19633,21 +20040,21 @@ Browser Monitor configuration.
|
|
|
19633
20040
|
| Name | Type | Description |
|
|
19634
20041
|
| --- | --- | --- |
|
|
19635
20042
|
|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. |
|
|
19636
|
-
|browserPermissions|<a href="#browserpermissionsdto"
|
|
20043
|
+
|browserPermissions|<a href="#browserpermissionsdto">BrowserPermissionsDto</a>|Permissions settings for browser. |
|
|
19637
20044
|
|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. |
|
|
19638
|
-
|chromiumStartupFlags|<a href="#chromiumstartupflagsdto">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor. |
|
|
19639
|
-
|clientCertificates|Array<<a href="#clientcertificatedto"
|
|
19640
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|Cookies list. |
|
|
19641
|
-
|device<sup>*required</sup>|<a href="#testdevicedto"
|
|
19642
|
-
|enablement|<a href="#enablementdto">EnablementDto</a>|Browser monitor enablement settings. |
|
|
19643
|
-
|experimentalProperties|Array<<a href="#monitorpropertydto"
|
|
19644
|
-
|filteredRequests|<a href="#filteredrequestsdto">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor. |
|
|
19645
|
-
|ignoredErrorCodes|<a href="#ignorederrorcodesdto"
|
|
19646
|
-
|javaScriptSettings|<a href="#javascriptagentsettingsdto">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings. |
|
|
20045
|
+
|chromiumStartupFlags|<a href="#chromiumstartupflagsdto" target="_blank" rel="noopener noreferrer">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor. |
|
|
20046
|
+
|clientCertificates|Array<<a href="#clientcertificatedto">ClientCertificateDto</a>>|Identifier of stored client's certificate. |
|
|
20047
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Cookies list. |
|
|
20048
|
+
|device<sup>*required</sup>|<a href="#testdevicedto">TestDeviceDto</a>|Test device of a Browser Monitor. |
|
|
20049
|
+
|enablement|<a href="#enablementdto" target="_blank" rel="noopener noreferrer">EnablementDto</a>|Browser monitor enablement settings. |
|
|
20050
|
+
|experimentalProperties|Array<<a href="#monitorpropertydto">MonitorPropertyDto</a>>|Experimental properties list. |
|
|
20051
|
+
|filteredRequests|<a href="#filteredrequestsdto" target="_blank" rel="noopener noreferrer">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor. |
|
|
20052
|
+
|ignoredErrorCodes|<a href="#ignorederrorcodesdto">IgnoredErrorCodesDto</a>|Ignored Error Codes of a Browser Monitor. |
|
|
20053
|
+
|javaScriptSettings|<a href="#javascriptagentsettingsdto" target="_blank" rel="noopener noreferrer">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings. |
|
|
19647
20054
|
|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. |
|
|
19648
|
-
|networkThrottling|<a href="#networkthrottlingdto"
|
|
19649
|
-
|proxy|<a href="#proxydto">ProxyDto</a>|Browser Monitor proxy. |
|
|
19650
|
-
|requestHeaderOptions|<a href="#requestheaderoptionsdto"
|
|
20055
|
+
|networkThrottling|<a href="#networkthrottlingdto">NetworkThrottlingDto</a>|Network throttling of a Browser Monitor. |
|
|
20056
|
+
|proxy|<a href="#proxydto" target="_blank" rel="noopener noreferrer">ProxyDto</a>|Browser Monitor proxy. |
|
|
20057
|
+
|requestHeaderOptions|<a href="#requestheaderoptionsdto">RequestHeaderOptionsDto</a>|Header Options of a Browser Monitor. |
|
|
19651
20058
|
|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. |
|
|
19652
20059
|
|userAgent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User agent |
|
|
19653
20060
|
|
|
@@ -19657,20 +20064,19 @@ Browser monitor update.
|
|
|
19657
20064
|
|
|
19658
20065
|
| Name | Type | Description |
|
|
19659
20066
|
| --- | --- | --- |
|
|
19660
|
-
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
20067
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
19661
20068
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
19662
20069
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
19663
20070
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER). |
|
|
19664
|
-
|keyPerformanceMetrics|<a href="#keyperformancemetrics"
|
|
20071
|
+
|keyPerformanceMetrics|<a href="#keyperformancemetrics">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
19665
20072
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
19666
20073
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
19667
20074
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19668
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
19669
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
19670
|
-
|
|
|
19671
|
-
|
|
|
19672
|
-
|
|
|
19673
|
-
|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> |
|
|
20075
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20076
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20077
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
20078
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20079
|
+
|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> |
|
|
19674
20080
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
19675
20081
|
|
|
19676
20082
|
### SyntheticBrowserMonitorResponse
|
|
@@ -19680,23 +20086,22 @@ Browser Monitor.
|
|
|
19680
20086
|
| Name | Type | Description |
|
|
19681
20087
|
| --- | --- | --- |
|
|
19682
20088
|
|automaticallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Automatically assigned entities. |
|
|
19683
|
-
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto"
|
|
20089
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
19684
20090
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
19685
20091
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. |
|
|
19686
20092
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
19687
20093
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
19688
|
-
|keyPerformanceMetrics<sup>*required</sup>|<a href="#keyperformancemetrics">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
20094
|
+
|keyPerformanceMetrics<sup>*required</sup>|<a href="#keyperformancemetrics" target="_blank" rel="noopener noreferrer">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
19689
20095
|
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
19690
20096
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
19691
20097
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
19692
20098
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19693
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
19694
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
19695
|
-
|
|
|
19696
|
-
|
|
|
19697
|
-
|
|
|
19698
|
-
|
|
|
19699
|
-
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
20099
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20100
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20101
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
20102
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20103
|
+
|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> |
|
|
20104
|
+
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
19700
20105
|
|
|
19701
20106
|
### SyntheticBrowserMonitorStepDto
|
|
19702
20107
|
|
|
@@ -19738,7 +20143,7 @@ The Http step's configuration.
|
|
|
19738
20143
|
|clientCertificateId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Identifier of stored client's certificate. |
|
|
19739
20144
|
|doNotPersistSensitiveData|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true the step's data aren't stored and displayed. <i>default:</i> <code>false</code>|
|
|
19740
20145
|
|followRedirects|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true follow redirects. <i>default:</i> <code>false</code>|
|
|
19741
|
-
|headers|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|The headers. |
|
|
20146
|
+
|headers|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|The headers. |
|
|
19742
20147
|
|sslCertificateExpirationDaysToAlert|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of days within SSL certificate expires. |
|
|
19743
20148
|
|
|
19744
20149
|
### SyntheticHttpMonitorAdvancedDto
|
|
@@ -19764,20 +20169,19 @@ Http monitor's settings.
|
|
|
19764
20169
|
|
|
19765
20170
|
| Name | Type | Description |
|
|
19766
20171
|
| --- | --- | --- |
|
|
19767
|
-
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto"
|
|
19768
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|The cookies of the monitor. |
|
|
20172
|
+
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings. |
|
|
20173
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|The cookies of the monitor. |
|
|
19769
20174
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
19770
20175
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
19771
20176
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER). |
|
|
19772
20177
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
19773
20178
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
19774
20179
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19775
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
19776
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
19777
|
-
|
|
|
19778
|
-
|
|
|
19779
|
-
|
|
|
19780
|
-
|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> |
|
|
20180
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20181
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20182
|
+
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto">SyntheticHttpMonitorStepDto</a>>|The steps of the monitor. |
|
|
20183
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20184
|
+
|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> |
|
|
19781
20185
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
19782
20186
|
|
|
19783
20187
|
### SyntheticHttpMonitorResponse
|
|
@@ -19786,9 +20190,9 @@ Http monitor.
|
|
|
19786
20190
|
|
|
19787
20191
|
| Name | Type | Description |
|
|
19788
20192
|
| --- | --- | --- |
|
|
19789
|
-
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings. |
|
|
20193
|
+
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings. |
|
|
19790
20194
|
|automaticallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Automatically assigned entities. |
|
|
19791
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto"
|
|
20195
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|The cookies of the monitor. |
|
|
19792
20196
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
19793
20197
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. |
|
|
19794
20198
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
@@ -19797,13 +20201,12 @@ Http monitor.
|
|
|
19797
20201
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
19798
20202
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
19799
20203
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19800
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
19801
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
19802
|
-
|
|
|
19803
|
-
|
|
|
19804
|
-
|
|
|
19805
|
-
|
|
|
19806
|
-
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
20204
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20205
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20206
|
+
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorStepDto</a>>|The steps of the monitor. |
|
|
20207
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20208
|
+
|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> |
|
|
20209
|
+
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
19807
20210
|
|
|
19808
20211
|
### SyntheticHttpMonitorStepDto
|
|
19809
20212
|
|
|
@@ -19811,9 +20214,9 @@ The step of a Http monitor.
|
|
|
19811
20214
|
|
|
19812
20215
|
| Name | Type | Description |
|
|
19813
20216
|
| --- | --- | --- |
|
|
19814
|
-
|authentication|<a href="#synthetichttpauthenticationdto"
|
|
19815
|
-
|configuration|<a href="#synthetichttpconfigurationdto">SyntheticHttpConfigurationDto</a>|The Http step's configuration. |
|
|
19816
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
20217
|
+
|authentication|<a href="#synthetichttpauthenticationdto">SyntheticHttpAuthenticationDto</a>|The Http step's authentication. |
|
|
20218
|
+
|configuration|<a href="#synthetichttpconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticHttpConfigurationDto</a>|The Http step's configuration. |
|
|
20219
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints. |
|
|
19817
20220
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
19818
20221
|
|methodType<sup>*required</sup>|"DELETE" | "GET" | "POST" | "PUT" | "HEAD" | "OPTIONS" | "PATCH"|Method type. |
|
|
19819
20222
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
@@ -19869,7 +20272,7 @@ A list of synthetic locations.
|
|
|
19869
20272
|
|
|
19870
20273
|
| Name | Type | Description |
|
|
19871
20274
|
| --- | --- | --- |
|
|
19872
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
20275
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement" target="_blank" rel="noopener noreferrer">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
19873
20276
|
|
|
19874
20277
|
### SyntheticMonitorConstraintDto
|
|
19875
20278
|
|
|
@@ -19877,7 +20280,7 @@ Synthetic monitor constraint. The allowed type and properties depend on the moni
|
|
|
19877
20280
|
|
|
19878
20281
|
| Name | Type | Description |
|
|
19879
20282
|
| --- | --- | --- |
|
|
19880
|
-
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties"
|
|
20283
|
+
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties">SyntheticMonitorConstraintDtoProperties</a>|Constraint properties. Most constraint types use operator and value keys. Some protocol-specific constraints may use additional keys, for example DNS_STATUS_CODE can use status. |
|
|
19881
20284
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. Allowed values depend on monitor type and step/request context. HTTP monitor step constraints: HTTP_STATUSES, HTTP_RESPONSE_PATTERN, HTTP_RESPONSE_REGEX. Network availability monitor(MULTI_PROTOCOL) step constraints: SUCCESS_RATE_PERCENT. Network availability monitor(MULTI_PROTOCOL) request configuration constraints are request-type specific, for example ICMP_SUCCESS_RATE_PERCENT (ICMP) and DNS_STATUS_CODE (DNS). |
|
|
19882
20285
|
|
|
19883
20286
|
### SyntheticMonitorConstraintDtoProperties
|
|
@@ -19903,7 +20306,7 @@ List of available synthetic monitors.
|
|
|
19903
20306
|
|
|
19904
20307
|
| Name | Type | Description |
|
|
19905
20308
|
| --- | --- | --- |
|
|
19906
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
20309
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
19907
20310
|
|
|
19908
20311
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
19909
20312
|
|
|
@@ -19930,7 +20333,7 @@ The performance threshold rule.
|
|
|
19930
20333
|
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size). |
|
|
19931
20334
|
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed. |
|
|
19932
20335
|
|threshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> time units to execute. For network availability monitors the time unit is milliseconds, for browser and HTTP monitors - seconds. |
|
|
19933
|
-
|type|"MONITOR" | "STEP"|Type of performance threshold
|
|
20336
|
+
|type|"MONITOR" | "STEP"|Type of performance threshold |
|
|
19934
20337
|
|violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window. |
|
|
19935
20338
|
|
|
19936
20339
|
### SyntheticMonitorPerformanceThresholdsDto
|
|
@@ -19940,7 +20343,7 @@ Performance thresholds configuration.
|
|
|
19940
20343
|
| Name | Type | Description |
|
|
19941
20344
|
| --- | --- | --- |
|
|
19942
20345
|
|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>). |
|
|
19943
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto"
|
|
20346
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
19944
20347
|
|
|
19945
20348
|
### SyntheticMonitorPrimaryGrailTagDto
|
|
19946
20349
|
|
|
@@ -19957,10 +20360,10 @@ Basic monitor data.
|
|
|
19957
20360
|
|
|
19958
20361
|
| Name | Type | Description |
|
|
19959
20362
|
| --- | --- | --- |
|
|
19960
|
-
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.
|
|
19961
|
-
|entityId
|
|
19962
|
-
|name
|
|
19963
|
-
|type
|
|
20363
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. |
|
|
20364
|
+
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
20365
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
20366
|
+
|type|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|The type of the monitor. |
|
|
19964
20367
|
|
|
19965
20368
|
### SyntheticMultiProtocolMonitorRequest
|
|
19966
20369
|
|
|
@@ -19973,12 +20376,11 @@ Network availability monitor.
|
|
|
19973
20376
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for MULTI_PROTOCOL and HTTP, 15 minutes for BROWSER). |
|
|
19974
20377
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
19975
20378
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19976
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
19977
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
19978
|
-
|
|
|
19979
|
-
|
|
|
19980
|
-
|
|
|
19981
|
-
|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> |
|
|
20379
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20380
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20381
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
20382
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20383
|
+
|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> |
|
|
19982
20384
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
19983
20385
|
|
|
19984
20386
|
### SyntheticMultiProtocolMonitorResponse
|
|
@@ -19994,13 +20396,12 @@ Network availability monitor.
|
|
|
19994
20396
|
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
19995
20397
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
19996
20398
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
19997
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
19998
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
19999
|
-
|
|
|
20000
|
-
|
|
|
20001
|
-
|
|
|
20002
|
-
|
|
|
20003
|
-
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
20399
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
20400
|
+
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPrimaryGrailTagDto</a>>|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed. |
|
|
20401
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
20402
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
20403
|
+
|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> |
|
|
20404
|
+
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type. |
|
|
20004
20405
|
|
|
20005
20406
|
### SyntheticMultiProtocolMonitorStepDto
|
|
20006
20407
|
|
|
@@ -20008,10 +20409,10 @@ The step of a network availability monitor.
|
|
|
20008
20409
|
|
|
20009
20410
|
| Name | Type | Description |
|
|
20010
20411
|
| --- | --- | --- |
|
|
20011
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
20412
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
20012
20413
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
20013
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties"
|
|
20014
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
20414
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
20415
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
20015
20416
|
|requestType<sup>*required</sup>|"ICMP" | "TCP" | "DNS"|Request type. |
|
|
20016
20417
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
20017
20418
|
|targetList|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -20028,7 +20429,7 @@ The configuration of a network availability monitor request.
|
|
|
20028
20429
|
|
|
20029
20430
|
| Name | Type | Description |
|
|
20030
20431
|
| --- | --- | --- |
|
|
20031
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
20432
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|Request constraints. |
|
|
20032
20433
|
|
|
20033
20434
|
### SyntheticOnDemandBatchStatus
|
|
20034
20435
|
|
|
@@ -20040,12 +20441,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
20040
20441
|
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"|The status of the batch. |
|
|
20041
20442
|
|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. |
|
|
20042
20443
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
20043
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
20044
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
20444
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
20445
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
20045
20446
|
|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. |
|
|
20046
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
20447
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
20047
20448
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
20048
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
20449
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
20049
20450
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
20050
20451
|
|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. |
|
|
20051
20452
|
|
|
@@ -20067,14 +20468,14 @@ Describes the status of an on-demand execution.
|
|
|
20067
20468
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
20068
20469
|
|executionStage<sup>*required</sup>|"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"|Execution stage. |
|
|
20069
20470
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
20070
|
-
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
20471
|
+
|fullResults|<a href="#executionfullresults" target="_blank" rel="noopener noreferrer">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
20071
20472
|
|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. |
|
|
20072
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata"
|
|
20473
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
20073
20474
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
20074
20475
|
|nextExecutionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Next execution id for sequential mode. |
|
|
20075
20476
|
|processingMode<sup>*required</sup>|"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The processing mode of the execution. |
|
|
20076
20477
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
20077
|
-
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
20478
|
+
|simpleResults|<a href="#executionsimpleresults" target="_blank" rel="noopener noreferrer">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
20078
20479
|
|source<sup>*required</sup>|"API" | "UI"|The source of the triggering request. |
|
|
20079
20480
|
|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. |
|
|
20080
20481
|
|
|
@@ -20092,9 +20493,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
20092
20493
|
| --- | --- | --- |
|
|
20093
20494
|
|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>|
|
|
20094
20495
|
|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>|
|
|
20095
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup"
|
|
20096
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
20097
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor"
|
|
20496
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
20497
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
20498
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
20098
20499
|
|processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode <i>default:</i> <code>"STANDARD"</code>|
|
|
20099
20500
|
|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>|
|
|
20100
20501
|
|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>|
|
|
@@ -20135,10 +20536,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
20135
20536
|
| Name | Type | Description |
|
|
20136
20537
|
| --- | --- | --- |
|
|
20137
20538
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
20138
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
20539
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
20139
20540
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
20140
20541
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
20141
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
20542
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
20142
20543
|
|
|
20143
20544
|
### SyntheticOnDemandExecutions
|
|
20144
20545
|
|
|
@@ -20146,7 +20547,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
20146
20547
|
|
|
20147
20548
|
| Name | Type | Description |
|
|
20148
20549
|
| --- | --- | --- |
|
|
20149
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
20550
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
20150
20551
|
|
|
20151
20552
|
### SyntheticOnDemandFailedExecutionStatus
|
|
20152
20553
|
|
|
@@ -20177,7 +20578,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
20177
20578
|
|
|
20178
20579
|
| Name | Type | Description |
|
|
20179
20580
|
| --- | --- | --- |
|
|
20180
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails"
|
|
20581
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
20181
20582
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
20182
20583
|
|
|
20183
20584
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -20263,7 +20664,7 @@ Target of Browser Monitor step.
|
|
|
20263
20664
|
|
|
20264
20665
|
| Name | Type | Description |
|
|
20265
20666
|
| --- | --- | --- |
|
|
20266
|
-
|locators<sup>*required</sup>|Array<<a href="#locatordto">LocatorDto</a>>|List of locators. |
|
|
20667
|
+
|locators<sup>*required</sup>|Array<<a href="#locatordto" target="_blank" rel="noopener noreferrer">LocatorDto</a>>|List of locators. |
|
|
20267
20668
|
|window<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target window. |
|
|
20268
20669
|
|
|
20269
20670
|
### TenantToken
|
|
@@ -20280,8 +20681,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
20280
20681
|
|
|
20281
20682
|
| Name | Type | Description |
|
|
20282
20683
|
| --- | --- | --- |
|
|
20283
|
-
|active|<a href="#tenanttoken"
|
|
20284
|
-
|old|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
20684
|
+
|active|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
20685
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token |
|
|
20285
20686
|
|
|
20286
20687
|
### TestDeviceDto
|
|
20287
20688
|
|
|
@@ -20329,9 +20730,9 @@ A credentials set of the `TOKEN` type.
|
|
|
20329
20730
|
| Name | Type | Description |
|
|
20330
20731
|
| --- | --- | --- |
|
|
20331
20732
|
|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). |
|
|
20332
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
20733
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
20333
20734
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
20334
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
20735
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
20335
20736
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
20336
20737
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
20337
20738
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
@@ -20370,9 +20771,9 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
20370
20771
|
| --- | --- | --- |
|
|
20371
20772
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
20372
20773
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
20373
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
20774
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
20374
20775
|
|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> |
|
|
20375
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
20776
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
20376
20777
|
|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. |
|
|
20377
20778
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
20378
20779
|
|unit<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
@@ -20385,7 +20786,7 @@ The request to change ownership of an object.
|
|
|
20385
20786
|
|
|
20386
20787
|
| Name | Type | Description |
|
|
20387
20788
|
| --- | --- | --- |
|
|
20388
|
-
|newOwner|<a href="#identity"
|
|
20789
|
+
|newOwner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
20389
20790
|
|
|
20390
20791
|
### TruncatableListAttackRequestHeader
|
|
20391
20792
|
|
|
@@ -20393,8 +20794,8 @@ A list of values that has possibly been truncated.
|
|
|
20393
20794
|
|
|
20394
20795
|
| Name | Type | Description |
|
|
20395
20796
|
| --- | --- | --- |
|
|
20396
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
20397
|
-
|values|Array<<a href="#attackrequestheader"
|
|
20797
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
20798
|
+
|values|Array<<a href="#attackrequestheader">AttackRequestHeader</a>>|Values of the list. |
|
|
20398
20799
|
|
|
20399
20800
|
### TruncatableListHttpRequestParameter
|
|
20400
20801
|
|
|
@@ -20402,8 +20803,8 @@ A list of values that has possibly been truncated.
|
|
|
20402
20803
|
|
|
20403
20804
|
| Name | Type | Description |
|
|
20404
20805
|
| --- | --- | --- |
|
|
20405
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
20406
|
-
|values|Array<<a href="#httprequestparameter"
|
|
20806
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
20807
|
+
|values|Array<<a href="#httprequestparameter">HttpRequestParameter</a>>|Values of the list. |
|
|
20407
20808
|
|
|
20408
20809
|
### TruncatableListString
|
|
20409
20810
|
|
|
@@ -20411,7 +20812,7 @@ A list of values that has possibly been truncated.
|
|
|
20411
20812
|
|
|
20412
20813
|
| Name | Type | Description |
|
|
20413
20814
|
| --- | --- | --- |
|
|
20414
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
20815
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
20415
20816
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list. |
|
|
20416
20817
|
|
|
20417
20818
|
### TruncationInfo
|
|
@@ -20431,7 +20832,7 @@ UI customization for defining a button that calls a function when pressed
|
|
|
20431
20832
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description to be shown in a tooltip when hovering over the button |
|
|
20432
20833
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The label of the button |
|
|
20433
20834
|
|identifier<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the function to be called when the button is pressed |
|
|
20434
|
-
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition"
|
|
20835
|
+
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition">InsertPosition</a>|The position where the button should be shown in the UI |
|
|
20435
20836
|
|
|
20436
20837
|
### UiCallbackCustomization
|
|
20437
20838
|
|
|
@@ -20439,7 +20840,7 @@ UI customization options for defining custom callbacks
|
|
|
20439
20840
|
|
|
20440
20841
|
| Name | Type | Description |
|
|
20441
20842
|
| --- | --- | --- |
|
|
20442
|
-
|buttons|Array<<a href="#uibuttoncustomization">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
20843
|
+
|buttons|Array<<a href="#uibuttoncustomization" target="_blank" rel="noopener noreferrer">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
20443
20844
|
|
|
20444
20845
|
### UiCustomization
|
|
20445
20846
|
|
|
@@ -20447,10 +20848,10 @@ Customization for UI elements
|
|
|
20447
20848
|
|
|
20448
20849
|
| Name | Type | Description |
|
|
20449
20850
|
| --- | --- | --- |
|
|
20450
|
-
|callback|<a href="#uicallbackcustomization"
|
|
20451
|
-
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|UI customization for expandable section |
|
|
20452
|
-
|table|<a href="#uitablecustomization"
|
|
20453
|
-
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|UI customization for tabs |
|
|
20851
|
+
|callback|<a href="#uicallbackcustomization">UiCallbackCustomization</a>|UI customization options for defining custom callbacks |
|
|
20852
|
+
|expandable|<a href="#uiexpandablecustomization" target="_blank" rel="noopener noreferrer">UiExpandableCustomization</a>|UI customization for expandable section |
|
|
20853
|
+
|table|<a href="#uitablecustomization">UiTableCustomization</a>|Customization for UI tables |
|
|
20854
|
+
|tabs|<a href="#uitabscustomization" target="_blank" rel="noopener noreferrer">UiTabsCustomization</a>|UI customization for tabs |
|
|
20454
20855
|
|
|
20455
20856
|
### UiEmptyStateCustomization
|
|
20456
20857
|
|
|
@@ -20468,7 +20869,7 @@ UI customization for expandable section
|
|
|
20468
20869
|
| --- | --- | --- |
|
|
20469
20870
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name |
|
|
20470
20871
|
|expanded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if the item should be expanded by default |
|
|
20471
|
-
|sections|Array<<a href="#uiexpandablesectioncustomization"
|
|
20872
|
+
|sections|Array<<a href="#uiexpandablesectioncustomization">UiExpandableSectionCustomization</a>>|A list of sections |
|
|
20472
20873
|
|
|
20473
20874
|
### UiExpandableSectionCustomization
|
|
20474
20875
|
|
|
@@ -20501,7 +20902,7 @@ Customization for UI table columns
|
|
|
20501
20902
|
|columnRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced column from the 'tableColumns' property of the schema for this column. |
|
|
20502
20903
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name for this column. |
|
|
20503
20904
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used. |
|
|
20504
|
-
|items|Array<<a href="#uitablecolumnitemcustomization">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
20905
|
+
|items|Array<<a href="#uitablecolumnitemcustomization" target="_blank" rel="noopener noreferrer">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
20505
20906
|
|propertyRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced property for this column. |
|
|
20506
20907
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ui specific type for this column. |
|
|
20507
20908
|
|width|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The width this column should take up on the table. |
|
|
@@ -20522,8 +20923,8 @@ Customization for UI tables
|
|
|
20522
20923
|
|
|
20523
20924
|
| Name | Type | Description |
|
|
20524
20925
|
| --- | --- | --- |
|
|
20525
|
-
|columns|Array<<a href="#uitablecolumncustomization"
|
|
20526
|
-
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>|UI customization for empty state in a table |
|
|
20926
|
+
|columns|Array<<a href="#uitablecolumncustomization">UiTableColumnCustomization</a>>|A list of columns for the UI table |
|
|
20927
|
+
|emptyState|<a href="#uiemptystatecustomization" target="_blank" rel="noopener noreferrer">UiEmptyStateCustomization</a>|UI customization for empty state in a table |
|
|
20527
20928
|
|
|
20528
20929
|
### UiTabsCustomization
|
|
20529
20930
|
|
|
@@ -20531,7 +20932,7 @@ UI customization for tabs
|
|
|
20531
20932
|
|
|
20532
20933
|
| Name | Type | Description |
|
|
20533
20934
|
| --- | --- | --- |
|
|
20534
|
-
|groups|Array<<a href="#uitabgroupcustomization"
|
|
20935
|
+
|groups|Array<<a href="#uitabgroupcustomization">UiTabGroupCustomization</a>>|A list of groups |
|
|
20535
20936
|
|
|
20536
20937
|
### Unit
|
|
20537
20938
|
|
|
@@ -20561,7 +20962,7 @@ A list of units along with their properties.
|
|
|
20561
20962
|
| Name | Type | Description |
|
|
20562
20963
|
| --- | --- | --- |
|
|
20563
20964
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of units in the result. |
|
|
20564
|
-
|units<sup>*required</sup>|Array<<a href="#unit">Unit</a>>|A list of units. |
|
|
20965
|
+
|units<sup>*required</sup>|Array<<a href="#unit" target="_blank" rel="noopener noreferrer">Unit</a>>|A list of units. |
|
|
20565
20966
|
|
|
20566
20967
|
### UpdateJob
|
|
20567
20968
|
|
|
@@ -20589,7 +20990,7 @@ A list of update jobs of the ActiveGate.
|
|
|
20589
20990
|
| Name | Type | Description |
|
|
20590
20991
|
| --- | --- | --- |
|
|
20591
20992
|
|agId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate. |
|
|
20592
|
-
|updateJobs|Array<<a href="#updatejob"
|
|
20993
|
+
|updateJobs|Array<<a href="#updatejob">UpdateJob</a>>|A list of update jobs of the ActiveGate. |
|
|
20593
20994
|
|
|
20594
20995
|
### UpdateJobsAll
|
|
20595
20996
|
|
|
@@ -20597,7 +20998,7 @@ A list of ActiveGates with update jobs.
|
|
|
20597
20998
|
|
|
20598
20999
|
| Name | Type | Description |
|
|
20599
21000
|
| --- | --- | --- |
|
|
20600
|
-
|allUpdateJobs|Array<<a href="#updatejoblist">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
21001
|
+
|allUpdateJobs|Array<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
20601
21002
|
|
|
20602
21003
|
### UpdatePermissionsRequest
|
|
20603
21004
|
|
|
@@ -20607,6 +21008,23 @@ The request to update the permissions of a specific accessor.
|
|
|
20607
21008
|
| --- | --- | --- |
|
|
20608
21009
|
|permissions<sup>*required</sup>|Array<"r" | "w">|The permissions to assign to the specified accessor. |
|
|
20609
21010
|
|
|
21011
|
+
### UpdateWindow
|
|
21012
|
+
|
|
21013
|
+
Basic information about one maintenance window
|
|
21014
|
+
|
|
21015
|
+
| Name | Type | Description |
|
|
21016
|
+
| --- | --- | --- |
|
|
21017
|
+
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Identifier of maintenance window |
|
|
21018
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of maintenance window |
|
|
21019
|
+
|
|
21020
|
+
### UpdateWindowsConfig
|
|
21021
|
+
|
|
21022
|
+
Basic information about all configured update windows
|
|
21023
|
+
|
|
21024
|
+
| Name | Type | Description |
|
|
21025
|
+
| --- | --- | --- |
|
|
21026
|
+
|windows<sup>*required</sup>|Array<<a href="#updatewindow">UpdateWindow</a>>|List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience. |
|
|
21027
|
+
|
|
20610
21028
|
### UploadJavaScriptMappingFileAliasBody
|
|
20611
21029
|
|
|
20612
21030
|
| Name | Type | Description |
|
|
@@ -20901,9 +21319,9 @@ Applicable only if the **setting** parameter is set to `INHERITED`. In that case
|
|
|
20901
21319
|
|
|
20902
21320
|
<div class="padding-left--md">
|
|
20903
21321
|
|
|
20904
|
-
The state of the ActiveGate auto-update: enabled, disabled, or inherited.
|
|
21322
|
+
The state of the environment ActiveGate auto-update: enabled, disabled, or inherited.
|
|
20905
21323
|
|
|
20906
|
-
If set to `INHERITED`, the setting is inherited from the global
|
|
21324
|
+
If set to `INHERITED`, the setting is inherited from the global environment ActiveGate auto-update configuration.
|
|
20907
21325
|
|
|
20908
21326
|
#### Enum keys
|
|
20909
21327
|
|
|
@@ -20945,9 +21363,9 @@ The current status of auto-updates of the ActiveGate.
|
|
|
20945
21363
|
|
|
20946
21364
|
<div class="padding-left--md">
|
|
20947
21365
|
|
|
20948
|
-
The state of auto-updates for all
|
|
21366
|
+
The state of auto-updates for all environment ActiveGates.
|
|
20949
21367
|
|
|
20950
|
-
This setting is inherited by all ActiveGates that have the `INHERITED` setting.
|
|
21368
|
+
This setting is inherited by all environment ActiveGates that have the `INHERITED` setting.
|
|
20951
21369
|
|
|
20952
21370
|
#### Enum keys
|
|
20953
21371
|
|
|
@@ -21142,7 +21560,7 @@ The type of the ActiveGate.
|
|
|
21142
21560
|
|
|
21143
21561
|
<div class="padding-left--md">
|
|
21144
21562
|
|
|
21145
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
21563
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `OpenpipelineEventsSmartscape` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
21146
21564
|
|
|
21147
21565
|
</div>
|
|
21148
21566
|
|
|
@@ -21163,7 +21581,7 @@ The type of the ActiveGate.
|
|
|
21163
21581
|
|
|
21164
21582
|
<div class="padding-left--md">
|
|
21165
21583
|
|
|
21166
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
21584
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `OpenpipelineEventsSmartscape` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
21167
21585
|
|
|
21168
21586
|
</div>
|
|
21169
21587
|
|
|
@@ -21184,7 +21602,7 @@ The type of the ActiveGate.
|
|
|
21184
21602
|
|
|
21185
21603
|
<div class="padding-left--md">
|
|
21186
21604
|
|
|
21187
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
21605
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AgentTokenManagementRead` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionDiscoveryJmxRead` | `ExtensionDiscoveryPmiRead` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `OpenpipelineEventsSmartscape` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `RumManualInsertionTagsRead` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
21188
21606
|
|
|
21189
21607
|
</div>
|
|
21190
21608
|
|
|
@@ -21226,7 +21644,7 @@ The type of the asset.
|
|
|
21226
21644
|
|
|
21227
21645
|
<div class="padding-left--md">
|
|
21228
21646
|
|
|
21229
|
-
`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`
|
|
21647
|
+
`Alert` | `AlertTemplate` | `AwsService` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DocumentDashboard` | `DocumentScreen` | `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`
|
|
21230
21648
|
|
|
21231
21649
|
</div>
|
|
21232
21650
|
|
|
@@ -21592,6 +22010,27 @@ The type of the constraint.
|
|
|
21592
22010
|
</div>
|
|
21593
22011
|
|
|
21594
22012
|
|
|
22013
|
+
</div>
|
|
22014
|
+
|
|
22015
|
+
<a name="containerimagecomponenttype"></a>
|
|
22016
|
+
### ~~ContainerImageComponentType~~
|
|
22017
|
+
|
|
22018
|
+
> ⚠️ **Deprecated**
|
|
22019
|
+
> Use literal values.
|
|
22020
|
+
|
|
22021
|
+
<div class="padding-left--md">
|
|
22022
|
+
|
|
22023
|
+
Container image component type.
|
|
22024
|
+
|
|
22025
|
+
#### Enum keys
|
|
22026
|
+
|
|
22027
|
+
<div class="padding-left--md">
|
|
22028
|
+
|
|
22029
|
+
`Activegate` | `Codemodules` | `DatabaseDatasourceExecutor` | `DynatraceSqlExtensionExecutor` | `Eec` | `Logmodule` | `Oneagent`
|
|
22030
|
+
|
|
22031
|
+
</div>
|
|
22032
|
+
|
|
22033
|
+
|
|
21595
22034
|
</div>
|
|
21596
22035
|
|
|
21597
22036
|
<a name="createalertquerytimeframe"></a>
|
|
@@ -25446,7 +25885,7 @@ Monitor type.
|
|
|
25446
25885
|
|
|
25447
25886
|
<div class="padding-left--md">
|
|
25448
25887
|
|
|
25449
|
-
`Browser` | `MultiProtocol`
|
|
25888
|
+
`Browser` | `Http` | `MultiProtocol`
|
|
25450
25889
|
|
|
25451
25890
|
</div>
|
|
25452
25891
|
|
|
@@ -25538,7 +25977,7 @@ Monitor type.
|
|
|
25538
25977
|
|
|
25539
25978
|
<div class="padding-left--md">
|
|
25540
25979
|
|
|
25541
|
-
`Browser` | `MultiProtocol`
|
|
25980
|
+
`Browser` | `Http` | `MultiProtocol`
|
|
25542
25981
|
|
|
25543
25982
|
</div>
|
|
25544
25983
|
|
|
@@ -25690,7 +26129,7 @@ Aggregation type
|
|
|
25690
26129
|
|
|
25691
26130
|
<div class="padding-left--md">
|
|
25692
26131
|
|
|
25693
|
-
Type of performance threshold
|
|
26132
|
+
Type of performance threshold
|
|
25694
26133
|
|
|
25695
26134
|
#### Enum keys
|
|
25696
26135
|
|
|
@@ -25711,13 +26150,13 @@ Type of performance threshold.
|
|
|
25711
26150
|
|
|
25712
26151
|
<div class="padding-left--md">
|
|
25713
26152
|
|
|
25714
|
-
|
|
26153
|
+
The type of the monitor.
|
|
25715
26154
|
|
|
25716
26155
|
#### Enum keys
|
|
25717
26156
|
|
|
25718
26157
|
<div class="padding-left--md">
|
|
25719
26158
|
|
|
25720
|
-
`Browser` | `Http` | `MultiProtocol`
|
|
26159
|
+
`Browser` | `Http` | `MultiProtocol`
|
|
25721
26160
|
|
|
25722
26161
|
</div>
|
|
25723
26162
|
|
|
@@ -25759,7 +26198,7 @@ Monitor type.
|
|
|
25759
26198
|
|
|
25760
26199
|
<div class="padding-left--md">
|
|
25761
26200
|
|
|
25762
|
-
`Browser` | `MultiProtocol`
|
|
26201
|
+
`Browser` | `Http` | `MultiProtocol`
|
|
25763
26202
|
|
|
25764
26203
|
</div>
|
|
25765
26204
|
|