@dynatrace-sdk/client-classic-environment-v2 8.0.0 → 9.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 +11 -0
- package/README.md +481 -462
- package/cjs/index.js +30 -21
- package/esm/index.js +30 -21
- package/package.json +1 -1
- package/types/index.d.ts +41 -11
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/9.0.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -409,7 +409,9 @@ import { accessTokensApiTokensClient } from '@dynatrace-sdk/client-classic-envir
|
|
|
409
409
|
|
|
410
410
|
|
|
411
411
|
<a name="createapitoken"></a>
|
|
412
|
-
### createApiToken
|
|
412
|
+
### ~~createApiToken~~
|
|
413
|
+
|
|
414
|
+
> ⚠️ **Deprecated**
|
|
413
415
|
|
|
414
416
|
<div class="padding-bottom--md">
|
|
415
417
|
<strong>accessTokensApiTokensClient.createApiToken(config): Promise<<a href="#apitokencreated" target="_blank" rel="noopener noreferrer">ApiTokenCreated</a>></strong>
|
|
@@ -483,7 +485,9 @@ const data =
|
|
|
483
485
|
|
|
484
486
|
|
|
485
487
|
<a name="deleteapitoken"></a>
|
|
486
|
-
### deleteApiToken
|
|
488
|
+
### ~~deleteApiToken~~
|
|
489
|
+
|
|
490
|
+
> ⚠️ **Deprecated**
|
|
487
491
|
|
|
488
492
|
<div class="padding-bottom--md">
|
|
489
493
|
<strong>accessTokensApiTokensClient.deleteApiToken(config): Promise<void></strong>
|
|
@@ -551,7 +555,9 @@ const data =
|
|
|
551
555
|
|
|
552
556
|
|
|
553
557
|
<a name="getapitoken"></a>
|
|
554
|
-
### getApiToken
|
|
558
|
+
### ~~getApiToken~~
|
|
559
|
+
|
|
560
|
+
> ⚠️ **Deprecated**
|
|
555
561
|
|
|
556
562
|
<div class="padding-bottom--md">
|
|
557
563
|
<strong>accessTokensApiTokensClient.getApiToken(config): Promise<<a href="#apitoken" target="_blank" rel="noopener noreferrer">ApiToken</a>></strong>
|
|
@@ -622,7 +628,9 @@ const data = await accessTokensApiTokensClient.getApiToken({
|
|
|
622
628
|
|
|
623
629
|
|
|
624
630
|
<a name="listapitokens"></a>
|
|
625
|
-
### listApiTokens
|
|
631
|
+
### ~~listApiTokens~~
|
|
632
|
+
|
|
633
|
+
> ⚠️ **Deprecated**
|
|
626
634
|
|
|
627
635
|
<div class="padding-bottom--md">
|
|
628
636
|
<strong>accessTokensApiTokensClient.listApiTokens(config): Promise<<a href="#apitokenlist">ApiTokenList</a>></strong>
|
|
@@ -700,7 +708,9 @@ const data =
|
|
|
700
708
|
|
|
701
709
|
|
|
702
710
|
<a name="lookupapitoken"></a>
|
|
703
|
-
### lookupApiToken
|
|
711
|
+
### ~~lookupApiToken~~
|
|
712
|
+
|
|
713
|
+
> ⚠️ **Deprecated**
|
|
704
714
|
|
|
705
715
|
<div class="padding-bottom--md">
|
|
706
716
|
<strong>accessTokensApiTokensClient.lookupApiToken(config): Promise<<a href="#apitoken" target="_blank" rel="noopener noreferrer">ApiToken</a>></strong>
|
|
@@ -771,7 +781,9 @@ const data =
|
|
|
771
781
|
|
|
772
782
|
|
|
773
783
|
<a name="updateapitoken"></a>
|
|
774
|
-
### updateApiToken
|
|
784
|
+
### ~~updateApiToken~~
|
|
785
|
+
|
|
786
|
+
> ⚠️ **Deprecated**
|
|
775
787
|
|
|
776
788
|
<div class="padding-bottom--md">
|
|
777
789
|
<strong>accessTokensApiTokensClient.updateApiToken(config): Promise<void></strong>
|
|
@@ -10439,7 +10451,7 @@ Lists problems observed within the specified timeframe
|
|
|
10439
10451
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
10440
10452
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
|
|
10441
10453
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 50 is used.</p> |
|
|
10442
|
-
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("\[context]key:value","key:value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId("id-1", "id-2")</code>.</li> <li>Under maintenance: <code>underMaintenance(true|false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text("value")</code>. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the <code>relevance</code> sort option should be used to get the most relevant problems first. The special characters <code>\\~</code> and <code>"</code> need to be escaped using a <code>\\~</code> (e.g. double quote search <code>text("\\~"")</code>). The search value is limited to 30 characters.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
10454
|
+
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name (contains, case-insensitive): <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("\[context]key:value","key:value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId("id-1", "id-2")</code>.</li> <li>Under maintenance: <code>underMaintenance(true|false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text("value")</code>. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the <code>relevance</code> sort option should be used to get the most relevant problems first. The special characters <code>\\~</code> and <code>"</code> need to be escaped using a <code>\\~</code> (e.g. double quote search <code>text("\\~"")</code>). The search value is limited to 30 characters.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
10443
10455
|
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies a set of comma-separated (<code>,</code>) fields for sorting in the problem list.</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: problem status (<code>+</code> open problems first or <code>-</code> closed problems first)</li> <li><code>startTime</code>: problem start time (<code>+</code> old problems first or <code>-</code> new problems first)</li> <li><code>relevance</code>: problem relevance (<code>+</code> least relevant problems first or <code>-</code> most relevant problems first) - can be used only in combination with text search</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> <p>You can specify several levels of sorting. For example, <code>+status,-startTime</code> sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.</p> |
|
|
10444
10456
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
10445
10457
|
|
|
@@ -13836,7 +13848,6 @@ const data =
|
|
|
13836
13848
|
latitude: 10,
|
|
13837
13849
|
longitude: 10,
|
|
13838
13850
|
name: "...",
|
|
13839
|
-
nodes: ["..."],
|
|
13840
13851
|
type: "CLUSTER",
|
|
13841
13852
|
},
|
|
13842
13853
|
},
|
|
@@ -14647,7 +14658,7 @@ const data =
|
|
|
14647
14658
|
### updateConfiguration
|
|
14648
14659
|
|
|
14649
14660
|
<div class="padding-bottom--md">
|
|
14650
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<
|
|
14661
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<void></strong>
|
|
14651
14662
|
|
|
14652
14663
|
<div class="padding-left--md">
|
|
14653
14664
|
|
|
@@ -14665,7 +14676,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
14665
14676
|
|
|
14666
14677
|
| Name | Type |
|
|
14667
14678
|
| --- | --- |
|
|
14668
|
-
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto">SyntheticConfigDto</a>|
|
|
14679
|
+
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto" target="_blank" rel="noopener noreferrer">SyntheticConfigDto</a>|
|
|
14669
14680
|
|
|
14670
14681
|
|
|
14671
14682
|
|
|
@@ -14674,7 +14685,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
14674
14685
|
|
|
14675
14686
|
| Return type | Status code | Description |
|
|
14676
14687
|
|---|---|---|
|
|
14677
|
-
|
|
|
14688
|
+
|void|204|Success. The set of synthetic related parameters has been updated. Response doesn't have a body.|
|
|
14678
14689
|
|
|
14679
14690
|
|
|
14680
14691
|
#### Throws
|
|
@@ -14694,7 +14705,13 @@ import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/cl
|
|
|
14694
14705
|
|
|
14695
14706
|
const data =
|
|
14696
14707
|
await syntheticLocationsNodesAndConfigurationClient.updateConfiguration(
|
|
14697
|
-
{
|
|
14708
|
+
{
|
|
14709
|
+
body: {
|
|
14710
|
+
bmMonitorTimeout: 10,
|
|
14711
|
+
bmStepTimeout: 10,
|
|
14712
|
+
maintenanceWindowsExcludedFromAvailability: false,
|
|
14713
|
+
},
|
|
14714
|
+
},
|
|
14698
14715
|
);
|
|
14699
14716
|
```
|
|
14700
14717
|
|
|
@@ -14729,7 +14746,7 @@ For public locations you can only change the location status.
|
|
|
14729
14746
|
|
|
14730
14747
|
| Name | Type | Description |
|
|
14731
14748
|
| --- | --- | --- |
|
|
14732
|
-
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate"
|
|
14749
|
+
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate">SyntheticLocationUpdate</a>||
|
|
14733
14750
|
|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the synthetic location to be updated.|
|
|
14734
14751
|
|
|
14735
14752
|
|
|
@@ -14792,7 +14809,7 @@ Changes the status of public synthetic locations
|
|
|
14792
14809
|
|
|
14793
14810
|
| Name | Type |
|
|
14794
14811
|
| --- | --- |
|
|
14795
|
-
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a>|
|
|
14812
|
+
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus" target="_blank" rel="noopener noreferrer">SyntheticPublicLocationsStatus</a>|
|
|
14796
14813
|
|
|
14797
14814
|
|
|
14798
14815
|
|
|
@@ -14842,7 +14859,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
14842
14859
|
### createMonitor
|
|
14843
14860
|
|
|
14844
14861
|
<div class="padding-bottom--md">
|
|
14845
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto"
|
|
14862
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto">MonitorEntityIdDto</a>></strong>
|
|
14846
14863
|
|
|
14847
14864
|
<div class="padding-left--md">
|
|
14848
14865
|
|
|
@@ -14860,7 +14877,7 @@ Creates a synthetic monitor definition. | maturity=EARLY_ADOPTER
|
|
|
14860
14877
|
|
|
14861
14878
|
| Name | Type |
|
|
14862
14879
|
| --- | --- |
|
|
14863
|
-
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest">SyntheticBrowserMonitorRequest</a> | <a href="#synthetichttpmonitorrequest"
|
|
14880
|
+
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorRequest</a> | <a href="#synthetichttpmonitorrequest">SyntheticHttpMonitorRequest</a> | <a href="#syntheticmultiprotocolmonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorRequest</a>|
|
|
14864
14881
|
|
|
14865
14882
|
|
|
14866
14883
|
|
|
@@ -14966,7 +14983,7 @@ const data =
|
|
|
14966
14983
|
### getMonitor
|
|
14967
14984
|
|
|
14968
14985
|
<div class="padding-bottom--md">
|
|
14969
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticbrowsermonitorresponse"
|
|
14986
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticbrowsermonitorresponse">SyntheticBrowserMonitorResponse</a> | <a href="#synthetichttpmonitorresponse" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorResponse</a> | <a href="#syntheticmultiprotocolmonitorresponse">SyntheticMultiProtocolMonitorResponse</a>></strong>
|
|
14970
14987
|
|
|
14971
14988
|
<div class="padding-left--md">
|
|
14972
14989
|
|
|
@@ -15028,7 +15045,7 @@ const data =
|
|
|
15028
15045
|
### getMonitors
|
|
15029
15046
|
|
|
15030
15047
|
<div class="padding-bottom--md">
|
|
15031
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto">SyntheticMonitorListDto</a>></strong>
|
|
15048
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorListDto</a>></strong>
|
|
15032
15049
|
|
|
15033
15050
|
<div class="padding-left--md">
|
|
15034
15051
|
|
|
@@ -15106,7 +15123,7 @@ Updates a synthetic monitor definition for the given monitor ID. | maturity=EARL
|
|
|
15106
15123
|
|
|
15107
15124
|
| Name | Type | Description |
|
|
15108
15125
|
| --- | --- | --- |
|
|
15109
|
-
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest"
|
|
15126
|
+
|config.body<sup>*required</sup>|<a href="#syntheticbrowsermonitorrequest">SyntheticBrowserMonitorRequest</a> | <a href="#synthetichttpmonitorrequest" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorRequest</a> | <a href="#syntheticmultiprotocolmonitorrequest">SyntheticMultiProtocolMonitorRequest</a>||
|
|
15110
15127
|
|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor.|
|
|
15111
15128
|
|
|
15112
15129
|
|
|
@@ -15157,7 +15174,7 @@ import { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-
|
|
|
15157
15174
|
### execute
|
|
15158
15175
|
|
|
15159
15176
|
<div class="padding-bottom--md">
|
|
15160
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.execute(config): Promise<<a href="#syntheticondemandexecutionresult">SyntheticOnDemandExecutionResult</a>></strong>
|
|
15177
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.execute(config): Promise<<a href="#syntheticondemandexecutionresult" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionResult</a>></strong>
|
|
15161
15178
|
|
|
15162
15179
|
<div class="padding-left--md">
|
|
15163
15180
|
|
|
@@ -15175,7 +15192,7 @@ Triggers on-demand executions for synthetic monitors
|
|
|
15175
15192
|
|
|
15176
15193
|
| Name | Type |
|
|
15177
15194
|
| --- | --- |
|
|
15178
|
-
|config.body<sup>*required</sup>|<a href="#syntheticondemandexecutionrequest"
|
|
15195
|
+
|config.body<sup>*required</sup>|<a href="#syntheticondemandexecutionrequest">SyntheticOnDemandExecutionRequest</a>|
|
|
15179
15196
|
|
|
15180
15197
|
|
|
15181
15198
|
|
|
@@ -15219,7 +15236,7 @@ const data =
|
|
|
15219
15236
|
### getBatch
|
|
15220
15237
|
|
|
15221
15238
|
<div class="padding-bottom--md">
|
|
15222
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getBatch(config): Promise<<a href="#syntheticondemandbatchstatus">SyntheticOnDemandBatchStatus</a>></strong>
|
|
15239
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getBatch(config): Promise<<a href="#syntheticondemandbatchstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandBatchStatus</a>></strong>
|
|
15223
15240
|
|
|
15224
15241
|
<div class="padding-left--md">
|
|
15225
15242
|
|
|
@@ -15281,7 +15298,7 @@ const data =
|
|
|
15281
15298
|
### getExecution
|
|
15282
15299
|
|
|
15283
15300
|
<div class="padding-bottom--md">
|
|
15284
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecution(config): Promise<<a href="#syntheticondemandexecution"
|
|
15301
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecution(config): Promise<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>></strong>
|
|
15285
15302
|
|
|
15286
15303
|
<div class="padding-left--md">
|
|
15287
15304
|
|
|
@@ -15343,7 +15360,7 @@ const data =
|
|
|
15343
15360
|
### getExecutionFullReport
|
|
15344
15361
|
|
|
15345
15362
|
<div class="padding-bottom--md">
|
|
15346
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(config): Promise<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>></strong>
|
|
15363
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(config): Promise<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>></strong>
|
|
15347
15364
|
|
|
15348
15365
|
<div class="padding-left--md">
|
|
15349
15366
|
|
|
@@ -15405,7 +15422,7 @@ const data =
|
|
|
15405
15422
|
### getExecutions
|
|
15406
15423
|
|
|
15407
15424
|
<div class="padding-bottom--md">
|
|
15408
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutions(config): Promise<<a href="#syntheticondemandexecutions"
|
|
15425
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutions(config): Promise<<a href="#syntheticondemandexecutions">SyntheticOnDemandExecutions</a>></strong>
|
|
15409
15426
|
|
|
15410
15427
|
<div class="padding-left--md">
|
|
15411
15428
|
|
|
@@ -15476,7 +15493,7 @@ const data =
|
|
|
15476
15493
|
### rerun
|
|
15477
15494
|
|
|
15478
15495
|
<div class="padding-bottom--md">
|
|
15479
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.rerun(config): Promise<<a href="#syntheticondemandexecutionresult">SyntheticOnDemandExecutionResult</a>></strong>
|
|
15496
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.rerun(config): Promise<<a href="#syntheticondemandexecutionresult" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionResult</a>></strong>
|
|
15480
15497
|
|
|
15481
15498
|
<div class="padding-left--md">
|
|
15482
15499
|
|
|
@@ -15543,7 +15560,7 @@ A credentials set of the `AWS_MONITORING_KEY_BASED` type.
|
|
|
15543
15560
|
| --- | --- | --- |
|
|
15544
15561
|
|accessKeyID<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Access Key ID of the credentials set.|
|
|
15545
15562
|
|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).|
|
|
15546
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
15563
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
15547
15564
|
|awsPartition<sup>*required</sup>|"CHINA" | "DEFAULT" | "US_GOV"|AWS partition of the credential.|
|
|
15548
15565
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
15549
15566
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
@@ -15562,7 +15579,7 @@ A credentials set of the `AWS_MONITORING_ROLE_BASED` type.
|
|
|
15562
15579
|
| --- | --- | --- |
|
|
15563
15580
|
|accountID<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Amazon account ID of the credential.|
|
|
15564
15581
|
|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).|
|
|
15565
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
15582
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
15566
15583
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
15567
15584
|
|iamRole<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The IAM role name of the credentials set.|
|
|
15568
15585
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
@@ -15578,9 +15595,9 @@ Credentials set.
|
|
|
15578
15595
|
|
|
15579
15596
|
| Name | Type | Description |
|
|
15580
15597
|
| --- | --- | --- |
|
|
15581
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
15598
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials.|
|
|
15582
15599
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
15583
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
15600
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
15584
15601
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
15585
15602
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
15586
15603
|
|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).|
|
|
@@ -15602,7 +15619,7 @@ An accessor identity and it's associated permissions.
|
|
|
15602
15619
|
|
|
15603
15620
|
| Name | Type | Description |
|
|
15604
15621
|
| --- | --- | --- |
|
|
15605
|
-
|accessor<sup>*required</sup>|<a href="#identity"
|
|
15622
|
+
|accessor<sup>*required</sup>|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
15606
15623
|
|permissions<sup>*required</sup>|Array<"r" | "w">|The permissions associated with the accessor.|
|
|
15607
15624
|
|
|
15608
15625
|
### AccessorPermissionsList
|
|
@@ -15611,7 +15628,7 @@ All configured permissions of an object (excluding owner).
|
|
|
15611
15628
|
|
|
15612
15629
|
| Name | Type |
|
|
15613
15630
|
| --- | --- |
|
|
15614
|
-
|accessors|Array<<a href="#accessorpermissions">AccessorPermissions</a>>|
|
|
15631
|
+
|accessors|Array<<a href="#accessorpermissions" target="_blank" rel="noopener noreferrer">AccessorPermissions</a>>|
|
|
15615
15632
|
|
|
15616
15633
|
### ActiveGate
|
|
15617
15634
|
|
|
@@ -15619,10 +15636,10 @@ Parameters of the ActiveGate.
|
|
|
15619
15636
|
|
|
15620
15637
|
| Name | Type | Description |
|
|
15621
15638
|
| --- | --- | --- |
|
|
15622
|
-
|activeGateTokens|Array<<a href="#activegatetokeninfodto"
|
|
15623
|
-
|autoUpdateSettings|<a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a>|Auto-update configuration for an individual environment ActiveGate.|
|
|
15639
|
+
|activeGateTokens|Array<<a href="#activegatetokeninfodto">ActiveGateTokenInfoDto</a>>|A list of the ActiveGate tokens.|
|
|
15640
|
+
|autoUpdateSettings|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>|Auto-update configuration for an individual environment ActiveGate.|
|
|
15624
15641
|
|autoUpdateStatus|"UNKNOWN" | "INCOMPATIBLE" | "OUTDATED" | "SCHEDULED" | "SUPPRESSED" | "UP2DATE" | "UPDATE_IN_PROGRESS" | "UPDATE_PENDING" | "UPDATE_PROBLEM"|The current status of auto-updates of the ActiveGate.<br/><br/><strong>Example:</strong> <code>OUTDATED</code>|
|
|
15625
|
-
|connectedHosts|<a href="#activegateconnectedhosts"
|
|
15642
|
+
|connectedHosts|<a href="#activegateconnectedhosts">ActiveGateConnectedHosts</a>|Information about hosts currently connected to the ActiveGate|
|
|
15626
15643
|
|containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ActiveGate is deployed in container (<code>true</code>) or not (<code>false</code>).|
|
|
15627
15644
|
|environments|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of environments (specified by IDs) the ActiveGate can connect to.|
|
|
15628
15645
|
|fipsMode|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ActiveGate is running in FIPS compliant mode (<code>true</code>) or not (<code>false</code>).|
|
|
@@ -15631,7 +15648,7 @@ Parameters of the ActiveGate.
|
|
|
15631
15648
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate.<br/><br/><strong>Example:</strong> <code>0x3efdd091</code>|
|
|
15632
15649
|
|loadBalancerAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of Load Balancer addresses of the ActiveGate.|
|
|
15633
15650
|
|mainEnvironment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the main environment for a multi-environment ActiveGate.<br/><br/><strong>Example:</strong> <code>d1bf4a7e-666b-43af-9f45-718g98372e2f</code>|
|
|
15634
|
-
|modules|Array<<a href="#activegatemodule">ActiveGateModule</a>>|A list of modules of the ActiveGate.|
|
|
15651
|
+
|modules|Array<<a href="#activegatemodule" target="_blank" rel="noopener noreferrer">ActiveGateModule</a>>|A list of modules of the ActiveGate.|
|
|
15635
15652
|
|networkAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of network addresses of the ActiveGate.|
|
|
15636
15653
|
|networkZone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The network zone of the ActiveGate.<br/><br/><strong>Example:</strong> <code>exampleNetworkZone</code>|
|
|
15637
15654
|
|offlineSince|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp since when the ActiveGate is offline.</p> <p>The <code>null</code> value means the ActiveGate is online.</p> <br/><br/><strong>Example:</strong> <code>1582031917814</code>|
|
|
@@ -15650,7 +15667,7 @@ Auto-update configuration for an individual environment ActiveGate.
|
|
|
15650
15667
|
|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> <br/><br/><strong>Example:</strong> <code>ENABLED</code>|
|
|
15651
15668
|
|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> <br/><br/><strong>Example:</strong> <code>INHERITED</code>|
|
|
15652
15669
|
|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> <br/><br/><strong>Example:</strong> <code>latest</code>|
|
|
15653
|
-
|updateWindows|<a href="#updatewindowsconfig"
|
|
15670
|
+
|updateWindows|<a href="#updatewindowsconfig">UpdateWindowsConfig</a>|Basic information about all configured update windows|
|
|
15654
15671
|
|
|
15655
15672
|
### ActiveGateConnectedHosts
|
|
15656
15673
|
|
|
@@ -15667,9 +15684,9 @@ Global auto-update configuration for environment ActiveGates. Applies to all env
|
|
|
15667
15684
|
| Name | Type | Description |
|
|
15668
15685
|
| --- | --- | --- |
|
|
15669
15686
|
|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> |
|
|
15670
|
-
|metadata|<a href="#configurationmetadata">ConfigurationMetadata</a>|Metadata useful for debugging|
|
|
15687
|
+
|metadata|<a href="#configurationmetadata" target="_blank" rel="noopener noreferrer">ConfigurationMetadata</a>|Metadata useful for debugging|
|
|
15671
15688
|
|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> <br/><br/><strong>Example:</strong> <code>latest</code>|
|
|
15672
|
-
|updateWindows|<a href="#updatewindowsconfig"
|
|
15689
|
+
|updateWindows|<a href="#updatewindowsconfig">UpdateWindowsConfig</a>|Basic information about all configured update windows|
|
|
15673
15690
|
|
|
15674
15691
|
### ActiveGateGroup
|
|
15675
15692
|
|
|
@@ -15685,7 +15702,7 @@ Metadata for each ActiveGate group.
|
|
|
15685
15702
|
|
|
15686
15703
|
| Name | Type | Description |
|
|
15687
15704
|
| --- | --- | --- |
|
|
15688
|
-
|activeGates<sup>*required</sup>|Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>>|ActiveGates in group.|
|
|
15705
|
+
|activeGates<sup>*required</sup>|Array<<a href="#activegateinfodto" target="_blank" rel="noopener noreferrer">ActiveGateInfoDto</a>>|ActiveGates in group.|
|
|
15689
15706
|
|availableActiveGates<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of ActiveGates in group available for extension.|
|
|
15690
15707
|
|groupName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ActiveGate group name.|
|
|
15691
15708
|
|
|
@@ -15695,7 +15712,7 @@ The collection of ActiveGate groups.
|
|
|
15695
15712
|
|
|
15696
15713
|
| Name | Type | Description |
|
|
15697
15714
|
| --- | --- | --- |
|
|
15698
|
-
|groups|Array<<a href="#activegategroup"
|
|
15715
|
+
|groups|Array<<a href="#activegategroup">ActiveGateGroup</a>>|List of ActiveGate groups|
|
|
15699
15716
|
|
|
15700
15717
|
### ActiveGateGroupsInfoDto
|
|
15701
15718
|
|
|
@@ -15703,7 +15720,7 @@ ActiveGate groups metadata for extensions.
|
|
|
15703
15720
|
|
|
15704
15721
|
| Name | Type | Description |
|
|
15705
15722
|
| --- | --- | --- |
|
|
15706
|
-
|activeGateGroups<sup>*required</sup>|Array<<a href="#activegategroupinfodto">ActiveGateGroupInfoDto</a>>|Metadata for each ActiveGate group.|
|
|
15723
|
+
|activeGateGroups<sup>*required</sup>|Array<<a href="#activegategroupinfodto" target="_blank" rel="noopener noreferrer">ActiveGateGroupInfoDto</a>>|Metadata for each ActiveGate group.|
|
|
15707
15724
|
|
|
15708
15725
|
### ActiveGateInfoDto
|
|
15709
15726
|
|
|
@@ -15720,7 +15737,7 @@ A list of ActiveGates.
|
|
|
15720
15737
|
|
|
15721
15738
|
| Name | Type | Description |
|
|
15722
15739
|
| --- | --- | --- |
|
|
15723
|
-
|activeGates|Array<<a href="#activegate"
|
|
15740
|
+
|activeGates|Array<<a href="#activegate">ActiveGate</a>>|A list of ActiveGates.|
|
|
15724
15741
|
|
|
15725
15742
|
### ActiveGateModule
|
|
15726
15743
|
|
|
@@ -15728,7 +15745,7 @@ Information about ActiveGate module
|
|
|
15728
15745
|
|
|
15729
15746
|
| Name | Type | Description |
|
|
15730
15747
|
| --- | --- | --- |
|
|
15731
|
-
|attributes|<a href="#activegatemoduleattributes">ActiveGateModuleAttributes</a>|The attributes of the ActiveGate module.|
|
|
15748
|
+
|attributes|<a href="#activegatemoduleattributes" target="_blank" rel="noopener noreferrer">ActiveGateModuleAttributes</a>|The attributes of the ActiveGate module.|
|
|
15732
15749
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is enabled (<code>true</code>) or disabled (<code>false</code>).|
|
|
15733
15750
|
|misconfigured|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is misconfigured (<code>true</code>) or not (<code>false</code>).|
|
|
15734
15751
|
|type|"SYNTHETIC" | "AWS" | "AZURE" | "BEACON_FORWARDER" | "CLOUD_FOUNDRY" | "DB_INSIGHT" | "DEBUGGING" | "EXTENSIONS_V1" | "EXTENSIONS_V2" | "KUBERNETES" | "LOGS" | "MEMORY_DUMPS" | "METRIC_API" | "ONE_AGENT_ROUTING" | "OTLP_INGEST" | "REST_API" | "VMWARE" | "Z_OS"|The type of ActiveGate module.<br/><br/><strong>Example:</strong> <code>KUBERNETES</code>|
|
|
@@ -15783,7 +15800,7 @@ The status of ActiveGate tokens enforcement.
|
|
|
15783
15800
|
| Name | Type | Description |
|
|
15784
15801
|
| --- | --- | --- |
|
|
15785
15802
|
|autoEnforced|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, ActiveGate tokens are enforced automatically.|
|
|
15786
|
-
|autoEnforcementEstimation|<a href="#duration"
|
|
15803
|
+
|autoEnforcementEstimation|<a href="#duration">Duration</a>|Defines a period of time.|
|
|
15787
15804
|
|manualEnforced|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, ActiveGate tokens are manually enforced by user.|
|
|
15788
15805
|
|
|
15789
15806
|
### ActiveGateTokenInfoDto
|
|
@@ -15802,7 +15819,7 @@ A list of ActiveGate tokens.
|
|
|
15802
15819
|
|
|
15803
15820
|
| Name | Type | Description |
|
|
15804
15821
|
| --- | --- | --- |
|
|
15805
|
-
|activeGateTokens|Array<<a href="#activegatetoken">ActiveGateToken</a>>|A list of ActiveGate tokens.|
|
|
15822
|
+
|activeGateTokens|Array<<a href="#activegatetoken" target="_blank" rel="noopener noreferrer">ActiveGateToken</a>>|A list of ActiveGate tokens.|
|
|
15806
15823
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
15807
15824
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
15808
15825
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -15828,7 +15845,7 @@ A list of tags to be added to monitored entities.
|
|
|
15828
15845
|
|
|
15829
15846
|
| Name | Type | Description |
|
|
15830
15847
|
| --- | --- | --- |
|
|
15831
|
-
|tags<sup>*required</sup>|Array<<a href="#addentitytag"
|
|
15848
|
+
|tags<sup>*required</sup>|Array<<a href="#addentitytag">AddEntityTag</a>>|A list of tags to be added to monitored entities.|
|
|
15832
15849
|
|
|
15833
15850
|
### AddedEntityTags
|
|
15834
15851
|
|
|
@@ -15836,7 +15853,7 @@ A list of custom tags added to monitored entities.
|
|
|
15836
15853
|
|
|
15837
15854
|
| Name | Type | Description |
|
|
15838
15855
|
| --- | --- | --- |
|
|
15839
|
-
|appliedTags|Array<<a href="#metag">METag</a>>|A list of added custom tags.|
|
|
15856
|
+
|appliedTags|Array<<a href="#metag" target="_blank" rel="noopener noreferrer">METag</a>>|A list of added custom tags.|
|
|
15840
15857
|
|matchedEntitiesCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of monitored entities where the tags have been added.|
|
|
15841
15858
|
|
|
15842
15859
|
### AffectedEntities
|
|
@@ -15845,8 +15862,8 @@ Information about affected entities of an attack.
|
|
|
15845
15862
|
|
|
15846
15863
|
| Name | Type | Description |
|
|
15847
15864
|
| --- | --- | --- |
|
|
15848
|
-
|processGroup|<a href="#affectedentity"
|
|
15849
|
-
|processGroupInstance|<a href="#affectedentity">AffectedEntity</a>|Information about an affected entity.|
|
|
15865
|
+
|processGroup|<a href="#affectedentity">AffectedEntity</a>|Information about an affected entity.|
|
|
15866
|
+
|processGroupInstance|<a href="#affectedentity" target="_blank" rel="noopener noreferrer">AffectedEntity</a>|Information about an affected entity.|
|
|
15850
15867
|
|
|
15851
15868
|
### AffectedEntity
|
|
15852
15869
|
|
|
@@ -15871,7 +15888,7 @@ Aggregated log records.
|
|
|
15871
15888
|
|
|
15872
15889
|
| Name | Type | Description |
|
|
15873
15890
|
| --- | --- | --- |
|
|
15874
|
-
|aggregationResult|<a href="#aggregatedlogaggregationresult"
|
|
15891
|
+
|aggregationResult|<a href="#aggregatedlogaggregationresult">AggregatedLogAggregationResult</a>|Aggregated log records.|
|
|
15875
15892
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages.|
|
|
15876
15893
|
|
|
15877
15894
|
### AggregatedLogAggregationResult
|
|
@@ -15941,7 +15958,7 @@ A list of API tokens.
|
|
|
15941
15958
|
|
|
15942
15959
|
| Name | Type | Description |
|
|
15943
15960
|
| --- | --- | --- |
|
|
15944
|
-
|apiTokens|Array<<a href="#apitoken">ApiToken</a>>|A list of API tokens.|
|
|
15961
|
+
|apiTokens|Array<<a href="#apitoken" target="_blank" rel="noopener noreferrer">ApiToken</a>>|A list of API tokens.|
|
|
15945
15962
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
15946
15963
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
15947
15964
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -15970,7 +15987,7 @@ Analysis of problem impact to an application.
|
|
|
15970
15987
|
| --- | --- | --- |
|
|
15971
15988
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users.|
|
|
15972
15989
|
|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> |
|
|
15973
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
15990
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
15974
15991
|
|
|
15975
15992
|
### AppliedFilter
|
|
15976
15993
|
|
|
@@ -15979,7 +15996,7 @@ Optional filters that took effect.
|
|
|
15979
15996
|
| Name | Type | Description |
|
|
15980
15997
|
| --- | --- | --- |
|
|
15981
15998
|
|appliedTo<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The keys of all metrics that this filter has been applied to.</p> <p>Can contain multiple metrics for complex expressions and always at least one key.</p> |
|
|
15982
|
-
|filter|<a href="#filter">Filter</a>|A dimensional or series filter on a metric.|
|
|
15999
|
+
|filter|<a href="#filter" target="_blank" rel="noopener noreferrer">Filter</a>|A dimensional or series filter on a metric.|
|
|
15983
16000
|
|
|
15984
16001
|
### AssessmentAccuracyDetails
|
|
15985
16002
|
|
|
@@ -16004,7 +16021,7 @@ Metadata for an extension asset.
|
|
|
16004
16021
|
|
|
16005
16022
|
| Name | Type | Description |
|
|
16006
16023
|
| --- | --- | --- |
|
|
16007
|
-
|assetSchemaDetails|<a href="#assetschemadetailsdto"
|
|
16024
|
+
|assetSchemaDetails|<a href="#assetschemadetailsdto">AssetSchemaDetailsDto</a>|Settings schema details for asset|
|
|
16008
16025
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-friendly name of the asset.|
|
|
16009
16026
|
|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).|
|
|
16010
16027
|
|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.|
|
|
@@ -16025,21 +16042,21 @@ Describes an attack.
|
|
|
16025
16042
|
|
|
16026
16043
|
| Name | Type | Description |
|
|
16027
16044
|
| --- | --- | --- |
|
|
16028
|
-
|affectedEntities|<a href="#affectedentities">AffectedEntities</a>|Information about affected entities of an attack.|
|
|
16045
|
+
|affectedEntities|<a href="#affectedentities" target="_blank" rel="noopener noreferrer">AffectedEntities</a>|Information about affected entities of an attack.|
|
|
16029
16046
|
|attackId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the attack.|
|
|
16030
|
-
|attackTarget|<a href="#attacktarget"
|
|
16047
|
+
|attackTarget|<a href="#attacktarget">AttackTarget</a>|Information about the targeted host/database of an attack.|
|
|
16031
16048
|
|attackType|"COMMAND_INJECTION" | "JNDI_INJECTION" | "SQL_INJECTION" | "SSRF"|The type of the attack.|
|
|
16032
|
-
|attacker|<a href="#attacker">Attacker</a>|Attacker of an attack.|
|
|
16049
|
+
|attacker|<a href="#attacker" target="_blank" rel="noopener noreferrer">Attacker</a>|Attacker of an attack.|
|
|
16033
16050
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the attack.|
|
|
16034
16051
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the attack.|
|
|
16035
|
-
|entrypoint|<a href="#attackentrypoint"
|
|
16036
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to.|
|
|
16037
|
-
|request|<a href="#requestinformation"
|
|
16038
|
-
|securityProblem|<a href="#attacksecurityproblem">AttackSecurityProblem</a>|Assessment information and the ID of a security problem related to an attack.|
|
|
16052
|
+
|entrypoint|<a href="#attackentrypoint">AttackEntrypoint</a>|Describes the entrypoint used by an attacker to start a specific attack.|
|
|
16053
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to.|
|
|
16054
|
+
|request|<a href="#requestinformation">RequestInformation</a>|Describes the complete request information of an attack.|
|
|
16055
|
+
|securityProblem|<a href="#attacksecurityproblem" target="_blank" rel="noopener noreferrer">AttackSecurityProblem</a>|Assessment information and the ID of a security problem related to an attack.|
|
|
16039
16056
|
|state|"ALLOWLISTED" | "BLOCKED" | "EXPLOITED"|The state of the attack.|
|
|
16040
16057
|
|technology|"DOTNET" | "GO" | "JAVA" | "NODE_JS"|The technology of the attack.|
|
|
16041
16058
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the attack occurred.|
|
|
16042
|
-
|vulnerability|<a href="#vulnerability"
|
|
16059
|
+
|vulnerability|<a href="#vulnerability">Vulnerability</a>|Describes the exploited vulnerability.|
|
|
16043
16060
|
|
|
16044
16061
|
### AttackEntrypoint
|
|
16045
16062
|
|
|
@@ -16047,9 +16064,9 @@ Describes the entrypoint used by an attacker to start a specific attack.
|
|
|
16047
16064
|
|
|
16048
16065
|
| Name | Type | Description |
|
|
16049
16066
|
| --- | --- | --- |
|
|
16050
|
-
|codeLocation|<a href="#codelocation">CodeLocation</a>|Information about a code location.|
|
|
16051
|
-
|entrypointFunction|<a href="#functiondefinition"
|
|
16052
|
-
|payload|Array<<a href="#attackentrypointpayloaditem">AttackEntrypointPayloadItem</a>>|All relevant payload data that has been sent during the attack.|
|
|
16067
|
+
|codeLocation|<a href="#codelocation" target="_blank" rel="noopener noreferrer">CodeLocation</a>|Information about a code location.|
|
|
16068
|
+
|entrypointFunction|<a href="#functiondefinition">FunctionDefinition</a>|Information about a function definition.|
|
|
16069
|
+
|payload|Array<<a href="#attackentrypointpayloaditem" target="_blank" rel="noopener noreferrer">AttackEntrypointPayloadItem</a>>|All relevant payload data that has been sent during the attack.|
|
|
16053
16070
|
|
|
16054
16071
|
### AttackEntrypointPayloadItem
|
|
16055
16072
|
|
|
@@ -16057,8 +16074,8 @@ A list of values that has possibly been truncated.
|
|
|
16057
16074
|
|
|
16058
16075
|
| Name | Type | Description |
|
|
16059
16076
|
| --- | --- | --- |
|
|
16060
|
-
|truncationInfo|<a href="#truncationinfo"
|
|
16061
|
-
|values|Array<<a href="#entrypointpayload">EntrypointPayload</a>>|Values of the list.|
|
|
16077
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation.|
|
|
16078
|
+
|values|Array<<a href="#entrypointpayload" target="_blank" rel="noopener noreferrer">EntrypointPayload</a>>|Values of the list.|
|
|
16062
16079
|
|
|
16063
16080
|
### AttackList
|
|
16064
16081
|
|
|
@@ -16066,7 +16083,7 @@ A list of attacks.
|
|
|
16066
16083
|
|
|
16067
16084
|
| Name | Type | Description |
|
|
16068
16085
|
| --- | --- | --- |
|
|
16069
|
-
|attacks|Array<<a href="#attack"
|
|
16086
|
+
|attacks|Array<<a href="#attack">Attack</a>>|A list of attacks.|
|
|
16070
16087
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16071
16088
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16072
16089
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16086,7 +16103,7 @@ Assessment information and the ID of a security problem related to an attack.
|
|
|
16086
16103
|
|
|
16087
16104
|
| Name | Type | Description |
|
|
16088
16105
|
| --- | --- | --- |
|
|
16089
|
-
|assessment|<a href="#attacksecurityproblemassessmentdto">AttackSecurityProblemAssessmentDto</a>|The assessment of a security problem related to an attack.|
|
|
16106
|
+
|assessment|<a href="#attacksecurityproblemassessmentdto" target="_blank" rel="noopener noreferrer">AttackSecurityProblemAssessmentDto</a>|The assessment of a security problem related to an attack.|
|
|
16090
16107
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The security problem ID.|
|
|
16091
16108
|
|
|
16092
16109
|
### AttackSecurityProblemAssessmentDto
|
|
@@ -16114,7 +16131,7 @@ Attacker of an attack.
|
|
|
16114
16131
|
|
|
16115
16132
|
| Name | Type | Description |
|
|
16116
16133
|
| --- | --- | --- |
|
|
16117
|
-
|location|<a href="#attackerlocation"
|
|
16134
|
+
|location|<a href="#attackerlocation">AttackerLocation</a>|Location of an attacker.|
|
|
16118
16135
|
|sourceIp|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The source IP of the attacker.|
|
|
16119
16136
|
|
|
16120
16137
|
### AttackerLocation
|
|
@@ -16133,7 +16150,7 @@ The audit log of your environment.
|
|
|
16133
16150
|
|
|
16134
16151
|
| Name | Type | Description |
|
|
16135
16152
|
| --- | --- | --- |
|
|
16136
|
-
|auditLogs|Array<<a href="#auditlogentry">AuditLogEntry</a>>|A list of audit log entries ordered by the creation timestamp.|
|
|
16153
|
+
|auditLogs|Array<<a href="#auditlogentry" target="_blank" rel="noopener noreferrer">AuditLogEntry</a>>|A list of audit log entries ordered by the creation timestamp.|
|
|
16137
16154
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16138
16155
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16139
16156
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16192,9 +16209,9 @@ Indicates an entity that has been unavailable during the problem lifespan and th
|
|
|
16192
16209
|
| --- | --- | --- |
|
|
16193
16210
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
16194
16211
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds.|
|
|
16195
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
16212
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
16196
16213
|
|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> |
|
|
16197
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
16214
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
16198
16215
|
|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.|
|
|
16199
16216
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
16200
16217
|
|
|
@@ -16303,7 +16320,7 @@ Result received after ingesting business events.
|
|
|
16303
16320
|
|
|
16304
16321
|
| Name | Type | Description |
|
|
16305
16322
|
| --- | --- | --- |
|
|
16306
|
-
|errors|Array<<a href="#bizeventingesterror"
|
|
16323
|
+
|errors|Array<<a href="#bizeventingesterror">BizEventIngestError</a>>|A list of business events ingest errors.|
|
|
16307
16324
|
|
|
16308
16325
|
### BrowserPermissionsDto
|
|
16309
16326
|
|
|
@@ -16333,7 +16350,7 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
16333
16350
|
| Name | Type | Description |
|
|
16334
16351
|
| --- | --- | --- |
|
|
16335
16352
|
|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).|
|
|
16336
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
16353
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
16337
16354
|
|certificate<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the certificate file bytes encoded in Base64 without carriage return.|
|
|
16338
16355
|
|certificateFormat<sup>*required</sup>|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format. Use <code>PEM</code> for PEM certificates and <code>PKCS12</code> for PFX and P12 certificates.|
|
|
16339
16356
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
@@ -16352,7 +16369,7 @@ Chromium startup flags of a Browser Monitor.
|
|
|
16352
16369
|
| Name | Type | Description |
|
|
16353
16370
|
| --- | --- | --- |
|
|
16354
16371
|
|autoplay-policy|"no-user-gesture-required" | "document-user-activation-required"|autoplay-policy type.|
|
|
16355
|
-
|disable-features|<a href="#chromiumstartupflagsdtodisablefeatures"
|
|
16372
|
+
|disable-features|<a href="#chromiumstartupflagsdtodisablefeatures">ChromiumStartupFlagsDtoDisableFeatures</a>|disable-features map|
|
|
16356
16373
|
|disable-site-isolation-trials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-site-isolation-trials flag.|
|
|
16357
16374
|
|disable-web-security|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-web-security flag. If no value is passed, it will be set to false by default.|
|
|
16358
16375
|
|host-resolver-rules|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|host-resolver-rules.|
|
|
@@ -16407,7 +16424,7 @@ The details of a code-level vulnerability.
|
|
|
16407
16424
|
|type|"SQL_INJECTION" | "SSRF" | "CMD_INJECTION" | "IMPROPER_INPUT_VALIDATION"|The type of code level vulnerability.|
|
|
16408
16425
|
|vulnerabilityLocation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The code location of the vulnerability.|
|
|
16409
16426
|
|vulnerableFunction|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The vulnerable function of the vulnerability.|
|
|
16410
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability.|
|
|
16427
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability.|
|
|
16411
16428
|
|
|
16412
16429
|
### CodeLocation
|
|
16413
16430
|
|
|
@@ -16421,7 +16438,7 @@ Information about a code location.
|
|
|
16421
16438
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the code location.|
|
|
16422
16439
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the code location.|
|
|
16423
16440
|
|lineNumber|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The line number of the code location.|
|
|
16424
|
-
|parameterTypes|<a href="#truncatableliststring"
|
|
16441
|
+
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>|A list of values that has possibly been truncated.|
|
|
16425
16442
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function.|
|
|
16426
16443
|
|
|
16427
16444
|
### Comment
|
|
@@ -16449,7 +16466,7 @@ A list of comments.
|
|
|
16449
16466
|
|
|
16450
16467
|
| Name | Type | Description |
|
|
16451
16468
|
| --- | --- | --- |
|
|
16452
|
-
|comments<sup>*required</sup>|Array<<a href="#comment">Comment</a>>|The result entries.|
|
|
16469
|
+
|comments<sup>*required</sup>|Array<<a href="#comment" target="_blank" rel="noopener noreferrer">Comment</a>>|The result entries.|
|
|
16453
16470
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16454
16471
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16455
16472
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16525,7 +16542,7 @@ Information about images registry and components with URI.
|
|
|
16525
16542
|
|
|
16526
16543
|
| Name | Type | Description |
|
|
16527
16544
|
| --- | --- | --- |
|
|
16528
|
-
|components|Array<<a href="#containerimagecomponent"
|
|
16545
|
+
|components|Array<<a href="#containerimagecomponent">ContainerImageComponent</a>>|List of container image components.|
|
|
16529
16546
|
|registry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry name containing container images.|
|
|
16530
16547
|
|
|
16531
16548
|
### CookieStepDto
|
|
@@ -16534,7 +16551,7 @@ Cookie step of Browser Monitor.
|
|
|
16534
16551
|
|
|
16535
16552
|
| Name | Type | Description |
|
|
16536
16553
|
| --- | --- | --- |
|
|
16537
|
-
|cookies<sup>*required</sup>|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies.|
|
|
16554
|
+
|cookies<sup>*required</sup>|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies.|
|
|
16538
16555
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
16539
16556
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
16540
16557
|
|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> |
|
|
@@ -16566,7 +16583,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
16566
16583
|
| Name | Type | Description |
|
|
16567
16584
|
| --- | --- | --- |
|
|
16568
16585
|
|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).|
|
|
16569
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
16586
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
16570
16587
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
16571
16588
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
16572
16589
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
@@ -16583,9 +16600,9 @@ Details of certificate credentials set.
|
|
|
16583
16600
|
| --- | --- | --- |
|
|
16584
16601
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Base64 encoded certificate bytes|
|
|
16585
16602
|
|certificateType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Certificate type: PEM, PKCS12 or UNKNOWN|
|
|
16586
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials.|
|
|
16603
|
+
|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.|
|
|
16587
16604
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
16588
|
-
|externalVault|<a href="#externalvaultconfig"
|
|
16605
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16589
16606
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
16590
16607
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
16591
16608
|
|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).|
|
|
@@ -16601,7 +16618,7 @@ A list of detailed credentials sets for Synthetic monitors.
|
|
|
16601
16618
|
| Name | Type | Description |
|
|
16602
16619
|
| --- | --- | --- |
|
|
16603
16620
|
|allowPlaybackWithPrefilledCredentials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)||
|
|
16604
|
-
|credentials<sup>*required</sup>|Array<<a href="#abstractcredentialsresponseelement">AbstractCredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors.|
|
|
16621
|
+
|credentials<sup>*required</sup>|Array<<a href="#abstractcredentialsresponseelement" target="_blank" rel="noopener noreferrer">AbstractCredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors.|
|
|
16605
16622
|
|
|
16606
16623
|
### CredentialsDetailsTokenResponseElement
|
|
16607
16624
|
|
|
@@ -16609,9 +16626,9 @@ Details of the token credentials set.
|
|
|
16609
16626
|
|
|
16610
16627
|
| Name | Type | Description |
|
|
16611
16628
|
| --- | --- | --- |
|
|
16612
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16629
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials.|
|
|
16613
16630
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
16614
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16631
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16615
16632
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
16616
16633
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
16617
16634
|
|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).|
|
|
@@ -16626,9 +16643,9 @@ Details of username and password credentials set.
|
|
|
16626
16643
|
|
|
16627
16644
|
| Name | Type | Description |
|
|
16628
16645
|
| --- | --- | --- |
|
|
16629
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16646
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials.|
|
|
16630
16647
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
16631
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16648
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16632
16649
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
16633
16650
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
16634
16651
|
|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).|
|
|
@@ -16652,7 +16669,7 @@ A list of credentials sets for Synthetic monitors.
|
|
|
16652
16669
|
|
|
16653
16670
|
| Name | Type | Description |
|
|
16654
16671
|
| --- | --- | --- |
|
|
16655
|
-
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement"
|
|
16672
|
+
|credentials<sup>*required</sup>|Array<<a href="#credentialsresponseelement">CredentialsResponseElement</a>>|A list of credentials sets for Synthetic monitors.|
|
|
16656
16673
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)||
|
|
16657
16674
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
16658
16675
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
@@ -16664,10 +16681,10 @@ Metadata of the credentials set.
|
|
|
16664
16681
|
| Name | Type | Description |
|
|
16665
16682
|
| --- | --- | --- |
|
|
16666
16683
|
|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).|
|
|
16667
|
-
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
16668
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
16684
|
+
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
16685
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials.|
|
|
16669
16686
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
16670
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16687
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials.|
|
|
16671
16688
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
16672
16689
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
16673
16690
|
|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).|
|
|
@@ -16684,7 +16701,7 @@ Analysis of problem impact to a custom application.
|
|
|
16684
16701
|
| --- | --- | --- |
|
|
16685
16702
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users.|
|
|
16686
16703
|
|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> |
|
|
16687
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
16704
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
16688
16705
|
|
|
16689
16706
|
### CustomDeviceCreation
|
|
16690
16707
|
|
|
@@ -16700,7 +16717,7 @@ Configuration of a custom device.
|
|
|
16700
16717
|
|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> |
|
|
16701
16718
|
|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> |
|
|
16702
16719
|
|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> |
|
|
16703
|
-
|properties|<a href="#customdevicecreationproperties">CustomDeviceCreationProperties</a>|The list of key-value pair properties that will be shown beneath the infographics of your custom device.|
|
|
16720
|
+
|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.|
|
|
16704
16721
|
|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> |
|
|
16705
16722
|
|
|
16706
16723
|
### CustomDeviceCreationProperties
|
|
@@ -16724,7 +16741,7 @@ A list of custom tags.
|
|
|
16724
16741
|
|
|
16725
16742
|
| Name | Type | Description |
|
|
16726
16743
|
| --- | --- | --- |
|
|
16727
|
-
|tags<sup>*required</sup>|Array<<a href="#metag"
|
|
16744
|
+
|tags<sup>*required</sup>|Array<<a href="#metag">METag</a>>|A list of custom tags.|
|
|
16728
16745
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of tags in the response.|
|
|
16729
16746
|
|
|
16730
16747
|
### CustomLogLine
|
|
@@ -16848,7 +16865,7 @@ A list of advice from the Davis security advisor.
|
|
|
16848
16865
|
|
|
16849
16866
|
| Name | Type | Description |
|
|
16850
16867
|
| --- | --- | --- |
|
|
16851
|
-
|advices|Array<<a href="#davissecurityadvice">DavisSecurityAdvice</a>>||
|
|
16868
|
+
|advices|Array<<a href="#davissecurityadvice" target="_blank" rel="noopener noreferrer">DavisSecurityAdvice</a>>||
|
|
16852
16869
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16853
16870
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16854
16871
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16886,7 +16903,7 @@ Defines a period of time.
|
|
|
16886
16903
|
|
|
16887
16904
|
| Name | Type | Description |
|
|
16888
16905
|
| --- | --- | --- |
|
|
16889
|
-
|context|<a href="#permissioncontext"
|
|
16906
|
+
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data|
|
|
16890
16907
|
|granted<sup>*required</sup>|"condition" | "false" | "true"||
|
|
16891
16908
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<strong>Example:</strong> <code>settings:objects:write</code>|
|
|
16892
16909
|
|
|
@@ -16913,7 +16930,7 @@ A list of effective settings values.
|
|
|
16913
16930
|
|
|
16914
16931
|
| Name | Type | Description |
|
|
16915
16932
|
| --- | --- | --- |
|
|
16916
|
-
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue">EffectiveSettingsValue</a>>|A list of effective settings values.|
|
|
16933
|
+
|items<sup>*required</sup>|Array<<a href="#effectivesettingsvalue" target="_blank" rel="noopener noreferrer">EffectiveSettingsValue</a>>|A list of effective settings values.|
|
|
16917
16934
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16918
16935
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16919
16936
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16952,7 +16969,7 @@ A list of monitored entities along with their properties.
|
|
|
16952
16969
|
|
|
16953
16970
|
| Name | Type | Description |
|
|
16954
16971
|
| --- | --- | --- |
|
|
16955
|
-
|entities|Array<<a href="#entity"
|
|
16972
|
+
|entities|Array<<a href="#entity">Entity</a>>|A list of monitored entities.|
|
|
16956
16973
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
16957
16974
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
16958
16975
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -16966,13 +16983,13 @@ The properties of a monitored entity.
|
|
|
16966
16983
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the entity, displayed in the UI.|
|
|
16967
16984
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the entity.|
|
|
16968
16985
|
|firstSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was first seen, in UTC milliseconds.|
|
|
16969
|
-
|fromRelationships|<a href="#entityfromrelationships">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position.|
|
|
16970
|
-
|icon|<a href="#entityicon"
|
|
16986
|
+
|fromRelationships|<a href="#entityfromrelationships" target="_blank" rel="noopener noreferrer">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position.|
|
|
16987
|
+
|icon|<a href="#entityicon">EntityIcon</a>|The icon of a monitored entity.|
|
|
16971
16988
|
|lastSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was last seen, in UTC milliseconds.|
|
|
16972
|
-
|managementZones|Array<<a href="#enrichedmanagementzonedto">EnrichedManagementZoneDto</a>>|A set of management zones to which the entity belongs.|
|
|
16973
|
-
|properties|<a href="#entityproperties"
|
|
16974
|
-
|tags|Array<<a href="#enrichedtagdto">EnrichedTagDto</a>>|A set of tags assigned to the entity.|
|
|
16975
|
-
|toRelationships|<a href="#entitytorelationships"
|
|
16989
|
+
|managementZones|Array<<a href="#enrichedmanagementzonedto" target="_blank" rel="noopener noreferrer">EnrichedManagementZoneDto</a>>|A set of management zones to which the entity belongs.|
|
|
16990
|
+
|properties|<a href="#entityproperties">EntityProperties</a>|A list of additional properties of the entity.|
|
|
16991
|
+
|tags|Array<<a href="#enrichedtagdto" target="_blank" rel="noopener noreferrer">EnrichedTagDto</a>>|A set of tags assigned to the entity.|
|
|
16992
|
+
|toRelationships|<a href="#entitytorelationships">EntityToRelationships</a>|A list of relationships where the entity occupies the TO position.|
|
|
16976
16993
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the entity.|
|
|
16977
16994
|
|
|
16978
16995
|
### EntityFromRelationships
|
|
@@ -17022,7 +17039,7 @@ A short representation of a monitored entity.
|
|
|
17022
17039
|
|
|
17023
17040
|
| Name | Type | Description |
|
|
17024
17041
|
| --- | --- | --- |
|
|
17025
|
-
|entityId|<a href="#entityid">EntityId</a>|A short representation of a monitored entity.|
|
|
17042
|
+
|entityId|<a href="#entityid" target="_blank" rel="noopener noreferrer">EntityId</a>|A short representation of a monitored entity.|
|
|
17026
17043
|
|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> |
|
|
17027
17044
|
|
|
17028
17045
|
### EntityToRelationships
|
|
@@ -17040,11 +17057,11 @@ A list of properties of the monitored entity type.
|
|
|
17040
17057
|
|dimensionKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The dimension key used within metrics for this monitored entity.|
|
|
17041
17058
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the monitored entity.|
|
|
17042
17059
|
|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.|
|
|
17043
|
-
|fromRelationships|Array<<a href="#toposition"
|
|
17060
|
+
|fromRelationships|Array<<a href="#toposition">ToPosition</a>>|A list of possible relationships where the monitored entity type occupies the FROM position|
|
|
17044
17061
|
|managementZones|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of management zones of an actual entity.|
|
|
17045
|
-
|properties|Array<<a href="#entitytypepropertydto">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type.|
|
|
17062
|
+
|properties|Array<<a href="#entitytypepropertydto" target="_blank" rel="noopener noreferrer">EntityTypePropertyDto</a>>|A list of additional properties of the monitored entity type.|
|
|
17046
17063
|
|tags|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The placeholder for the list of tags of an actual entity.|
|
|
17047
|
-
|toRelationships|Array<<a href="#fromposition"
|
|
17064
|
+
|toRelationships|Array<<a href="#fromposition">FromPosition</a>>|A list of possible relationships where the monitored entity type occupies the TO position.|
|
|
17048
17065
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the monitored entity.|
|
|
17049
17066
|
|
|
17050
17067
|
### EntityTypeList
|
|
@@ -17056,7 +17073,7 @@ A list of properties of all available entity types.
|
|
|
17056
17073
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17057
17074
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17058
17075
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
17059
|
-
|types|Array<<a href="#entitytype">EntityType</a>>|The list of meta information for all available entity-types|
|
|
17076
|
+
|types|Array<<a href="#entitytype" target="_blank" rel="noopener noreferrer">EntityType</a>>|The list of meta information for all available entity-types|
|
|
17060
17077
|
|
|
17061
17078
|
### EntityTypePropertyDto
|
|
17062
17079
|
|
|
@@ -17075,7 +17092,7 @@ Information about an entry point of a code-level vulnerability.
|
|
|
17075
17092
|
| Name | Type | Description |
|
|
17076
17093
|
| --- | --- | --- |
|
|
17077
17094
|
|sourceHttpPath|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Source HTTP path of entry points.|
|
|
17078
|
-
|usageSegments|Array<<a href="#entrypointusagesegment"
|
|
17095
|
+
|usageSegments|Array<<a href="#entrypointusagesegment">EntryPointUsageSegment</a>>|List of entry point usage segments.|
|
|
17079
17096
|
|
|
17080
17097
|
### EntryPointUsageSegment
|
|
17081
17098
|
|
|
@@ -17094,7 +17111,7 @@ A list of entry points and a flag which indicates whether this list was truncate
|
|
|
17094
17111
|
|
|
17095
17112
|
| Name | Type | Description |
|
|
17096
17113
|
| --- | --- | --- |
|
|
17097
|
-
|items|Array<<a href="#entrypoint">EntryPoint</a>>|A list of entry points.|
|
|
17114
|
+
|items|Array<<a href="#entrypoint" target="_blank" rel="noopener noreferrer">EntryPoint</a>>|A list of entry points.|
|
|
17098
17115
|
|truncated|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates whether the list of entry points was truncated or not.|
|
|
17099
17116
|
|
|
17100
17117
|
### EntrypointPayload
|
|
@@ -17117,7 +17134,7 @@ Definition of an enum property.
|
|
|
17117
17134
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property.<br/><br/><strong>Example:</strong> <code>typeDisplayName</code>|
|
|
17118
17135
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation.<br/><br/><strong>Example:</strong> <code>typeDocumentation</code>|
|
|
17119
17136
|
|enumClass|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An existing Java enum class that holds the allowed values of the enum.<br/><br/><strong>Example:</strong> <code>enumClass</code>|
|
|
17120
|
-
|items<sup>*required</sup>|Array<<a href="#enumvalue"
|
|
17137
|
+
|items<sup>*required</sup>|Array<<a href="#enumvalue">EnumValue</a>>|A list of allowed values of the enum.|
|
|
17121
17138
|
|type<sup>*required</sup>|"enum"|The type of the property.<br/><br/><strong>Example:</strong> <code>enum</code>|
|
|
17122
17139
|
|
|
17123
17140
|
### EnumValue
|
|
@@ -17137,14 +17154,14 @@ An allowed value for an enum property.
|
|
|
17137
17154
|
| Name | Type | Description |
|
|
17138
17155
|
| --- | --- | --- |
|
|
17139
17156
|
|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code|
|
|
17140
|
-
|constraintViolations|Array<<a href="#constraintviolation">ConstraintViolation</a>>|A list of constraint violations|
|
|
17157
|
+
|constraintViolations|Array<<a href="#constraintviolation" target="_blank" rel="noopener noreferrer">ConstraintViolation</a>>|A list of constraint violations|
|
|
17141
17158
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message|
|
|
17142
17159
|
|
|
17143
17160
|
### ErrorEnvelope
|
|
17144
17161
|
|
|
17145
17162
|
| Name | Type |
|
|
17146
17163
|
| --- | --- |
|
|
17147
|
-
|error|<a href="#error"
|
|
17164
|
+
|error|<a href="#error">Error</a>|
|
|
17148
17165
|
|
|
17149
17166
|
### Event
|
|
17150
17167
|
|
|
@@ -17154,13 +17171,13 @@ Configuration of an event.
|
|
|
17154
17171
|
| --- | --- | --- |
|
|
17155
17172
|
|correlationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The correlation ID of the event.<br/><br/><strong>Example:</strong> <code>933613657e1c8fcf</code>|
|
|
17156
17173
|
|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> <br/><br/><strong>Example:</strong> <code>1564039524182</code>|
|
|
17157
|
-
|entityId|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17158
|
-
|entityTags|Array<<a href="#metag"
|
|
17174
|
+
|entityId|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
17175
|
+
|entityTags|Array<<a href="#metag">METag</a>>|A list of tags of the related entity.|
|
|
17159
17176
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event.<br/><br/><strong>Example:</strong> <code>4293884258445543163_1564039524182</code>|
|
|
17160
17177
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event.<br/><br/><strong>Example:</strong> <code>LOW_DISK_SPACE</code>|
|
|
17161
17178
|
|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> |
|
|
17162
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the event belongs to.|
|
|
17163
|
-
|properties|Array<<a href="#eventproperty"
|
|
17179
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of all management zones that the event belongs to.|
|
|
17180
|
+
|properties|Array<<a href="#eventproperty">EventProperty</a>>|A list of event properties.|
|
|
17164
17181
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event was raised, in UTC milliseconds.<br/><br/><strong>Example:</strong> <code>1564039524182</code>|
|
|
17165
17182
|
|status|"CLOSED" | "OPEN"|The status of the event.<br/><br/><strong>Example:</strong> <code>OPEN</code>|
|
|
17166
17183
|
|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> |
|
|
@@ -17176,14 +17193,14 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
17176
17193
|
|
|
17177
17194
|
| Name | Type | Description |
|
|
17178
17195
|
| --- | --- | --- |
|
|
17179
|
-
|data|<a href="#event">Event</a>|Configuration of an event.|
|
|
17196
|
+
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>|Configuration of an event.|
|
|
17180
17197
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
17181
17198
|
|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> |
|
|
17182
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
17199
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17183
17200
|
|eventId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event.|
|
|
17184
17201
|
|eventType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event.|
|
|
17185
17202
|
|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> |
|
|
17186
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17203
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
17187
17204
|
|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.|
|
|
17188
17205
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
17189
17206
|
|
|
@@ -17196,7 +17213,7 @@ The configuration of an event to be ingested.
|
|
|
17196
17213
|
|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> |
|
|
17197
17214
|
|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> |
|
|
17198
17215
|
|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.|
|
|
17199
|
-
|properties|<a href="#eventingestproperties"
|
|
17216
|
+
|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> |
|
|
17200
17217
|
|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> |
|
|
17201
17218
|
|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> |
|
|
17202
17219
|
|title<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the event.|
|
|
@@ -17230,7 +17247,7 @@ The results of an event ingest.
|
|
|
17230
17247
|
|
|
17231
17248
|
| Name | Type | Description |
|
|
17232
17249
|
| --- | --- | --- |
|
|
17233
|
-
|eventIngestResults|Array<<a href="#eventingestresult">EventIngestResult</a>>|The result of each created event report.|
|
|
17250
|
+
|eventIngestResults|Array<<a href="#eventingestresult" target="_blank" rel="noopener noreferrer">EventIngestResult</a>>|The result of each created event report.|
|
|
17234
17251
|
|reportCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of created event reports.|
|
|
17235
17252
|
|
|
17236
17253
|
### EventList
|
|
@@ -17239,7 +17256,7 @@ A list of events.
|
|
|
17239
17256
|
|
|
17240
17257
|
| Name | Type | Description |
|
|
17241
17258
|
| --- | --- | --- |
|
|
17242
|
-
|events|Array<<a href="#event"
|
|
17259
|
+
|events|Array<<a href="#event">Event</a>>|A list of events.|
|
|
17243
17260
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17244
17261
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17245
17262
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17251,7 +17268,7 @@ A list of event properties.
|
|
|
17251
17268
|
|
|
17252
17269
|
| Name | Type | Description |
|
|
17253
17270
|
| --- | --- | --- |
|
|
17254
|
-
|eventProperties|Array<<a href="#eventpropertydetails">EventPropertyDetails</a>>|A list of event properties.|
|
|
17271
|
+
|eventProperties|Array<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>>|A list of event properties.|
|
|
17255
17272
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17256
17273
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17257
17274
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17294,7 +17311,7 @@ A list of event types.
|
|
|
17294
17311
|
|
|
17295
17312
|
| Name | Type | Description |
|
|
17296
17313
|
| --- | --- | --- |
|
|
17297
|
-
|eventTypeInfos|Array<<a href="#eventtype"
|
|
17314
|
+
|eventTypeInfos|Array<<a href="#eventtype">EventType</a>>|A list of event types.|
|
|
17298
17315
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17299
17316
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17300
17317
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17308,9 +17325,9 @@ An evidence of a root cause.
|
|
|
17308
17325
|
| Name | Type | Description |
|
|
17309
17326
|
| --- | --- | --- |
|
|
17310
17327
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
17311
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17328
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
17312
17329
|
|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> |
|
|
17313
|
-
|groupingEntity|<a href="#entitystub"
|
|
17330
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17314
17331
|
|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.|
|
|
17315
17332
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
17316
17333
|
|
|
@@ -17320,14 +17337,14 @@ The evidence details of a problem.
|
|
|
17320
17337
|
|
|
17321
17338
|
| Name | Type | Description |
|
|
17322
17339
|
| --- | --- | --- |
|
|
17323
|
-
|details<sup>*required</sup>|Array<<a href="#evidence">Evidence</a>>|A list of all evidence.|
|
|
17340
|
+
|details<sup>*required</sup>|Array<<a href="#evidence" target="_blank" rel="noopener noreferrer">Evidence</a>>|A list of all evidence.|
|
|
17324
17341
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of evidence of a problem.|
|
|
17325
17342
|
|
|
17326
17343
|
### ExecuteActionsDto
|
|
17327
17344
|
|
|
17328
17345
|
| Name | Type | Description |
|
|
17329
17346
|
| --- | --- | --- |
|
|
17330
|
-
|actions|<a href="#executeactionsdtoactions"
|
|
17347
|
+
|actions|<a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a>|Data Source defined action objects|
|
|
17331
17348
|
|
|
17332
17349
|
### ExecuteActionsDtoActions
|
|
17333
17350
|
|
|
@@ -17351,7 +17368,7 @@ Contains extended monitor's execution details.
|
|
|
17351
17368
|
| --- | --- | --- |
|
|
17352
17369
|
|errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Error code.|
|
|
17353
17370
|
|executionStepCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number executed steps.|
|
|
17354
|
-
|executionSteps|Array<<a href="#executionstep">ExecutionStep</a>>|Details about the monitor's step execution.|
|
|
17371
|
+
|executionSteps|Array<<a href="#executionstep" target="_blank" rel="noopener noreferrer">ExecutionStep</a>>|Details about the monitor's step execution.|
|
|
17355
17372
|
|failedStepName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failed step name.|
|
|
17356
17373
|
|failedStepSequenceId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Failed step sequence id.|
|
|
17357
17374
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failure message.|
|
|
@@ -17400,7 +17417,7 @@ A list of exported log records.
|
|
|
17400
17417
|
| --- | --- | --- |
|
|
17401
17418
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17402
17419
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17403
|
-
|results|Array<<a href="#logrecord"
|
|
17420
|
+
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records.|
|
|
17404
17421
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
17405
17422
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages.|
|
|
17406
17423
|
|
|
@@ -17408,11 +17425,11 @@ A list of exported log records.
|
|
|
17408
17425
|
|
|
17409
17426
|
| Name | Type | Description |
|
|
17410
17427
|
| --- | --- | --- |
|
|
17411
|
-
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author|
|
|
17428
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author|
|
|
17412
17429
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data|
|
|
17413
17430
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name|
|
|
17414
17431
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets|
|
|
17415
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails"
|
|
17432
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails">ExtensionFeatureSetsDetails</a>|Details of feature sets|
|
|
17416
17433
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file|
|
|
17417
17434
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension|
|
|
17418
17435
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension|
|
|
@@ -17425,7 +17442,7 @@ List of assets imported with the active extension environment configuration.
|
|
|
17425
17442
|
|
|
17426
17443
|
| Name | Type | Description |
|
|
17427
17444
|
| --- | --- | --- |
|
|
17428
|
-
|assets<sup>*required</sup>|Array<<a href="#assetinfodto">AssetInfoDto</a>>|The list of the imported assets.|
|
|
17445
|
+
|assets<sup>*required</sup>|Array<<a href="#assetinfodto" target="_blank" rel="noopener noreferrer">AssetInfoDto</a>>|The list of the imported assets.|
|
|
17429
17446
|
|errors<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of errors during asset import|
|
|
17430
17447
|
|status<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The status of the assets list.|
|
|
17431
17448
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Version of the active extension environment configuration.<br/><br/><strong>Example:</strong> <code>1.2.3</code><br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
@@ -17457,7 +17474,7 @@ A list of extensions with additional metadata.
|
|
|
17457
17474
|
|
|
17458
17475
|
| Name | Type | Description |
|
|
17459
17476
|
| --- | --- | --- |
|
|
17460
|
-
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo"
|
|
17477
|
+
|extensions<sup>*required</sup>|Array<<a href="#extensioninfo">ExtensionInfo</a>>|A list of extensions with additional metadata.|
|
|
17461
17478
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17462
17479
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17463
17480
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17466,7 +17483,7 @@ A list of extensions with additional metadata.
|
|
|
17466
17483
|
|
|
17467
17484
|
| Name | Type | Description |
|
|
17468
17485
|
| --- | --- | --- |
|
|
17469
|
-
|extensions<sup>*required</sup>|Array<<a href="#minimalextension">MinimalExtension</a>>|A list of extensions.|
|
|
17486
|
+
|extensions<sup>*required</sup>|Array<<a href="#minimalextension" target="_blank" rel="noopener noreferrer">MinimalExtension</a>>|A list of extensions.|
|
|
17470
17487
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17471
17488
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17472
17489
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17483,7 +17500,7 @@ A list of extensions with additional metadata.
|
|
|
17483
17500
|
|
|
17484
17501
|
| Name | Type | Description |
|
|
17485
17502
|
| --- | --- | --- |
|
|
17486
|
-
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration"
|
|
17503
|
+
|items<sup>*required</sup>|Array<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>>|A list of extension monitoring configurations.|
|
|
17487
17504
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17488
17505
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17489
17506
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17507,12 +17524,12 @@ A list of extensions with additional metadata.
|
|
|
17507
17524
|
|
|
17508
17525
|
| Name | Type | Description |
|
|
17509
17526
|
| --- | --- | --- |
|
|
17510
|
-
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo">AssetInfo</a>>|Information about extension assets included|
|
|
17511
|
-
|author<sup>*required</sup>|<a href="#authordto"
|
|
17527
|
+
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo" target="_blank" rel="noopener noreferrer">AssetInfo</a>>|Information about extension assets included|
|
|
17528
|
+
|author<sup>*required</sup>|<a href="#authordto">AuthorDto</a>|Extension author|
|
|
17512
17529
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data|
|
|
17513
17530
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name|
|
|
17514
17531
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets|
|
|
17515
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets|
|
|
17532
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails" target="_blank" rel="noopener noreferrer">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets|
|
|
17516
17533
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file|
|
|
17517
17534
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension|
|
|
17518
17535
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension|
|
|
@@ -17561,7 +17578,7 @@ Additional information about a Feature Set
|
|
|
17561
17578
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional description for the feature set|
|
|
17562
17579
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional display name of the feature set|
|
|
17563
17580
|
|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)|
|
|
17564
|
-
|metrics|Array<<a href="#metricdto"
|
|
17581
|
+
|metrics|Array<<a href="#metricdto">MetricDto</a>>|Feature set metrics|
|
|
17565
17582
|
|
|
17566
17583
|
### Filter
|
|
17567
17584
|
|
|
@@ -17569,11 +17586,11 @@ A dimensional or series filter on a metric.
|
|
|
17569
17586
|
|
|
17570
17587
|
| Name | Type | Description |
|
|
17571
17588
|
| --- | --- | --- |
|
|
17572
|
-
|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.|
|
|
17573
|
-
|referenceInvocation|<a href="#invocation"
|
|
17589
|
+
|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.|
|
|
17590
|
+
|referenceInvocation|<a href="#invocation">Invocation</a>|Invocation of a function, e.g. the <code>entitySelector</code> function.|
|
|
17574
17591
|
|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.|
|
|
17575
17592
|
|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.|
|
|
17576
|
-
|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.|
|
|
17593
|
+
|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.|
|
|
17577
17594
|
|targetDimension|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If the type applies to a dimension, then holds the target dimension.|
|
|
17578
17595
|
|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.|
|
|
17579
17596
|
|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> |
|
|
@@ -17605,7 +17622,7 @@ Filtered requests of a Browser Monitor.
|
|
|
17605
17622
|
| Name | Type | Description |
|
|
17606
17623
|
| --- | --- | --- |
|
|
17607
17624
|
|mode<sup>*required</sup>|"BLOCK" | "ALLOW"|Filter mode for filtered requests.|
|
|
17608
|
-
|requests<sup>*required</sup>|Array<<a href="#requestfilterdto"
|
|
17625
|
+
|requests<sup>*required</sup>|Array<<a href="#requestfilterdto">RequestFilterDto</a>>|Requests to be filtered.|
|
|
17609
17626
|
|
|
17610
17627
|
### FrameworkOptionsDto
|
|
17611
17628
|
|
|
@@ -17641,7 +17658,7 @@ Information about a function definition.
|
|
|
17641
17658
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A human readable string representation of the function definition.|
|
|
17642
17659
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the function definition.|
|
|
17643
17660
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the function definition.|
|
|
17644
|
-
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>|A list of values that has possibly been truncated.|
|
|
17661
|
+
|parameterTypes|<a href="#truncatableliststring" target="_blank" rel="noopener noreferrer">TruncatableListString</a>|A list of values that has possibly been truncated.|
|
|
17645
17662
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function.|
|
|
17646
17663
|
|
|
17647
17664
|
### GlobalCountsDto
|
|
@@ -17745,8 +17762,8 @@ HTTP specific request details.
|
|
|
17745
17762
|
|
|
17746
17763
|
| Name | Type | Description |
|
|
17747
17764
|
| --- | --- | --- |
|
|
17748
|
-
|headers|<a href="#truncatablelistattackrequestheader"
|
|
17749
|
-
|parameters|<a href="#truncatablelisthttprequestparameter">TruncatableListHttpRequestParameter</a>|A list of values that has possibly been truncated.|
|
|
17765
|
+
|headers|<a href="#truncatablelistattackrequestheader">TruncatableListAttackRequestHeader</a>|A list of values that has possibly been truncated.|
|
|
17766
|
+
|parameters|<a href="#truncatablelisthttprequestparameter" target="_blank" rel="noopener noreferrer">TruncatableListHttpRequestParameter</a>|A list of values that has possibly been truncated.|
|
|
17750
17767
|
|requestMethod|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The HTTP request method.|
|
|
17751
17768
|
|
|
17752
17769
|
### HttpRequestParameter
|
|
@@ -17786,7 +17803,7 @@ The impact analysis of the problem on other entities/users.
|
|
|
17786
17803
|
| --- | --- | --- |
|
|
17787
17804
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users.|
|
|
17788
17805
|
|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> |
|
|
17789
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
17806
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
17790
17807
|
|
|
17791
17808
|
### ImpactAnalysis
|
|
17792
17809
|
|
|
@@ -17794,7 +17811,7 @@ A list of all impacts of the problem.
|
|
|
17794
17811
|
|
|
17795
17812
|
| Name | Type | Description |
|
|
17796
17813
|
| --- | --- | --- |
|
|
17797
|
-
|impacts<sup>*required</sup>|Array<<a href="#impact">Impact</a>>|A list of all impacts of the problem.|
|
|
17814
|
+
|impacts<sup>*required</sup>|Array<<a href="#impact" target="_blank" rel="noopener noreferrer">Impact</a>>|A list of all impacts of the problem.|
|
|
17798
17815
|
|
|
17799
17816
|
### InsertPosition
|
|
17800
17817
|
|
|
@@ -17813,10 +17830,10 @@ Interaction step of Browser Monitor.
|
|
|
17813
17830
|
|button<sup>*required</sup>|"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"|Integer containing the button index.|
|
|
17814
17831
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
17815
17832
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
17816
|
-
|target|<a href="#targetdto"
|
|
17833
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
17817
17834
|
|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> |
|
|
17818
|
-
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform.|
|
|
17819
|
-
|waitCondition|<a href="#basewaitconditiondto"
|
|
17835
|
+
|validationRules|Array<<a href="#validationruledto" target="_blank" rel="noopener noreferrer">ValidationRuleDto</a>>|List of validation rules for the step to perform.|
|
|
17836
|
+
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
17820
17837
|
|
|
17821
17838
|
### InvalidLine
|
|
17822
17839
|
|
|
@@ -17840,16 +17857,16 @@ An item of a collection property.
|
|
|
17840
17857
|
|
|
17841
17858
|
| Name | Type | Description |
|
|
17842
17859
|
| --- | --- | --- |
|
|
17843
|
-
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
17844
|
-
|datasource|<a href="#datasourcedefinition"
|
|
17860
|
+
|constraints|Array<<a href="#constraint" target="_blank" rel="noopener noreferrer">Constraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
17861
|
+
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property.|
|
|
17845
17862
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the item.<br/><br/><strong>Example:</strong> <code>itemDescription</code>|
|
|
17846
17863
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the item.<br/><br/><strong>Example:</strong> <code>itemDisplayName</code>|
|
|
17847
17864
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation.<br/><br/><strong>Example:</strong> <code>propertyDocumentation</code>|
|
|
17848
|
-
|metadata|<a href="#itemmetadata">ItemMetadata</a>|Metadata of the items.|
|
|
17865
|
+
|metadata|<a href="#itemmetadata" target="_blank" rel="noopener noreferrer">ItemMetadata</a>|Metadata of the items.|
|
|
17849
17866
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the item's value.<br/><br/><strong>Example:</strong> <code>itemReferencedType</code>|
|
|
17850
17867
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the item's value.<br/><br/><strong>Example:</strong> <code>itemSubType</code>|
|
|
17851
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer"
|
|
17852
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements|
|
|
17868
|
+
|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.|
|
|
17869
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements|
|
|
17853
17870
|
|
|
17854
17871
|
### ItemMetadata
|
|
17855
17872
|
|
|
@@ -17864,13 +17881,13 @@ Metadata of the items.
|
|
|
17864
17881
|
|agentVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17865
17882
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17866
17883
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
17867
|
-
|properties|<a href="#javaprocesscontainerproperties"
|
|
17884
|
+
|properties|<a href="#javaprocesscontainerproperties">JavaProcessContainerProperties</a>|
|
|
17868
17885
|
|
|
17869
17886
|
### JavaProcessContainerList
|
|
17870
17887
|
|
|
17871
17888
|
| Name | Type |
|
|
17872
17889
|
| --- | --- |
|
|
17873
|
-
|items<sup>*required</sup>|Array<<a href="#javaprocesscontainer">JavaProcessContainer</a>>|
|
|
17890
|
+
|items<sup>*required</sup>|Array<<a href="#javaprocesscontainer" target="_blank" rel="noopener noreferrer">JavaProcessContainer</a>>|
|
|
17874
17891
|
|
|
17875
17892
|
### JavaProcessContainerProperties
|
|
17876
17893
|
|
|
@@ -17886,10 +17903,10 @@ JavaScript Agent Settings.
|
|
|
17886
17903
|
|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.|
|
|
17887
17904
|
|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.|
|
|
17888
17905
|
|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.|
|
|
17889
|
-
|javaScriptFrameworkSupport|<a href="#frameworkoptionsdto"
|
|
17906
|
+
|javaScriptFrameworkSupport|<a href="#frameworkoptionsdto">FrameworkOptionsDto</a>|JS framework options of a JS Agent.|
|
|
17890
17907
|
|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.|
|
|
17891
|
-
|timeoutSettings|<a href="#timeoutsettingsdto">TimeoutSettingsDto</a>|Timeout settings of a Browser Monitor.|
|
|
17892
|
-
|visuallyCompleteOptions|<a href="#visuallycompleteoptionsdto"
|
|
17908
|
+
|timeoutSettings|<a href="#timeoutsettingsdto" target="_blank" rel="noopener noreferrer">TimeoutSettingsDto</a>|Timeout settings of a Browser Monitor.|
|
|
17909
|
+
|visuallyCompleteOptions|<a href="#visuallycompleteoptionsdto">VisuallyCompleteOptionsDto</a>|Visually Complete Options of a Browser Monitor.|
|
|
17893
17910
|
|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.|
|
|
17894
17911
|
|
|
17895
17912
|
### JavaScriptMappingFileDto
|
|
@@ -17909,7 +17926,7 @@ JavaScript Agent Settings.
|
|
|
17909
17926
|
|
|
17910
17927
|
| Name | Type | Description |
|
|
17911
17928
|
| --- | --- | --- |
|
|
17912
|
-
|jsMappingFiles|Array<<a href="#javascriptmappingfiledto">JavaScriptMappingFileDto</a>>|A list of JavaScript mapping files.|
|
|
17929
|
+
|jsMappingFiles|Array<<a href="#javascriptmappingfiledto" target="_blank" rel="noopener noreferrer">JavaScriptMappingFileDto</a>>|A list of JavaScript mapping files.|
|
|
17913
17930
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
17914
17931
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
17915
17932
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -17929,9 +17946,9 @@ JavaScript step of Browser Monitor.
|
|
|
17929
17946
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
17930
17947
|
|javaScript<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing a script in JavaScript.|
|
|
17931
17948
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
17932
|
-
|target|<a href="#targetdto"
|
|
17949
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
17933
17950
|
|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> |
|
|
17934
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
17951
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
17935
17952
|
|
|
17936
17953
|
### KeyPerformanceMetrics
|
|
17937
17954
|
|
|
@@ -17949,14 +17966,14 @@ Key strokes step of Browser Monitor.
|
|
|
17949
17966
|
| Name | Type | Description |
|
|
17950
17967
|
| --- | --- | --- |
|
|
17951
17968
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
17952
|
-
|input<sup>*required</sup>|<a href="#keystrokesinputdto"
|
|
17969
|
+
|input<sup>*required</sup>|<a href="#keystrokesinputdto">KeystrokesInputDto</a>|Key strokes step input.|
|
|
17953
17970
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
17954
17971
|
|simulateBlurEvent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if blur event should be simulated.|
|
|
17955
17972
|
|simulateReturnKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if return key should be simulated.|
|
|
17956
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
17973
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step.|
|
|
17957
17974
|
|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> |
|
|
17958
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
17959
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
17975
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform.|
|
|
17976
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
17960
17977
|
|
|
17961
17978
|
### KeystrokesInputDto
|
|
17962
17979
|
|
|
@@ -18007,7 +18024,7 @@ Results of the execution HTTP monitor's requests at a given location
|
|
|
18007
18024
|
| --- | --- | --- |
|
|
18008
18025
|
|executionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Execution id.|
|
|
18009
18026
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location id.|
|
|
18010
|
-
|requestResults|Array<<a href="#monitorrequestexecutionresult"
|
|
18027
|
+
|requestResults|Array<<a href="#monitorrequestexecutionresult">MonitorRequestExecutionResult</a>>|The list of the monitor's request results executed on this location.|
|
|
18011
18028
|
|
|
18012
18029
|
### LocatorDto
|
|
18013
18030
|
|
|
@@ -18024,7 +18041,7 @@ A single log record.
|
|
|
18024
18041
|
|
|
18025
18042
|
| Name | Type | Description |
|
|
18026
18043
|
| --- | --- | --- |
|
|
18027
|
-
|additionalColumns|<a href="#logrecordadditionalcolumns">LogRecordAdditionalColumns</a>|Additional columns of the log record.|
|
|
18044
|
+
|additionalColumns|<a href="#logrecordadditionalcolumns" target="_blank" rel="noopener noreferrer">LogRecordAdditionalColumns</a>|Additional columns of the log record.|
|
|
18028
18045
|
|content|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The content of the log record.|
|
|
18029
18046
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Type of event|
|
|
18030
18047
|
|status|"ERROR" | "INFO" | "NONE" | "NOT_APPLICABLE" | "WARN"|The log status (based on the log level).|
|
|
@@ -18043,7 +18060,7 @@ A list of retrieved log records.
|
|
|
18043
18060
|
| Name | Type | Description |
|
|
18044
18061
|
| --- | --- | --- |
|
|
18045
18062
|
|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>.|
|
|
18046
|
-
|results|Array<<a href="#logrecord"
|
|
18063
|
+
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records.|
|
|
18047
18064
|
|sliceSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of records in a slice.|
|
|
18048
18065
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages.|
|
|
18049
18066
|
|
|
@@ -18068,9 +18085,9 @@ The maintenance window during which the problem occurred.
|
|
|
18068
18085
|
| --- | --- | --- |
|
|
18069
18086
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
18070
18087
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds.|
|
|
18071
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18088
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
18072
18089
|
|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> |
|
|
18073
|
-
|groupingEntity|<a href="#entitystub"
|
|
18090
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18074
18091
|
|maintenanceWindowConfigId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the related maintenance window.|
|
|
18075
18092
|
|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.|
|
|
18076
18093
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
@@ -18100,7 +18117,7 @@ A list of metrics and their data points.
|
|
|
18100
18117
|
| --- | --- | --- |
|
|
18101
18118
|
|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>.|
|
|
18102
18119
|
|resolution<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The timeslot resolution in the result.|
|
|
18103
|
-
|result<sup>*required</sup>|Array<<a href="#metricseriescollection">MetricSeriesCollection</a>>|A list of metrics and their data points.|
|
|
18120
|
+
|result<sup>*required</sup>|Array<<a href="#metricseriescollection" target="_blank" rel="noopener noreferrer">MetricSeriesCollection</a>>|A list of metrics and their data points.|
|
|
18104
18121
|
|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> |
|
|
18105
18122
|
|warnings<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of warnings|
|
|
18106
18123
|
|
|
@@ -18123,10 +18140,10 @@ The descriptor of a metric.
|
|
|
18123
18140
|
|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> |
|
|
18124
18141
|
|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> |
|
|
18125
18142
|
|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> |
|
|
18126
|
-
|defaultAggregation|<a href="#metricdefaultaggregation"
|
|
18143
|
+
|defaultAggregation|<a href="#metricdefaultaggregation">MetricDefaultAggregation</a>|The default aggregation of a metric.|
|
|
18127
18144
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the metric.|
|
|
18128
|
-
|dimensionCardinalities|Array<<a href="#metricdimensioncardinality">MetricDimensionCardinality</a>>|The cardinalities of MINT metric dimensions.|
|
|
18129
|
-
|dimensionDefinitions|Array<<a href="#metricdimensiondefinition"
|
|
18145
|
+
|dimensionCardinalities|Array<<a href="#metricdimensioncardinality" target="_blank" rel="noopener noreferrer">MetricDimensionCardinality</a>>|The cardinalities of MINT metric dimensions.|
|
|
18146
|
+
|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> |
|
|
18130
18147
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the metric in the user interface.|
|
|
18131
18148
|
|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>.|
|
|
18132
18149
|
|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> |
|
|
@@ -18135,13 +18152,13 @@ The descriptor of a metric.
|
|
|
18135
18152
|
|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> |
|
|
18136
18153
|
|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> |
|
|
18137
18154
|
|metricSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The metric selector that is used when querying a func: metric.|
|
|
18138
|
-
|metricValueType|<a href="#metricvaluetype">MetricValueType</a>|The value type for the metric.|
|
|
18155
|
+
|metricValueType|<a href="#metricvaluetype" target="_blank" rel="noopener noreferrer">MetricValueType</a>|The value type for the metric.|
|
|
18139
18156
|
|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> |
|
|
18140
18157
|
|resolutionInfSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If 'true', resolution=Inf can be applied to the metric query.|
|
|
18141
18158
|
|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> |
|
|
18142
18159
|
|scalar|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Indicates whether the metric expression resolves to a scalar (<code>true</code>) or to a series (<code>false</code>). A scalar result always contains one data point. The amount of data points in a series result depends on the resolution you're using.</p> |
|
|
18143
18160
|
|tags|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The tags applied to 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> |
|
|
18144
|
-
|transformations|Array<"asGauge" | "default" | "delta" | "evaluateModel" | "filter" | "fold" | "histogram" | "last" | "lastReal" | "limit" | "merge" | "names" | "parents" | "partition" | "rate" | "rollup" | "setUnit" | "smooth" | "sort" | "splitBy" | "timeshift" | "toUnit">|Transform operators that could be appended to the current transformation list.|
|
|
18161
|
+
|transformations|Array<"asGauge" | "asHistogram" | "default" | "delta" | "evaluateModel" | "filter" | "fold" | "histogram" | "last" | "lastReal" | "limit" | "merge" | "names" | "parents" | "partition" | "rate" | "rollup" | "setUnit" | "smooth" | "sort" | "splitBy" | "timeshift" | "toUnit">|Transform operators that could be appended to the current transformation list.|
|
|
18145
18162
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric.|
|
|
18146
18163
|
|unitDisplayFormat|"binary" | "decimal"|<p>The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:</p> <p>Binary: 1 MiB = 1024 KiB = 1,048,576 bytes</p> <p>Decimal: 1 MB = 1000 kB = 1,000,000 bytes</p> <p>If not set, the decimal system is used.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
18147
18164
|
|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.|
|
|
@@ -18152,7 +18169,7 @@ A list of metrics along with their descriptors.
|
|
|
18152
18169
|
|
|
18153
18170
|
| Name | Type | Description |
|
|
18154
18171
|
| --- | --- | --- |
|
|
18155
|
-
|metrics<sup>*required</sup>|Array<<a href="#metricdescriptor"
|
|
18172
|
+
|metrics<sup>*required</sup>|Array<<a href="#metricdescriptor">MetricDescriptor</a>>|A list of metric along with their descriptors|
|
|
18156
18173
|
|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> |
|
|
18157
18174
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of metrics in the result.|
|
|
18158
18175
|
|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.|
|
|
@@ -18186,7 +18203,7 @@ Metric gathered by an extension
|
|
|
18186
18203
|
| Name | Type | Description |
|
|
18187
18204
|
| --- | --- | --- |
|
|
18188
18205
|
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Metric key|
|
|
18189
|
-
|metadata|<a href="#metricmetadatadto">MetricMetadataDto</a>|Metric metadata|
|
|
18206
|
+
|metadata|<a href="#metricmetadatadto" target="_blank" rel="noopener noreferrer">MetricMetadataDto</a>|Metric metadata|
|
|
18190
18207
|
|
|
18191
18208
|
### MetricEvidence
|
|
18192
18209
|
|
|
@@ -18198,9 +18215,9 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
18198
18215
|
| --- | --- | --- |
|
|
18199
18216
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
18200
18217
|
|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> |
|
|
18201
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
18218
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18202
18219
|
|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> |
|
|
18203
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18220
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
18204
18221
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the metric.|
|
|
18205
18222
|
|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.|
|
|
18206
18223
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
@@ -18213,7 +18230,7 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
18213
18230
|
| Name | Type |
|
|
18214
18231
|
| --- | --- |
|
|
18215
18232
|
|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
18216
|
-
|invalidLines|Array<<a href="#invalidline"
|
|
18233
|
+
|invalidLines|Array<<a href="#invalidline">InvalidLine</a>>|
|
|
18217
18234
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
18218
18235
|
|
|
18219
18236
|
### MetricMetadataDto
|
|
@@ -18244,7 +18261,7 @@ The data is represented by two arrays of the same length: **timestamps** and **v
|
|
|
18244
18261
|
|
|
18245
18262
|
| Name | Type | Description |
|
|
18246
18263
|
| --- | --- | --- |
|
|
18247
|
-
|dimensionMap<sup>*required</sup>|<a href="#metricseriesdimensionmap">MetricSeriesDimensionMap</a>||
|
|
18264
|
+
|dimensionMap<sup>*required</sup>|<a href="#metricseriesdimensionmap" target="_blank" rel="noopener noreferrer">MetricSeriesDimensionMap</a>||
|
|
18248
18265
|
|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> |
|
|
18249
18266
|
|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> |
|
|
18250
18267
|
|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> |
|
|
@@ -18255,11 +18272,11 @@ Data points of a metric.
|
|
|
18255
18272
|
|
|
18256
18273
|
| Name | Type | Description |
|
|
18257
18274
|
| --- | --- | --- |
|
|
18258
|
-
|appliedOptionalFilters|Array<<a href="#appliedfilter"
|
|
18259
|
-
|data<sup>*required</sup>|Array<<a href="#metricseries">MetricSeries</a>>|Data points of the metric.|
|
|
18275
|
+
|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.|
|
|
18276
|
+
|data<sup>*required</sup>|Array<<a href="#metricseries" target="_blank" rel="noopener noreferrer">MetricSeries</a>>|Data points of the metric.|
|
|
18260
18277
|
|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.|
|
|
18261
18278
|
|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.|
|
|
18262
|
-
|dql|<a href="#metricquerydqltranslation"
|
|
18279
|
+
|dql|<a href="#metricquerydqltranslation">MetricQueryDQLTranslation</a>|Metric query translation to DQL.|
|
|
18263
18280
|
|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> |
|
|
18264
18281
|
|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.|
|
|
18265
18282
|
|
|
@@ -18292,7 +18309,7 @@ Analysis of problem impact to a mobile application.
|
|
|
18292
18309
|
| --- | --- | --- |
|
|
18293
18310
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users.|
|
|
18294
18311
|
|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> |
|
|
18295
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18312
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
18296
18313
|
|
|
18297
18314
|
### Modification
|
|
18298
18315
|
|
|
@@ -18334,7 +18351,7 @@ Results of the execution of all HTTP monitor's requests.
|
|
|
18334
18351
|
|
|
18335
18352
|
| Name | Type | Description |
|
|
18336
18353
|
| --- | --- | --- |
|
|
18337
|
-
|locationsExecutionResults|Array<<a href="#locationexecutionresults"
|
|
18354
|
+
|locationsExecutionResults|Array<<a href="#locationexecutionresults">LocationExecutionResults</a>>|The list with the results of the requests executed on assigned locations.|
|
|
18338
18355
|
|monitorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor id.|
|
|
18339
18356
|
|
|
18340
18357
|
### MonitorPropertyDto
|
|
@@ -18353,7 +18370,7 @@ A result of the execution HTTP monitor's request.
|
|
|
18353
18370
|
| Name | Type | Description |
|
|
18354
18371
|
| --- | --- | --- |
|
|
18355
18372
|
|cloudPlatform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Cloud platform of the location.|
|
|
18356
|
-
|customLogs|Array<<a href="#customlogline">CustomLogLine</a>>|Custom log messages.|
|
|
18373
|
+
|customLogs|Array<<a href="#customlogline" target="_blank" rel="noopener noreferrer">CustomLogLine</a>>|Custom log messages.|
|
|
18357
18374
|
|engineId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|VUC's id on which monitor's request was executed.|
|
|
18358
18375
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's failure message.|
|
|
18359
18376
|
|healthStatus|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's health status.|
|
|
@@ -18367,13 +18384,13 @@ A result of the execution HTTP monitor's request.
|
|
|
18367
18384
|
|redirectionTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total number of milliseconds spent on handling all redirect requests, measured in ms.|
|
|
18368
18385
|
|redirectsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request's redirects.|
|
|
18369
18386
|
|requestBody|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's request body.|
|
|
18370
|
-
|requestHeaders|Array<<a href="#monitorrequestheader"
|
|
18387
|
+
|requestHeaders|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|A list of request's headers|
|
|
18371
18388
|
|requestId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request id.|
|
|
18372
18389
|
|requestName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request name.|
|
|
18373
18390
|
|resolvedIps|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Request's resolved ips.'|
|
|
18374
18391
|
|responseBody|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's response body.|
|
|
18375
18392
|
|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.|
|
|
18376
|
-
|responseHeaders|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|A list of request's response headers|
|
|
18393
|
+
|responseHeaders|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|A list of request's response headers|
|
|
18377
18394
|
|responseMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's response message.'|
|
|
18378
18395
|
|responseSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request's response size in bytes.|
|
|
18379
18396
|
|responseStatusCode|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request's response status code.|
|
|
@@ -18411,7 +18428,7 @@ Monitoring state of the process group instance.
|
|
|
18411
18428
|
| Name | Type | Description |
|
|
18412
18429
|
| --- | --- | --- |
|
|
18413
18430
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the process group instance.|
|
|
18414
|
-
|params|Array<<a href="#monitoredentitystateparam"
|
|
18431
|
+
|params|Array<<a href="#monitoredentitystateparam">MonitoredEntityStateParam</a>>|Additional parameters of the monitoring state.|
|
|
18415
18432
|
|severity|"deep_monitoring_ok" | "info" | "ok" | "warning"|The type of the monitoring state.|
|
|
18416
18433
|
|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.|
|
|
18417
18434
|
|
|
@@ -18421,7 +18438,7 @@ A list of process group instances and their monitoring states.
|
|
|
18421
18438
|
|
|
18422
18439
|
| Name | Type | Description |
|
|
18423
18440
|
| --- | --- | --- |
|
|
18424
|
-
|monitoringStates|Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>>|A list of process group instances and their monitoring states.|
|
|
18441
|
+
|monitoringStates|Array<<a href="#monitoredentitystates" target="_blank" rel="noopener noreferrer">MonitoredEntityStates</a>>|A list of process group instances and their monitoring states.|
|
|
18425
18442
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
18426
18443
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
18427
18444
|
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of unique process group instances in the response.|
|
|
@@ -18462,14 +18479,14 @@ Step of Browser Monitor that navigates to a website.
|
|
|
18462
18479
|
|
|
18463
18480
|
| Name | Type | Description |
|
|
18464
18481
|
| --- | --- | --- |
|
|
18465
|
-
|authentication|<a href="#authenticationdto"
|
|
18482
|
+
|authentication|<a href="#authenticationdto">AuthenticationDto</a>|Authentication dto for Browser Monitor step.|
|
|
18466
18483
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
18467
18484
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
18468
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
18485
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step.|
|
|
18469
18486
|
|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> |
|
|
18470
18487
|
|url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Field containing the url that the monitor should navigate to.|
|
|
18471
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
18472
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
18488
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform.|
|
|
18489
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
18473
18490
|
|
|
18474
18491
|
### NetworkThrottlingDto
|
|
18475
18492
|
|
|
@@ -18516,7 +18533,7 @@ A list of network zones.
|
|
|
18516
18533
|
|
|
18517
18534
|
| Name | Type | Description |
|
|
18518
18535
|
| --- | --- | --- |
|
|
18519
|
-
|networkZones<sup>*required</sup>|Array<<a href="#networkzone"
|
|
18536
|
+
|networkZones<sup>*required</sup>|Array<<a href="#networkzone">NetworkZone</a>>|A list of network zones.|
|
|
18520
18537
|
|
|
18521
18538
|
### NetworkZoneSettings
|
|
18522
18539
|
|
|
@@ -18576,7 +18593,7 @@ A list of synthetic nodes
|
|
|
18576
18593
|
|
|
18577
18594
|
| Name | Type | Description |
|
|
18578
18595
|
| --- | --- | --- |
|
|
18579
|
-
|nodes<sup>*required</sup>|Array<<a href="#nodecollectionelement">NodeCollectionElement</a>>|A list of synthetic nodes|
|
|
18596
|
+
|nodes<sup>*required</sup>|Array<<a href="#nodecollectionelement" target="_blank" rel="noopener noreferrer">NodeCollectionElement</a>>|A list of synthetic nodes|
|
|
18580
18597
|
|
|
18581
18598
|
### ObjectsList
|
|
18582
18599
|
|
|
@@ -18584,7 +18601,7 @@ A list of settings objects.
|
|
|
18584
18601
|
|
|
18585
18602
|
| Name | Type | Description |
|
|
18586
18603
|
| --- | --- | --- |
|
|
18587
|
-
|items<sup>*required</sup>|Array<<a href="#settingsobject"
|
|
18604
|
+
|items<sup>*required</sup>|Array<<a href="#settingsobject">SettingsObject</a>>|A list of settings objects.|
|
|
18588
18605
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
18589
18606
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
18590
18607
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -18630,8 +18647,8 @@ A precondition for visibility of a property.
|
|
|
18630
18647
|
|expectedValue|AnyValue|<p>The expected value of the property.</p> <p>Only applicable to properties of the <code>EQUALS</code> type.</p> <br/><br/><strong>Example:</strong> <code>expectedValue</code>|
|
|
18631
18648
|
|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> <br/><br/><strong>Example:</strong> <code>expectedValues</code>|
|
|
18632
18649
|
|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> <br/><br/><strong>Example:</strong> <code>example Regex</code>|
|
|
18633
|
-
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property.|
|
|
18634
|
-
|preconditions|Array<<a href="#precondition"
|
|
18650
|
+
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property.|
|
|
18651
|
+
|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> |
|
|
18635
18652
|
|property|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The property to be evaluated.<br/><br/><strong>Example:</strong> <code>propertyToEvaluate</code>|
|
|
18636
18653
|
|type<sup>*required</sup>|"EQUALS" | "AND" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"|The type of the precondition.<br/><br/><strong>Example:</strong> <code>NULL</code>|
|
|
18637
18654
|
|
|
@@ -18662,9 +18679,9 @@ Configuration of a private synthetic location.
|
|
|
18662
18679
|
|minActiveGateCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).<br/><br/><strong>Minimum:</strong> <code>1</code>|
|
|
18663
18680
|
|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> |
|
|
18664
18681
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location.|
|
|
18665
|
-
|nodeNames|<a href="#privatesyntheticlocationnodenames">PrivateSyntheticLocationNodeNames</a>|A mapping id to name of the nodes belonging to the location.|
|
|
18682
|
+
|nodeNames|<a href="#privatesyntheticlocationnodenames" target="_blank" rel="noopener noreferrer">PrivateSyntheticLocationNodeNames</a>|A mapping id to name of the nodes belonging to the location.|
|
|
18666
18683
|
|nodeSize|"UNSUPPORTED" | "M" | "S" | "XS"|<p>Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:</p> <ul> <li><code>XS</code>: extra small</li> <li><code>S</code>: small</li> <li><code>M</code>: medium The node size <code>L</code> is not supported in containerized locations.</li> </ul> |
|
|
18667
|
-
|nodes
|
|
18684
|
+
|nodes|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> |
|
|
18668
18685
|
|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> |
|
|
18669
18686
|
|regionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The region name of the location.|
|
|
18670
18687
|
|status|"ENABLED" | "DISABLED" | "HIDDEN"|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
@@ -18683,23 +18700,23 @@ The properties of a problem.
|
|
|
18683
18700
|
|
|
18684
18701
|
| Name | Type | Description |
|
|
18685
18702
|
| --- | --- | --- |
|
|
18686
|
-
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub"
|
|
18703
|
+
|affectedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are affected by the problem.|
|
|
18687
18704
|
|displayId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the problem.|
|
|
18688
18705
|
|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> |
|
|
18689
|
-
|entityTags|Array<<a href="#metag">METag</a>>|A list of all entity tags of the problem.|
|
|
18690
|
-
|evidenceDetails|<a href="#evidencedetails"
|
|
18691
|
-
|impactAnalysis|<a href="#impactanalysis">ImpactAnalysis</a>|A list of all impacts of the problem.|
|
|
18706
|
+
|entityTags|Array<<a href="#metag" target="_blank" rel="noopener noreferrer">METag</a>>|A list of all entity tags of the problem.|
|
|
18707
|
+
|evidenceDetails|<a href="#evidencedetails">EvidenceDetails</a>|The evidence details of a problem.|
|
|
18708
|
+
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>|A list of all impacts of the problem.|
|
|
18692
18709
|
|impactLevel<sup>*required</sup>|"ENVIRONMENT" | "APPLICATION" | "INFRASTRUCTURE" | "SERVICES"|The impact level of the problem. It shows what is affected by the problem.|
|
|
18693
|
-
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub"
|
|
18710
|
+
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are impacted by the problem.|
|
|
18694
18711
|
|k8s.cluster.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster names.|
|
|
18695
18712
|
|k8s.cluster.uid|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster UIDs.|
|
|
18696
18713
|
|k8s.namespace.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes namespace names.|
|
|
18697
|
-
|linkedProblemInfo|<a href="#linkedproblem">LinkedProblem</a>|The properties of the linked problem.|
|
|
18698
|
-
|managementZones<sup>*required</sup>|Array<<a href="#managementzone"
|
|
18699
|
-
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub">AlertingProfileStub</a>>|A list of alerting profiles that match the problem.|
|
|
18714
|
+
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>|The properties of the linked problem.|
|
|
18715
|
+
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to.|
|
|
18716
|
+
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub" target="_blank" rel="noopener noreferrer">AlertingProfileStub</a>>|A list of alerting profiles that match the problem.|
|
|
18700
18717
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem.|
|
|
18701
|
-
|recentComments|<a href="#commentslist"
|
|
18702
|
-
|rootCauseEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
18718
|
+
|recentComments|<a href="#commentslist">CommentsList</a>|A list of comments.|
|
|
18719
|
+
|rootCauseEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
18703
18720
|
|severityLevel<sup>*required</sup>|"CUSTOM_ALERT" | "AVAILABILITY" | "ERROR" | "INFO" | "MONITORING_UNAVAILABLE" | "PERFORMANCE" | "RESOURCE_CONTENTION"|The severity of the problem.|
|
|
18704
18721
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start timestamp of the problem, in UTC milliseconds.|
|
|
18705
18722
|
|status<sup>*required</sup>|"CLOSED" | "OPEN"|The status of the problem.|
|
|
@@ -18719,7 +18736,7 @@ The result of closing a problem.
|
|
|
18719
18736
|
| --- | --- | --- |
|
|
18720
18737
|
|closeTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the user triggered the closing.|
|
|
18721
18738
|
|closing<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True, if the problem is being closed.|
|
|
18722
|
-
|comment|<a href="#comment"
|
|
18739
|
+
|comment|<a href="#comment">Comment</a>|The comment to a problem.|
|
|
18723
18740
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem.|
|
|
18724
18741
|
|
|
18725
18742
|
### Problems
|
|
@@ -18730,7 +18747,7 @@ A list of problems.
|
|
|
18730
18747
|
| --- | --- | --- |
|
|
18731
18748
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
18732
18749
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
18733
|
-
|problems<sup>*required</sup>|Array<<a href="#problem">Problem</a>>|The result entries.|
|
|
18750
|
+
|problems<sup>*required</sup>|Array<<a href="#problem" target="_blank" rel="noopener noreferrer">Problem</a>>|The result entries.|
|
|
18734
18751
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
18735
18752
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of warnings|
|
|
18736
18753
|
|
|
@@ -18740,9 +18757,9 @@ The vulnerable functions of a process group including their usage.
|
|
|
18740
18757
|
|
|
18741
18758
|
| Name | Type | Description |
|
|
18742
18759
|
| --- | --- | --- |
|
|
18743
|
-
|functionsInUse|Array<<a href="#vulnerablefunction"
|
|
18744
|
-
|functionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions with unknown state.|
|
|
18745
|
-
|functionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
18760
|
+
|functionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions in use.|
|
|
18761
|
+
|functionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions with unknown state.|
|
|
18762
|
+
|functionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions not in use.|
|
|
18746
18763
|
|processGroup|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The process group identifier.|
|
|
18747
18764
|
|
|
18748
18765
|
### PropertyDefinition
|
|
@@ -18751,25 +18768,25 @@ Configuration of a property in a settings schema.
|
|
|
18751
18768
|
|
|
18752
18769
|
| Name | Type | Description |
|
|
18753
18770
|
| --- | --- | --- |
|
|
18754
|
-
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
18755
|
-
|datasource|<a href="#datasourcedefinition"
|
|
18771
|
+
|constraints|Array<<a href="#constraint" target="_blank" rel="noopener noreferrer">Constraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
18772
|
+
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property.|
|
|
18756
18773
|
|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> <br/><br/><strong>Example:</strong> <code>propertyDefaultValue</code>|
|
|
18757
18774
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property.<br/><br/><strong>Example:</strong> <code>propertyDescription</code>|
|
|
18758
18775
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property.<br/><br/><strong>Example:</strong> <code>propertyDisplayName</code>|
|
|
18759
18776
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation.<br/><br/><strong>Example:</strong> <code>propertyDocumentation</code>|
|
|
18760
18777
|
|forceSecretResubmission|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if value is allowed to be modified when secret properties are not<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18761
|
-
|items|<a href="#item">Item</a>|An item of a collection property.|
|
|
18778
|
+
|items|<a href="#item" target="_blank" rel="noopener noreferrer">Item</a>|An item of a collection property.|
|
|
18762
18779
|
|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> |
|
|
18763
|
-
|metadata|<a href="#propertydefinitionmetadata"
|
|
18780
|
+
|metadata|<a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>|Metadata of the property.|
|
|
18764
18781
|
|migrationPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Pattern with references to properties to create a new value.|
|
|
18765
18782
|
|minObjects|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of <strong>objects</strong> in a collection property.<br/><br/><strong>Example:</strong> <code>1</code>|
|
|
18766
18783
|
|modificationPolicy|"DEFAULT" | "ALWAYS" | "NEVER"|Modification policy of the property.<br/><br/><strong>Example:</strong> <code>ALWAYS</code>|
|
|
18767
18784
|
|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>.<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18768
|
-
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property.|
|
|
18785
|
+
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property.|
|
|
18769
18786
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the property value<br/><br/><strong>Example:</strong> <code>propertyReferencedType</code>|
|
|
18770
18787
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the property's value.<br/><br/><strong>Example:</strong> <code>propertySubType</code>|
|
|
18771
|
-
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer"
|
|
18772
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements|
|
|
18788
|
+
|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.|
|
|
18789
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements|
|
|
18773
18790
|
|
|
18774
18791
|
### PropertyDefinitionMetadata
|
|
18775
18792
|
|
|
@@ -18783,7 +18800,7 @@ Details that are specific to the used protocol.
|
|
|
18783
18800
|
|
|
18784
18801
|
| Name | Type | Description |
|
|
18785
18802
|
| --- | --- | --- |
|
|
18786
|
-
|http|<a href="#httpprotocoldetails"
|
|
18803
|
+
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|HTTP specific request details.|
|
|
18787
18804
|
|
|
18788
18805
|
### ProxyDto
|
|
18789
18806
|
|
|
@@ -18800,7 +18817,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
18800
18817
|
| Name | Type | Description |
|
|
18801
18818
|
| --- | --- | --- |
|
|
18802
18819
|
|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).|
|
|
18803
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
18820
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
18804
18821
|
|certificate<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The certificate in the string format.|
|
|
18805
18822
|
|certificateFormat<sup>*required</sup>|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format.|
|
|
18806
18823
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
@@ -18856,14 +18873,14 @@ A list of React Native mapping files.
|
|
|
18856
18873
|
|bundleName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the bundle.|
|
|
18857
18874
|
|bundleVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the bundle.|
|
|
18858
18875
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the mapping file.|
|
|
18859
|
-
|metadata|<a href="#reactnativemappingfilemetadatadto"
|
|
18876
|
+
|metadata|<a href="#reactnativemappingfilemetadatadto">ReactNativeMappingFileMetadataDto</a>||
|
|
18860
18877
|
|platform|"ANDROID" | "IOS"|The platform (operating system) the mapping file belongs to.|
|
|
18861
18878
|
|
|
18862
18879
|
### ReactNativeMappingFileListDto
|
|
18863
18880
|
|
|
18864
18881
|
| Name | Type | Description |
|
|
18865
18882
|
| --- | --- | --- |
|
|
18866
|
-
|mappingFiles|Array<<a href="#reactnativemappingfiledto">ReactNativeMappingFileDto</a>>|A list of React Native mapping files.|
|
|
18883
|
+
|mappingFiles|Array<<a href="#reactnativemappingfiledto" target="_blank" rel="noopener noreferrer">ReactNativeMappingFileDto</a>>|A list of React Native mapping files.|
|
|
18867
18884
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
18868
18885
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
18869
18886
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -18924,7 +18941,7 @@ A list of related container images.
|
|
|
18924
18941
|
|
|
18925
18942
|
| Name | Type | Description |
|
|
18926
18943
|
| --- | --- | --- |
|
|
18927
|
-
|containerImages|Array<<a href="#relatedcontainerimage"
|
|
18944
|
+
|containerImages|Array<<a href="#relatedcontainerimage">RelatedContainerImage</a>>|A list of related container images.|
|
|
18928
18945
|
|
|
18929
18946
|
### RelatedEntitiesList
|
|
18930
18947
|
|
|
@@ -18936,12 +18953,12 @@ Each related entity contains a list of corresponding affected entities (for exam
|
|
|
18936
18953
|
|
|
18937
18954
|
| Name | Type | Description |
|
|
18938
18955
|
| --- | --- | --- |
|
|
18939
|
-
|applications|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related applications.|
|
|
18956
|
+
|applications|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related applications.|
|
|
18940
18957
|
|databases|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of related databases.|
|
|
18941
|
-
|hosts|Array<<a href="#relatedentity"
|
|
18942
|
-
|kubernetesClusters|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes clusters.|
|
|
18943
|
-
|kubernetesWorkloads|Array<<a href="#relatedentity"
|
|
18944
|
-
|services|Array<<a href="#relatedservice">RelatedService</a>>|A list of related services.|
|
|
18958
|
+
|hosts|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related hosts.|
|
|
18959
|
+
|kubernetesClusters|Array<<a href="#relatedentity" target="_blank" rel="noopener noreferrer">RelatedEntity</a>>|A list of related Kubernetes clusters.|
|
|
18960
|
+
|kubernetesWorkloads|Array<<a href="#relatedentity">RelatedEntity</a>>|A list of related Kubernetes workloads.|
|
|
18961
|
+
|services|Array<<a href="#relatedservice" target="_blank" rel="noopener noreferrer">RelatedService</a>>|A list of related services.|
|
|
18945
18962
|
|
|
18946
18963
|
### RelatedEntity
|
|
18947
18964
|
|
|
@@ -18977,7 +18994,7 @@ The tuple <name, product, stage, version> is always unique.
|
|
|
18977
18994
|
| --- | --- | --- |
|
|
18978
18995
|
|affectedByProblems|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more problems<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18979
18996
|
|affectedBySecurityVulnerabilities|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The entity has one or more security vulnerabilities<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18980
|
-
|instances|Array<<a href="#releaseinstance"
|
|
18997
|
+
|instances|Array<<a href="#releaseinstance">ReleaseInstance</a>>|The instances entityIds included in this release<br/><br/><strong>Example:</strong> <code>["PROCESS_GROUP_INSTANCE-49D94B90FB71C45B","PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"]</code>|
|
|
18981
18998
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity name<br/><br/><strong>Example:</strong> <code>cluster</code>|
|
|
18982
18999
|
|problemCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of problems of the entity<br/><br/><strong>Example:</strong> <code>4</code><br/><strong>Minimum:</strong> <code>0</code>|
|
|
18983
19000
|
|product|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The product name<br/><br/><strong>Example:</strong> <code>Sockshop</code>|
|
|
@@ -18985,7 +19002,7 @@ The tuple <name, product, stage, version> is always unique.
|
|
|
18985
19002
|
|running|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The related PGI is still running/monitored<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18986
19003
|
|securityVulnerabilitiesCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of security vulnerabilities of the entity<br/><br/><strong>Example:</strong> <code>4</code><br/><strong>Minimum:</strong> <code>0</code>|
|
|
18987
19004
|
|securityVulnerabilitiesEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates that the security vulnerabilities feature is enabled<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
18988
|
-
|softwareTechs|Array<<a href="#softwaretechs">SoftwareTechs</a>>|The software technologies of the release<br/><br/><strong>Example:</strong> <code>[\{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]</code>|
|
|
19005
|
+
|softwareTechs|Array<<a href="#softwaretechs" target="_blank" rel="noopener noreferrer">SoftwareTechs</a>>|The software technologies of the release<br/><br/><strong>Example:</strong> <code>[\{"edition":"OpenJDK","technology":"JAVA","verbatimType":"Java","version":"1.8.0_242"}]</code>|
|
|
18989
19006
|
|stage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The stage name<br/><br/><strong>Example:</strong> <code>staging</code>|
|
|
18990
19007
|
|throughput|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The count of bytes per second of the entity<br/><br/><strong>Example:</strong> <code>923234</code><br/><strong>Minimum:</strong> <code>0</code>|
|
|
18991
19008
|
|version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identified release version<br/><br/><strong>Example:</strong> <code>1.195.34.12341232423-012342</code>|
|
|
@@ -19010,7 +19027,7 @@ A list of releases.
|
|
|
19010
19027
|
| --- | --- | --- |
|
|
19011
19028
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
19012
19029
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
19013
|
-
|releases|Array<<a href="#release"
|
|
19030
|
+
|releases|Array<<a href="#release">Release</a>>|A list of releases.|
|
|
19014
19031
|
|releasesWithProblems|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of releases with problems.|
|
|
19015
19032
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
19016
19033
|
|
|
@@ -19021,15 +19038,15 @@ Assessment of the remediation item.
|
|
|
19021
19038
|
| Name | Type | Description |
|
|
19022
19039
|
| --- | --- | --- |
|
|
19023
19040
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment.|
|
|
19024
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details.|
|
|
19041
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details.|
|
|
19025
19042
|
|dataAssets|"NOT_AVAILABLE" | "NOT_DETECTED" | "REACHABLE"|The reachability of related data assets by affected entities.|
|
|
19026
19043
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities.|
|
|
19027
19044
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets.|
|
|
19028
19045
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data.|
|
|
19029
19046
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions|
|
|
19030
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction"
|
|
19031
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available.|
|
|
19032
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
19047
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use.|
|
|
19048
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not available.|
|
|
19049
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use.|
|
|
19033
19050
|
|
|
19034
19051
|
### RemediationDetailsItem
|
|
19035
19052
|
|
|
@@ -19037,17 +19054,17 @@ Detailed information of a remediation item for a security problem.
|
|
|
19037
19054
|
|
|
19038
19055
|
| Name | Type | Description |
|
|
19039
19056
|
| --- | --- | --- |
|
|
19040
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item.|
|
|
19057
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>|Assessment of the remediation item.|
|
|
19041
19058
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>||
|
|
19042
19059
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
19043
19060
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)||
|
|
19044
|
-
|muteState|<a href="#remediationitemmutestate"
|
|
19061
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem.|
|
|
19045
19062
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)||
|
|
19046
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities.|
|
|
19063
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities.|
|
|
19047
19064
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
19048
|
-
|trackingLink|<a href="#trackinglink"
|
|
19065
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem.|
|
|
19049
19066
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"||
|
|
19050
|
-
|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> |
|
|
19067
|
+
|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> |
|
|
19051
19068
|
|
|
19052
19069
|
### RemediationItem
|
|
19053
19070
|
|
|
@@ -19055,17 +19072,17 @@ A possible remediation for a security problem.
|
|
|
19055
19072
|
|
|
19056
19073
|
| Name | Type | Description |
|
|
19057
19074
|
| --- | --- | --- |
|
|
19058
|
-
|assessment|<a href="#remediationassessment"
|
|
19075
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item.|
|
|
19059
19076
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>||
|
|
19060
19077
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
19061
19078
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)||
|
|
19062
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem.|
|
|
19079
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem.|
|
|
19063
19080
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)||
|
|
19064
|
-
|remediationProgress|<a href="#remediationprogress"
|
|
19081
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities.|
|
|
19065
19082
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)||
|
|
19066
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem.|
|
|
19083
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem.|
|
|
19067
19084
|
|vulnerabilityState|"RESOLVED" | "VULNERABLE"||
|
|
19068
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent"
|
|
19085
|
+
|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> |
|
|
19069
19086
|
|
|
19070
19087
|
### RemediationItemDetailsVulnerableComponent
|
|
19071
19088
|
|
|
@@ -19087,7 +19104,7 @@ A list of remediation items.
|
|
|
19087
19104
|
|
|
19088
19105
|
| Name | Type | Description |
|
|
19089
19106
|
| --- | --- | --- |
|
|
19090
|
-
|remediationItems|Array<<a href="#remediationitem">RemediationItem</a>>|A list of remediation items.|
|
|
19107
|
+
|remediationItems|Array<<a href="#remediationitem" target="_blank" rel="noopener noreferrer">RemediationItem</a>>|A list of remediation items.|
|
|
19091
19108
|
|
|
19092
19109
|
### RemediationItemMuteState
|
|
19093
19110
|
|
|
@@ -19137,7 +19154,7 @@ Response of muting several remediation items.
|
|
|
19137
19154
|
|
|
19138
19155
|
| Name | Type | Description |
|
|
19139
19156
|
| --- | --- | --- |
|
|
19140
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary"
|
|
19157
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were muted and which already were muted previously.|
|
|
19141
19158
|
|
|
19142
19159
|
### RemediationItemsBulkUnmute
|
|
19143
19160
|
|
|
@@ -19155,7 +19172,7 @@ Response of un-muting several remediation items.
|
|
|
19155
19172
|
|
|
19156
19173
|
| Name | Type | Description |
|
|
19157
19174
|
| --- | --- | --- |
|
|
19158
|
-
|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.|
|
|
19175
|
+
|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.|
|
|
19159
19176
|
|
|
19160
19177
|
### RemediationItemsBulkUpdateDeleteDto
|
|
19161
19178
|
|
|
@@ -19164,7 +19181,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
19164
19181
|
| Name | Type | Description |
|
|
19165
19182
|
| --- | --- | --- |
|
|
19166
19183
|
|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> |
|
|
19167
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates"
|
|
19184
|
+
|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> |
|
|
19168
19185
|
|
|
19169
19186
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
19170
19187
|
|
|
@@ -19191,12 +19208,12 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
19191
19208
|
|
|
19192
19209
|
| Name | Type | Description |
|
|
19193
19210
|
| --- | --- | --- |
|
|
19194
|
-
|assessment|<a href="#remediationprogressentityassessment">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity.|
|
|
19211
|
+
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity.|
|
|
19195
19212
|
|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.|
|
|
19196
19213
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity.|
|
|
19197
19214
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity.|
|
|
19198
19215
|
|state|"AFFECTED" | "UNAFFECTED"|The current state of the remediation progress entity.|
|
|
19199
|
-
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent"
|
|
19216
|
+
|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> |
|
|
19200
19217
|
|
|
19201
19218
|
### RemediationProgressEntityAssessment
|
|
19202
19219
|
|
|
@@ -19206,9 +19223,9 @@ Assessment of the remediation progress entity.
|
|
|
19206
19223
|
| --- | --- | --- |
|
|
19207
19224
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data.|
|
|
19208
19225
|
|vulnerableFunctionUsage|"NOT_AVAILABLE" | "IN_USE" | "NOT_IN_USE"|The usage of vulnerable functions|
|
|
19209
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use.|
|
|
19210
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
19211
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use.|
|
|
19226
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are in use.|
|
|
19227
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available.|
|
|
19228
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not in use.|
|
|
19212
19229
|
|
|
19213
19230
|
### RemediationProgressEntityList
|
|
19214
19231
|
|
|
@@ -19216,7 +19233,7 @@ A list of remediation progress entities.
|
|
|
19216
19233
|
|
|
19217
19234
|
| Name | Type | Description |
|
|
19218
19235
|
| --- | --- | --- |
|
|
19219
|
-
|remediationProgressEntities|Array<<a href="#remediationprogressentity"
|
|
19236
|
+
|remediationProgressEntities|Array<<a href="#remediationprogressentity">RemediationProgressEntity</a>>|A list of remediation progress entities.|
|
|
19220
19237
|
|
|
19221
19238
|
### RemediationProgressVulnerableComponent
|
|
19222
19239
|
|
|
@@ -19247,10 +19264,10 @@ Remote configuration management job.
|
|
|
19247
19264
|
| --- | --- | --- |
|
|
19248
19265
|
|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.<br/><br/><strong>Example:</strong> <code>2020-11-05T08:15:30.144Z</code>|
|
|
19249
19266
|
|entityType|"ACTIVE_GATE" | "ONE_AGENT"|Type of entities modified by remote configuration management.<br/><br/><strong>Example:</strong> <code>ACTIVE_GATE or ONE_AGENT</code>|
|
|
19250
|
-
|failedEntities|Array<<a href="#remoteidentityoperationfailedentitydto">RemoteIdentityOperationFailedEntityDto</a>>|A list of failed remote configuration management jobs.|
|
|
19267
|
+
|failedEntities|Array<<a href="#remoteidentityoperationfailedentitydto" target="_blank" rel="noopener noreferrer">RemoteIdentityOperationFailedEntityDto</a>>|A list of failed remote configuration management jobs.|
|
|
19251
19268
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remote configuration management job.<br/><br/><strong>Example:</strong> <code>7974003406714390819</code>|
|
|
19252
19269
|
|inProgressEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of in-progress remote configuration management jobs.<br/><br/><strong>Example:</strong> <code>["HOST-D454A967666E7970"]</code>|
|
|
19253
|
-
|operations|Array<<a href="#remoteconfigurationmanagementoperation"
|
|
19270
|
+
|operations|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of executed (successful and failed) remote configuration management jobs.|
|
|
19254
19271
|
|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.<br/><br/><strong>Example:</strong> <code>1</code>|
|
|
19255
19272
|
|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.<br/><br/><strong>Example:</strong> <code>2020-11-05T08:15:30.144Z</code>|
|
|
19256
19273
|
|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.<br/><br/><strong>Example:</strong> <code>2020-11-05T08:15:30.144Z</code>|
|
|
@@ -19262,7 +19279,7 @@ A list of remote configuration management jobs.
|
|
|
19262
19279
|
|
|
19263
19280
|
| Name | Type | Description |
|
|
19264
19281
|
| --- | --- | --- |
|
|
19265
|
-
|jobs|Array<<a href="#remoteconfigurationmanagementjobsummary">RemoteConfigurationManagementJobSummary</a>>|A list of remote configuration management jobs.|
|
|
19282
|
+
|jobs|Array<<a href="#remoteconfigurationmanagementjobsummary" target="_blank" rel="noopener noreferrer">RemoteConfigurationManagementJobSummary</a>>|A list of remote configuration management jobs.|
|
|
19266
19283
|
|
|
19267
19284
|
### RemoteConfigurationManagementJobPreview
|
|
19268
19285
|
|
|
@@ -19304,7 +19321,7 @@ Remote configuration management operation creation request.
|
|
|
19304
19321
|
| Name | Type | Description |
|
|
19305
19322
|
| --- | --- | --- |
|
|
19306
19323
|
|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.<br/><br/><strong>Example:</strong> <code>["0x2b7c0b02","0x4928065d"]</code>|
|
|
19307
|
-
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation"
|
|
19324
|
+
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of remote configuration management operations to be executed.|
|
|
19308
19325
|
|
|
19309
19326
|
### RemoteConfigurationManagementOperationOneAgentRequest
|
|
19310
19327
|
|
|
@@ -19313,7 +19330,7 @@ Remote configuration management operation creation request.
|
|
|
19313
19330
|
| Name | Type | Description |
|
|
19314
19331
|
| --- | --- | --- |
|
|
19315
19332
|
|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.<br/><br/><strong>Example:</strong> <code>["HOST-D454A967666E7970","HOST-811760CFF2A5E872"]</code>|
|
|
19316
|
-
|operations<sup>*required</sup>|Array<<a href="#remoteconfigurationmanagementoperation">RemoteConfigurationManagementOperation</a>>|A list of remote configuration management operations to be executed.|
|
|
19333
|
+
|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.|
|
|
19317
19334
|
|
|
19318
19335
|
### RemoteConfigurationManagementOperationValidationError
|
|
19319
19336
|
|
|
@@ -19332,7 +19349,7 @@ A list of remote configuration management jobs previews.
|
|
|
19332
19349
|
|
|
19333
19350
|
| Name | Type | Description |
|
|
19334
19351
|
| --- | --- | --- |
|
|
19335
|
-
|previews|Array<<a href="#remoteconfigurationmanagementjobpreview"
|
|
19352
|
+
|previews|Array<<a href="#remoteconfigurationmanagementjobpreview">RemoteConfigurationManagementJobPreview</a>>|A list of remote configuration management jobs previews.|
|
|
19336
19353
|
|
|
19337
19354
|
### RemoteConfigurationManagementValidationResult
|
|
19338
19355
|
|
|
@@ -19340,8 +19357,8 @@ The result of remote configuration management validation.
|
|
|
19340
19357
|
|
|
19341
19358
|
| Name | Type | Description |
|
|
19342
19359
|
| --- | --- | --- |
|
|
19343
|
-
|invalidEntities|Array<<a href="#remoteconfigurationmanagemententityvalidationerror">RemoteConfigurationManagementEntityValidationError</a>>|A list of validation errors for entities.|
|
|
19344
|
-
|invalidOperations|Array<<a href="#remoteconfigurationmanagementoperationvalidationerror"
|
|
19360
|
+
|invalidEntities|Array<<a href="#remoteconfigurationmanagemententityvalidationerror" target="_blank" rel="noopener noreferrer">RemoteConfigurationManagementEntityValidationError</a>>|A list of validation errors for entities.|
|
|
19361
|
+
|invalidOperations|Array<<a href="#remoteconfigurationmanagementoperationvalidationerror">RemoteConfigurationManagementOperationValidationError</a>>|A list of validation errors for operations.|
|
|
19345
19362
|
|
|
19346
19363
|
### RemoteIdentityOperationFailedEntityDto
|
|
19347
19364
|
|
|
@@ -19369,7 +19386,7 @@ Header Options of a Browser Monitor.
|
|
|
19369
19386
|
| Name | Type | Description |
|
|
19370
19387
|
| --- | --- | --- |
|
|
19371
19388
|
|matchingPatterns<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Apply headers to requests matching pattern.|
|
|
19372
|
-
|requestHeaders<sup>*required</sup>|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|Request headers list.|
|
|
19389
|
+
|requestHeaders<sup>*required</sup>|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|Request headers list.|
|
|
19373
19390
|
|
|
19374
19391
|
### RequestInformation
|
|
19375
19392
|
|
|
@@ -19379,14 +19396,14 @@ Describes the complete request information of an attack.
|
|
|
19379
19396
|
| --- | --- | --- |
|
|
19380
19397
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request.|
|
|
19381
19398
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path.|
|
|
19382
|
-
|protocolDetails|<a href="#protocoldetails"
|
|
19399
|
+
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>|Details that are specific to the used protocol.|
|
|
19383
19400
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL.|
|
|
19384
19401
|
|
|
19385
19402
|
### ResolutionRequest
|
|
19386
19403
|
|
|
19387
19404
|
| Name | Type |
|
|
19388
19405
|
| --- | --- |
|
|
19389
|
-
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest">SinglePermissionRequest</a>>|
|
|
19406
|
+
|permissions<sup>*required</sup>|Array<<a href="#singlepermissionrequest" target="_blank" rel="noopener noreferrer">SinglePermissionRequest</a>>|
|
|
19390
19407
|
|
|
19391
19408
|
### ResourceContext
|
|
19392
19409
|
|
|
@@ -19394,7 +19411,7 @@ The resource context, which contains additional permission information about the
|
|
|
19394
19411
|
|
|
19395
19412
|
| Name | Type | Description |
|
|
19396
19413
|
| --- | --- | --- |
|
|
19397
|
-
|modifications<sup>*required</sup>|<a href="#modification"
|
|
19414
|
+
|modifications<sup>*required</sup>|<a href="#modification">Modification</a>|The additional modification details for this settings object.|
|
|
19398
19415
|
|operations<sup>*required</sup>|Array<"delete" | "read" | "write">|The allowed operations on this settings object.|
|
|
19399
19416
|
|
|
19400
19417
|
### RevisionDiff
|
|
@@ -19407,10 +19424,10 @@ The diff between two revisions.
|
|
|
19407
19424
|
|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.|
|
|
19408
19425
|
|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.|
|
|
19409
19426
|
|jsonPatch|AnyValue|The JSON Patch for this value. May be null if the diff type is not UPDATE.|
|
|
19410
|
-
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>|Modification information about the setting.|
|
|
19427
|
+
|modificationInfo|<a href="#historymodificationinfo" target="_blank" rel="noopener noreferrer">HistoryModificationInfo</a>|Modification information about the setting.|
|
|
19411
19428
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object.|
|
|
19412
|
-
|ownerAfter|<a href="#identity"
|
|
19413
|
-
|ownerBefore|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
19429
|
+
|ownerAfter|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
19430
|
+
|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).|
|
|
19414
19431
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change.|
|
|
19415
19432
|
|schemaDisplayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema to which the revision belongs.|
|
|
19416
19433
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Schema ID to which the revision belongs.|
|
|
@@ -19426,7 +19443,7 @@ The paged response payload for diff between revisions of settings.
|
|
|
19426
19443
|
| Name | Type | Description |
|
|
19427
19444
|
| --- | --- | --- |
|
|
19428
19445
|
|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.<br/><br/><strong>Example:</strong> <code>2024-06-24T01:02:03Z</code>|
|
|
19429
|
-
|items<sup>*required</sup>|Array<<a href="#revisiondiff"
|
|
19446
|
+
|items<sup>*required</sup>|Array<<a href="#revisiondiff">RevisionDiff</a>>|The list of revisions changes in the current page.|
|
|
19430
19447
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
19431
19448
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
19432
19449
|
|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.<br/><br/><strong>Example:</strong> <code>2024-06-10T01:02:03Z</code>|
|
|
@@ -19438,7 +19455,7 @@ Risk assessment of a security problem.
|
|
|
19438
19455
|
| Name | Type | Description |
|
|
19439
19456
|
| --- | --- | --- |
|
|
19440
19457
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment.|
|
|
19441
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details.|
|
|
19458
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details.|
|
|
19442
19459
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score.|
|
|
19443
19460
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score.|
|
|
19444
19461
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment.|
|
|
@@ -19473,7 +19490,7 @@ Risk assessment of a security problem.
|
|
|
19473
19490
|
| Name | Type | Description |
|
|
19474
19491
|
| --- | --- | --- |
|
|
19475
19492
|
|assessmentAccuracy|"NOT_AVAILABLE" | "FULL" | "REDUCED"|The accuracy of the assessment.|
|
|
19476
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails"
|
|
19493
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details.|
|
|
19477
19494
|
|baseRiskLevel|"NONE" | "CRITICAL" | "HIGH" | "LOW" | "MEDIUM"|The risk level from the CVSS score.|
|
|
19478
19495
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score.|
|
|
19479
19496
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment.|
|
|
@@ -19493,7 +19510,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
19493
19510
|
| Name | Type | Description |
|
|
19494
19511
|
| --- | --- | --- |
|
|
19495
19512
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score.|
|
|
19496
|
-
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>|All changes of the risk assessment.|
|
|
19513
|
+
|changes|<a href="#riskassessmentchanges" target="_blank" rel="noopener noreferrer">RiskAssessmentChanges</a>|All changes of the risk assessment.|
|
|
19497
19514
|
|exposure|"NOT_AVAILABLE" | "NOT_DETECTED" | "PUBLIC_NETWORK"|The level of exposure of affected entities.|
|
|
19498
19515
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities.|
|
|
19499
19516
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes.|
|
|
@@ -19526,7 +19543,7 @@ Parameters of a service-level objective (SLO).
|
|
|
19526
19543
|
|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>).<br/><br/><strong>Example:</strong> <code>true</code>|
|
|
19527
19544
|
|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> <br/><br/><strong>Example:</strong> <code>NONE</code>|
|
|
19528
19545
|
|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> <br/><br/><strong>Example:</strong> <code>1.25</code>|
|
|
19529
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate"
|
|
19546
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>|Error budget burn rate evaluation of a service-level objective (SLO).|
|
|
19530
19547
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric.<br/><br/><strong>Example:</strong> <code>func:slo.errorBudget.payment_service_availability</code>|
|
|
19531
19548
|
|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> <br/><br/><strong>Example:</strong> <code>96.25</code>|
|
|
19532
19549
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO.<br/><br/><strong>Example:</strong> <code>AGGREGATE</code>|
|
|
@@ -19558,7 +19575,7 @@ Contains SLOs and paging information.
|
|
|
19558
19575
|
| --- | --- | --- |
|
|
19559
19576
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
19560
19577
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
19561
|
-
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs.|
|
|
19578
|
+
|slo<sup>*required</sup>|Array<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>>|The list of SLOs.|
|
|
19562
19579
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
19563
19580
|
|
|
19564
19581
|
### SNMPV3Credentials
|
|
@@ -19568,7 +19585,7 @@ A credentials set of the `SNMPV3` type.
|
|
|
19568
19585
|
| Name | Type | Description |
|
|
19569
19586
|
| --- | --- | --- |
|
|
19570
19587
|
|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).|
|
|
19571
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
19588
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
19572
19589
|
|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)|
|
|
19573
19590
|
|authenticationProtocol|"MD5" | "SHA" | "SHA224" | "SHA256" | "SHA384" | "SHA512"|The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512|
|
|
19574
19591
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
@@ -19600,26 +19617,26 @@ A credentials set of the `SNMPV3` type.
|
|
|
19600
19617
|
| Name | Type | Description |
|
|
19601
19618
|
| --- | --- | --- |
|
|
19602
19619
|
|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.<br/><br/><strong>Example:</strong> <code>["host","application"]</code>|
|
|
19603
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema.|
|
|
19604
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
19620
|
+
|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.|
|
|
19621
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted.|
|
|
19605
19622
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema.<br/><br/><strong>Example:</strong> <code>Dynatrace disables monitoring of containers that do not run any applications</code>|
|
|
19606
19623
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema.<br/><br/><strong>Example:</strong> <code>Built-in container monitoring rules</code>|
|
|
19607
19624
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation.|
|
|
19608
19625
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format.<br/><br/><strong>Example:</strong> <code>1</code>|
|
|
19609
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties.|
|
|
19626
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties.|
|
|
19610
19627
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema.<br/><br/><strong>Example:</strong> <code>keyProperty</code>|
|
|
19611
19628
|
|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> <br/><br/><strong>Example:</strong> <code>GENERAL_AVAILABILITY</code>|
|
|
19612
19629
|
|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> <br/><br/><strong>Example:</strong> <code>10</code>|
|
|
19613
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
19630
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting.|
|
|
19614
19631
|
|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.|
|
|
19615
19632
|
|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> |
|
|
19616
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties.|
|
|
19617
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
19633
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties.|
|
|
19634
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element.|
|
|
19618
19635
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to.<br/><br/><strong>Example:</strong> <code>["group:some.1","group:some.2"]</code>|
|
|
19619
19636
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema.<br/><br/><strong>Example:</strong> <code>builtin:container.built-in-monitoring-rule</code>|
|
|
19620
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui.|
|
|
19621
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
19622
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements|
|
|
19637
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui.|
|
|
19638
|
+
|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> |
|
|
19639
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements|
|
|
19623
19640
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema.<br/><br/><strong>Example:</strong> <code>1.4.2</code>|
|
|
19624
19641
|
|
|
19625
19642
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -19666,7 +19683,7 @@ The list of available settings schemas.
|
|
|
19666
19683
|
|
|
19667
19684
|
| Name | Type | Description |
|
|
19668
19685
|
| --- | --- | --- |
|
|
19669
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
19686
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas.|
|
|
19670
19687
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list.<br/><br/><strong>Example:</strong> <code>1</code>|
|
|
19671
19688
|
|
|
19672
19689
|
### SchemaStub
|
|
@@ -19691,11 +19708,11 @@ A list of definitions of types.
|
|
|
19691
19708
|
|
|
19692
19709
|
| Name | Type | Description |
|
|
19693
19710
|
| --- | --- | --- |
|
|
19694
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
19711
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted.|
|
|
19695
19712
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property.<br/><br/><strong>Example:</strong> <code>typeDescription</code>|
|
|
19696
19713
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property.<br/><br/><strong>Example:</strong> <code>typeDisplayName</code>|
|
|
19697
19714
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation.<br/><br/><strong>Example:</strong> <code>typeDocumentation</code>|
|
|
19698
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
19715
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>|Definition of properties that can be persisted.|
|
|
19699
19716
|
|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.<br/><br/><strong>Example:</strong> <code>searchPatternOfType</code>|
|
|
19700
19717
|
|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.<br/><br/><strong>Example:</strong> <code>summaryPatternOfType</code>|
|
|
19701
19718
|
|type<sup>*required</sup>|"object"|Type of the reference type.<br/><br/><strong>Example:</strong> <code>object</code>|
|
|
@@ -19757,19 +19774,19 @@ Parameters of a security problem
|
|
|
19757
19774
|
|
|
19758
19775
|
| Name | Type | Description |
|
|
19759
19776
|
| --- | --- | --- |
|
|
19760
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability.|
|
|
19777
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability.|
|
|
19761
19778
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem.|
|
|
19762
19779
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem.|
|
|
19763
19780
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem.|
|
|
19764
19781
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem.|
|
|
19765
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
19782
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account.|
|
|
19766
19783
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened.|
|
|
19767
19784
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved.|
|
|
19768
19785
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change.|
|
|
19769
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to.|
|
|
19786
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to.|
|
|
19770
19787
|
|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.|
|
|
19771
19788
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem.|
|
|
19772
|
-
|riskAssessment|<a href="#riskassessment"
|
|
19789
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>|Risk assessment of a security problem.|
|
|
19773
19790
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem.|
|
|
19774
19791
|
|status|"OPEN" | "RESOLVED"|The status of the security problem.|
|
|
19775
19792
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem.|
|
|
@@ -19794,37 +19811,37 @@ Parameters of a security problem
|
|
|
19794
19811
|
| Name | Type | Description |
|
|
19795
19812
|
| --- | --- | --- |
|
|
19796
19813
|
|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> |
|
|
19797
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability.|
|
|
19814
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability.|
|
|
19798
19815
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem.|
|
|
19799
19816
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem.|
|
|
19800
19817
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem.|
|
|
19801
|
-
|entryPoints|<a href="#entrypoints"
|
|
19802
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem.|
|
|
19818
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>|A list of entry points and a flag which indicates whether this list was truncated or not.|
|
|
19819
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem.|
|
|
19803
19820
|
|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> |
|
|
19804
19821
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem.|
|
|
19805
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
19822
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>|Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.|
|
|
19806
19823
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem.|
|
|
19807
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account.|
|
|
19824
|
+
|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.|
|
|
19808
19825
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened.|
|
|
19809
19826
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved.|
|
|
19810
19827
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change.|
|
|
19811
|
-
|managementZones|Array<<a href="#managementzone"
|
|
19828
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to.|
|
|
19812
19829
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress.|
|
|
19813
19830
|
|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.|
|
|
19814
19831
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem.|
|
|
19815
19832
|
|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> |
|
|
19816
|
-
|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> |
|
|
19817
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
19818
|
-
|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> |
|
|
19833
|
+
|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> |
|
|
19834
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>|A list of related container images.|
|
|
19835
|
+
|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> |
|
|
19819
19836
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability.|
|
|
19820
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
19837
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>|Risk assessment of a security problem.|
|
|
19821
19838
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem.|
|
|
19822
19839
|
|status|"OPEN" | "RESOLVED"|The status of the security problem.|
|
|
19823
19840
|
|technology|"KUBERNETES" | "DOTNET" | "GO" | "JAVA" | "NODE_JS" | "PHP" | "PYTHON"|The technology of the security problem.|
|
|
19824
19841
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem.|
|
|
19825
19842
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page.|
|
|
19826
19843
|
|vulnerabilityType|"CODE_LEVEL" | "RUNTIME" | "THIRD_PARTY"|The type of the vulnerability.|
|
|
19827
|
-
|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> |
|
|
19844
|
+
|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> |
|
|
19828
19845
|
|
|
19829
19846
|
### SecurityProblemEvent
|
|
19830
19847
|
|
|
@@ -19832,9 +19849,9 @@ The event of a security problem.
|
|
|
19832
19849
|
|
|
19833
19850
|
| Name | Type | Description |
|
|
19834
19851
|
| --- | --- | --- |
|
|
19835
|
-
|muteState|<a href="#mutestate"
|
|
19852
|
+
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event.|
|
|
19836
19853
|
|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.|
|
|
19837
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem.|
|
|
19854
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem.|
|
|
19838
19855
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred.|
|
|
19839
19856
|
|
|
19840
19857
|
### SecurityProblemEventsList
|
|
@@ -19843,7 +19860,7 @@ A list of events for a security problem.
|
|
|
19843
19860
|
|
|
19844
19861
|
| Name | Type | Description |
|
|
19845
19862
|
| --- | --- | --- |
|
|
19846
|
-
|events|Array<<a href="#securityproblemevent"
|
|
19863
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem.|
|
|
19847
19864
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
19848
19865
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
19849
19866
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
@@ -19856,7 +19873,7 @@ A list of security problems.
|
|
|
19856
19873
|
| --- | --- | --- |
|
|
19857
19874
|
|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> <br/><br/><strong>Example:</strong> <code>AQAAABQBAAAABQ==</code>|
|
|
19858
19875
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.|
|
|
19859
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems.|
|
|
19876
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems.|
|
|
19860
19877
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result.|
|
|
19861
19878
|
|
|
19862
19879
|
### SecurityProblemMute
|
|
@@ -19893,7 +19910,7 @@ Response of muting several security problems.
|
|
|
19893
19910
|
|
|
19894
19911
|
| Name | Type | Description |
|
|
19895
19912
|
| --- | --- | --- |
|
|
19896
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
19913
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously.|
|
|
19897
19914
|
|
|
19898
19915
|
### SecurityProblemsBulkUnmute
|
|
19899
19916
|
|
|
@@ -19911,7 +19928,7 @@ Response of un-muting several security problems.
|
|
|
19911
19928
|
|
|
19912
19929
|
| Name | Type | Description |
|
|
19913
19930
|
| --- | --- | --- |
|
|
19914
|
-
|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.|
|
|
19931
|
+
|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.|
|
|
19915
19932
|
|
|
19916
19933
|
### SelectOptionStepDto
|
|
19917
19934
|
|
|
@@ -19921,11 +19938,11 @@ Select option step of Browser Monitor.
|
|
|
19921
19938
|
| --- | --- | --- |
|
|
19922
19939
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
19923
19940
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|
|
|
19924
|
-
|selections<sup>*required</sup>|Array<<a href="#selectiondto"
|
|
19925
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
19941
|
+
|selections<sup>*required</sup>|Array<<a href="#selectiondto">SelectionDto</a>>|Field containing the credential.|
|
|
19942
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step.|
|
|
19926
19943
|
|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> |
|
|
19927
|
-
|validationRules|Array<<a href="#validationruledto"
|
|
19928
|
-
|waitCondition|<a href="#basewaitconditiondto">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
19944
|
+
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform.|
|
|
19945
|
+
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|
|
|
19929
19946
|
|
|
19930
19947
|
### SelectionDto
|
|
19931
19948
|
|
|
@@ -19944,7 +19961,7 @@ Analysis of problem impact to a service.
|
|
|
19944
19961
|
| --- | --- | --- |
|
|
19945
19962
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users.|
|
|
19946
19963
|
|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> |
|
|
19947
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
19964
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
19948
19965
|
|numberOfPotentiallyAffectedServiceCalls<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services.|
|
|
19949
19966
|
|
|
19950
19967
|
### SettingsObject
|
|
@@ -19957,12 +19974,12 @@ A settings object.
|
|
|
19957
19974
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation.|
|
|
19958
19975
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object.<br/><br/><strong>Example:</strong> <code>fab17b7a-2eb2-4c95-b818-743d94be2c30</code>|
|
|
19959
19976
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object.|
|
|
19960
|
-
|~~modificationInfo~~<sup>**DEPRECATED**</sup>|<a href="#modificationinfo">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>.|
|
|
19977
|
+
|~~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>.|
|
|
19961
19978
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification.|
|
|
19962
19979
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification.<br/><br/><strong>Example:</strong> <code>fab17b7a-2eb2-4c95-b818-743d94be2c30</code>|
|
|
19963
19980
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object.<br/><br/><strong>Example:</strong> <code>Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=</code>|
|
|
19964
|
-
|owner|<a href="#identity"
|
|
19965
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object.|
|
|
19981
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
19982
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object.|
|
|
19966
19983
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based.<br/><br/><strong>Example:</strong> <code>builtin:container.built-in-monitoring-rule</code>|
|
|
19967
19984
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based.<br/><br/><strong>Example:</strong> <code>1.0.0</code>|
|
|
19968
19985
|
|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>.<br/><br/><strong>Example:</strong> <code>HOST-D3A3C5A146830A79</code>|
|
|
@@ -19984,8 +20001,8 @@ The response to a get by objectId request.
|
|
|
19984
20001
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification.|
|
|
19985
20002
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification.<br/><br/><strong>Example:</strong> <code>fab17b7a-2eb2-4c95-b818-743d94be2c30</code>|
|
|
19986
20003
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object.<br/><br/><strong>Example:</strong> <code>Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=</code>|
|
|
19987
|
-
|owner|<a href="#identity"
|
|
19988
|
-
|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object.|
|
|
20004
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
20005
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object.|
|
|
19989
20006
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based.<br/><br/><strong>Example:</strong> <code>builtin:container.built-in-monitoring-rule</code>|
|
|
19990
20007
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based.<br/><br/><strong>Example:</strong> <code>1.0.0</code>|
|
|
19991
20008
|
|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>.<br/><br/><strong>Example:</strong> <code>HOST-D3A3C5A146830A79</code>|
|
|
@@ -20015,7 +20032,7 @@ The response to a creation- or update-request.
|
|
|
20015
20032
|
| Name | Type | Description |
|
|
20016
20033
|
| --- | --- | --- |
|
|
20017
20034
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object.|
|
|
20018
|
-
|error|<a href="#error"
|
|
20035
|
+
|error|<a href="#error">Error</a>||
|
|
20019
20036
|
|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> <br/><br/><strong>Example:</strong> <code>{"autoMonitoring":true}</code>|
|
|
20020
20037
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object.<br/><br/><strong>Example:</strong> <code>Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=</code>|
|
|
20021
20038
|
|
|
@@ -20037,7 +20054,7 @@ A list of permissions.
|
|
|
20037
20054
|
|
|
20038
20055
|
| Name | Type | Description |
|
|
20039
20056
|
| --- | --- | --- |
|
|
20040
|
-
|context|<a href="#permissioncontext">PermissionContext</a>|Optional context data|
|
|
20057
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>|Optional context data|
|
|
20041
20058
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed<br/><br/><strong>Example:</strong> <code>settings:objects:write</code>|
|
|
20042
20059
|
|
|
20043
20060
|
### SloBurnRate
|
|
@@ -20068,7 +20085,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
20068
20085
|
| --- | --- | --- |
|
|
20069
20086
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO.<br/><br/><strong>Example:</strong> <code>Rate of successful payments per week</code>|
|
|
20070
20087
|
|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> <br/><br/><strong>Example:</strong> <code>true</code>|
|
|
20071
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig"
|
|
20088
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>|Error budget burn rate configuration of a service-level objective (SLO).|
|
|
20072
20089
|
|evaluationType<sup>*required</sup>|"AGGREGATE"|The evaluation type of the SLO.<br/><br/><strong>Example:</strong> <code>AGGREGATE</code>|
|
|
20073
20090
|
|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>.<br/><br/><strong>Example:</strong> <code>type("SERVICE")</code>|
|
|
20074
20091
|
|~~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> <br/><br/><strong>Example:</strong> <code>builtin:service.requestCount.server</code>|
|
|
@@ -20114,7 +20131,7 @@ Parameters of a status alert.
|
|
|
20114
20131
|
|
|
20115
20132
|
| Name | Type |
|
|
20116
20133
|
| --- | --- |
|
|
20117
|
-
|details|<a href="#success">Success</a>|
|
|
20134
|
+
|details|<a href="#success" target="_blank" rel="noopener noreferrer">Success</a>|
|
|
20118
20135
|
|
|
20119
20136
|
### SyntheticBrowserMonitorConfigurationDto
|
|
20120
20137
|
|
|
@@ -20123,21 +20140,22 @@ Browser Monitor configuration.
|
|
|
20123
20140
|
| Name | Type | Description |
|
|
20124
20141
|
| --- | --- | --- |
|
|
20125
20142
|
|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.|
|
|
20126
|
-
|browserPermissions|<a href="#browserpermissionsdto"
|
|
20143
|
+
|browserPermissions|<a href="#browserpermissionsdto">BrowserPermissionsDto</a>|Permissions settings for browser.|
|
|
20127
20144
|
|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.|
|
|
20128
|
-
|chromiumStartupFlags|<a href="#chromiumstartupflagsdto">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor.|
|
|
20129
|
-
|clientCertificates|Array<<a href="#clientcertificatedto"
|
|
20130
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|Cookies list.|
|
|
20131
|
-
|device<sup>*required</sup>|<a href="#testdevicedto"
|
|
20132
|
-
|enablement|<a href="#enablementdto">EnablementDto</a>|Browser monitor enablement settings.|
|
|
20133
|
-
|experimentalProperties|Array<<a href="#monitorpropertydto"
|
|
20134
|
-
|filteredRequests|<a href="#filteredrequestsdto">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor.|
|
|
20135
|
-
|ignoredErrorCodes|<a href="#ignorederrorcodesdto"
|
|
20136
|
-
|javaScriptSettings|<a href="#javascriptagentsettingsdto">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings.|
|
|
20145
|
+
|chromiumStartupFlags|<a href="#chromiumstartupflagsdto" target="_blank" rel="noopener noreferrer">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor.|
|
|
20146
|
+
|clientCertificates|Array<<a href="#clientcertificatedto">ClientCertificateDto</a>>|Identifier of stored client's certificate.|
|
|
20147
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Cookies list.|
|
|
20148
|
+
|device<sup>*required</sup>|<a href="#testdevicedto">TestDeviceDto</a>|Test device of a Browser Monitor.|
|
|
20149
|
+
|enablement|<a href="#enablementdto" target="_blank" rel="noopener noreferrer">EnablementDto</a>|Browser monitor enablement settings.|
|
|
20150
|
+
|experimentalProperties|Array<<a href="#monitorpropertydto">MonitorPropertyDto</a>>|Experimental properties list.|
|
|
20151
|
+
|filteredRequests|<a href="#filteredrequestsdto" target="_blank" rel="noopener noreferrer">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor.|
|
|
20152
|
+
|ignoredErrorCodes|<a href="#ignorederrorcodesdto">IgnoredErrorCodesDto</a>|Ignored Error Codes of a Browser Monitor.|
|
|
20153
|
+
|javaScriptSettings|<a href="#javascriptagentsettingsdto" target="_blank" rel="noopener noreferrer">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings.|
|
|
20154
|
+
|monitorCrossOriginFrames|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture performance metrics for pages loaded in cross origin frames. If not defined in request, it will fall back to monitorFrames by default.|
|
|
20137
20155
|
|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.|
|
|
20138
|
-
|networkThrottling|<a href="#networkthrottlingdto"
|
|
20139
|
-
|proxy|<a href="#proxydto">ProxyDto</a>|Browser Monitor proxy.|
|
|
20140
|
-
|requestHeaderOptions|<a href="#requestheaderoptionsdto"
|
|
20156
|
+
|networkThrottling|<a href="#networkthrottlingdto">NetworkThrottlingDto</a>|Network throttling of a Browser Monitor.|
|
|
20157
|
+
|proxy|<a href="#proxydto" target="_blank" rel="noopener noreferrer">ProxyDto</a>|Browser Monitor proxy.|
|
|
20158
|
+
|requestHeaderOptions|<a href="#requestheaderoptionsdto">RequestHeaderOptionsDto</a>|Header Options of a Browser Monitor.|
|
|
20141
20159
|
|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.|
|
|
20142
20160
|
|userAgent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User agent|
|
|
20143
20161
|
|
|
@@ -20147,19 +20165,19 @@ Browser monitor update.
|
|
|
20147
20165
|
|
|
20148
20166
|
| Name | Type | Description |
|
|
20149
20167
|
| --- | --- | --- |
|
|
20150
|
-
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration.|
|
|
20168
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration.|
|
|
20151
20169
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description|
|
|
20152
20170
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.<br/><br/><strong>Default:</strong> <code>true</code>|
|
|
20153
20171
|
|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).|
|
|
20154
|
-
|keyPerformanceMetrics|<a href="#keyperformancemetrics"
|
|
20172
|
+
|keyPerformanceMetrics|<a href="#keyperformancemetrics">KeyPerformanceMetrics</a>|The key performance metrics configuration.|
|
|
20155
20173
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned.|
|
|
20156
20174
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities.|
|
|
20157
20175
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20158
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20159
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
20160
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor.|
|
|
20161
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
20162
|
-
|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> |
|
|
20176
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20177
|
+
|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.|
|
|
20178
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor.|
|
|
20179
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20180
|
+
|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> |
|
|
20163
20181
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20164
20182
|
|
|
20165
20183
|
### SyntheticBrowserMonitorResponse
|
|
@@ -20169,21 +20187,21 @@ Browser Monitor.
|
|
|
20169
20187
|
| Name | Type | Description |
|
|
20170
20188
|
| --- | --- | --- |
|
|
20171
20189
|
|automaticallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Automatically assigned entities.|
|
|
20172
|
-
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto"
|
|
20190
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration.|
|
|
20173
20191
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description|
|
|
20174
20192
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.|
|
|
20175
20193
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor.|
|
|
20176
20194
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes.|
|
|
20177
|
-
|keyPerformanceMetrics<sup>*required</sup>|<a href="#keyperformancemetrics">KeyPerformanceMetrics</a>|The key performance metrics configuration.|
|
|
20195
|
+
|keyPerformanceMetrics<sup>*required</sup>|<a href="#keyperformancemetrics" target="_blank" rel="noopener noreferrer">KeyPerformanceMetrics</a>|The key performance metrics configuration.|
|
|
20178
20196
|
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned.|
|
|
20179
20197
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities.|
|
|
20180
20198
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification|
|
|
20181
20199
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20182
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
20183
|
-
|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.|
|
|
20184
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto"
|
|
20185
|
-
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20186
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
20200
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20201
|
+
|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.|
|
|
20202
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor.|
|
|
20203
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20204
|
+
|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> |
|
|
20187
20205
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20188
20206
|
|
|
20189
20207
|
### SyntheticBrowserMonitorStepDto
|
|
@@ -20204,6 +20222,7 @@ A DTO for synthetic configuration.
|
|
|
20204
20222
|
| --- | --- | --- |
|
|
20205
20223
|
|bmMonitorTimeout<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|bmMonitorTimeout - browser monitor execution timeout (ms)<br/><br/><strong>Minimum:</strong> <code>60000</code>|
|
|
20206
20224
|
|bmStepTimeout<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|bmStepTimeout - browser monitor single step execution timeout (ms)<br/><br/><strong>Minimum:</strong> <code>10000</code>|
|
|
20225
|
+
|maintenanceWindowsExcludedFromAvailability<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|maintenanceWindowsExcludedFromAvailability - exclude periods with maintenance windows from availability calculation|
|
|
20207
20226
|
|
|
20208
20227
|
### SyntheticHttpAuthenticationDto
|
|
20209
20228
|
|
|
@@ -20226,7 +20245,7 @@ The Http step's configuration.
|
|
|
20226
20245
|
|clientCertificateId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Identifier of stored client's certificate.|
|
|
20227
20246
|
|doNotPersistSensitiveData|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true the step's data aren't stored and displayed.<br/><br/><strong>Default:</strong> <code>false</code>|
|
|
20228
20247
|
|followRedirects|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true follow redirects.<br/><br/><strong>Default:</strong> <code>false</code>|
|
|
20229
|
-
|headers|Array<<a href="#monitorrequestheader">MonitorRequestHeader</a>>|The headers.|
|
|
20248
|
+
|headers|Array<<a href="#monitorrequestheader" target="_blank" rel="noopener noreferrer">MonitorRequestHeader</a>>|The headers.|
|
|
20230
20249
|
|sslCertificateExpirationDaysToAlert|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of days within SSL certificate expires.|
|
|
20231
20250
|
|
|
20232
20251
|
### SyntheticHttpMonitorAdvancedDto
|
|
@@ -20252,19 +20271,19 @@ Http monitor's settings.
|
|
|
20252
20271
|
|
|
20253
20272
|
| Name | Type | Description |
|
|
20254
20273
|
| --- | --- | --- |
|
|
20255
|
-
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto"
|
|
20256
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|The cookies of the monitor.|
|
|
20274
|
+
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings.|
|
|
20275
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|The cookies of the monitor.|
|
|
20257
20276
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description|
|
|
20258
20277
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.<br/><br/><strong>Default:</strong> <code>true</code>|
|
|
20259
20278
|
|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).|
|
|
20260
20279
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned.|
|
|
20261
20280
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities.|
|
|
20262
20281
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20263
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
20264
|
-
|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.|
|
|
20265
|
-
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto"
|
|
20266
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20267
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
20282
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20283
|
+
|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.|
|
|
20284
|
+
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto">SyntheticHttpMonitorStepDto</a>>|The steps of the monitor.|
|
|
20285
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20286
|
+
|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> |
|
|
20268
20287
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20269
20288
|
|
|
20270
20289
|
### SyntheticHttpMonitorResponse
|
|
@@ -20273,9 +20292,9 @@ Http monitor.
|
|
|
20273
20292
|
|
|
20274
20293
|
| Name | Type | Description |
|
|
20275
20294
|
| --- | --- | --- |
|
|
20276
|
-
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings.|
|
|
20295
|
+
|advancedSettings|<a href="#synthetichttpmonitoradvanceddto" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorAdvancedDto</a>|Http monitor's settings.|
|
|
20277
20296
|
|automaticallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Automatically assigned entities.|
|
|
20278
|
-
|cookies|Array<<a href="#syntheticmonitorcookiedto"
|
|
20297
|
+
|cookies|Array<<a href="#syntheticmonitorcookiedto">SyntheticMonitorCookieDto</a>>|The cookies of the monitor.|
|
|
20279
20298
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description|
|
|
20280
20299
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.|
|
|
20281
20300
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor.|
|
|
@@ -20284,11 +20303,11 @@ Http monitor.
|
|
|
20284
20303
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities.|
|
|
20285
20304
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification|
|
|
20286
20305
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20287
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20288
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
20289
|
-
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto">SyntheticHttpMonitorStepDto</a>>|The steps of the monitor.|
|
|
20290
|
-
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
20291
|
-
|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> |
|
|
20306
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20307
|
+
|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.|
|
|
20308
|
+
|steps<sup>*required</sup>|Array<<a href="#synthetichttpmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticHttpMonitorStepDto</a>>|The steps of the monitor.|
|
|
20309
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20310
|
+
|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> |
|
|
20292
20311
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20293
20312
|
|
|
20294
20313
|
### SyntheticHttpMonitorStepDto
|
|
@@ -20297,9 +20316,9 @@ The step of a Http monitor.
|
|
|
20297
20316
|
|
|
20298
20317
|
| Name | Type | Description |
|
|
20299
20318
|
| --- | --- | --- |
|
|
20300
|
-
|authentication|<a href="#synthetichttpauthenticationdto"
|
|
20301
|
-
|configuration|<a href="#synthetichttpconfigurationdto">SyntheticHttpConfigurationDto</a>|The Http step's configuration.|
|
|
20302
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
20319
|
+
|authentication|<a href="#synthetichttpauthenticationdto">SyntheticHttpAuthenticationDto</a>|The Http step's authentication.|
|
|
20320
|
+
|configuration|<a href="#synthetichttpconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticHttpConfigurationDto</a>|The Http step's configuration.|
|
|
20321
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints.|
|
|
20303
20322
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id.|
|
|
20304
20323
|
|methodType<sup>*required</sup>|"DELETE" | "GET" | "POST" | "PUT" | "HEAD" | "OPTIONS" | "PATCH"|Method type.|
|
|
20305
20324
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name.|
|
|
@@ -20355,7 +20374,7 @@ A list of synthetic locations.
|
|
|
20355
20374
|
|
|
20356
20375
|
| Name | Type | Description |
|
|
20357
20376
|
| --- | --- | --- |
|
|
20358
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations.|
|
|
20377
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement" target="_blank" rel="noopener noreferrer">LocationCollectionElement</a>>|A list of synthetic locations.|
|
|
20359
20378
|
|
|
20360
20379
|
### SyntheticMonitorConstraintDto
|
|
20361
20380
|
|
|
@@ -20363,7 +20382,7 @@ Synthetic monitor constraint. The allowed type and properties depend on the moni
|
|
|
20363
20382
|
|
|
20364
20383
|
| Name | Type | Description |
|
|
20365
20384
|
| --- | --- | --- |
|
|
20366
|
-
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties"
|
|
20385
|
+
|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.|
|
|
20367
20386
|
|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).<br/><br/><strong>Example:</strong> <code>ICMP_SUCCESS_RATE_PERCENT</code>|
|
|
20368
20387
|
|
|
20369
20388
|
### SyntheticMonitorConstraintDtoProperties
|
|
@@ -20389,7 +20408,7 @@ List of available synthetic monitors.
|
|
|
20389
20408
|
|
|
20390
20409
|
| Name | Type | Description |
|
|
20391
20410
|
| --- | --- | --- |
|
|
20392
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors.|
|
|
20411
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>>|List of monitors.|
|
|
20393
20412
|
|
|
20394
20413
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
20395
20414
|
|
|
@@ -20426,7 +20445,7 @@ Performance thresholds configuration.
|
|
|
20426
20445
|
| Name | Type | Description |
|
|
20427
20446
|
| --- | --- | --- |
|
|
20428
20447
|
|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>).|
|
|
20429
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto"
|
|
20448
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules.|
|
|
20430
20449
|
|
|
20431
20450
|
### SyntheticMonitorPrimaryGrailTagDto
|
|
20432
20451
|
|
|
@@ -20459,11 +20478,11 @@ Network availability monitor.
|
|
|
20459
20478
|
|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).|
|
|
20460
20479
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned.|
|
|
20461
20480
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20462
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20463
|
-
|primaryGrailTags|Array<<a href="#syntheticmonitorprimarygrailtagdto"
|
|
20464
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor.|
|
|
20465
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
20466
|
-
|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> |
|
|
20481
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20482
|
+
|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.|
|
|
20483
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor.|
|
|
20484
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20485
|
+
|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> |
|
|
20467
20486
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20468
20487
|
|
|
20469
20488
|
### SyntheticMultiProtocolMonitorResponse
|
|
@@ -20479,11 +20498,11 @@ Network availability monitor.
|
|
|
20479
20498
|
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned.|
|
|
20480
20499
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification|
|
|
20481
20500
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|
|
|
20482
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
20483
|
-
|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.|
|
|
20484
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto"
|
|
20485
|
-
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20486
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
20501
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|
|
|
20502
|
+
|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.|
|
|
20503
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor.|
|
|
20504
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|
|
|
20505
|
+
|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> |
|
|
20487
20506
|
|type<sup>*required</sup>|"BROWSER" | "HTTP" | "MULTI_PROTOCOL"|Monitor type.|
|
|
20488
20507
|
|
|
20489
20508
|
### SyntheticMultiProtocolMonitorStepDto
|
|
@@ -20492,10 +20511,10 @@ The step of a network availability monitor.
|
|
|
20492
20511
|
|
|
20493
20512
|
| Name | Type | Description |
|
|
20494
20513
|
| --- | --- | --- |
|
|
20495
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step.|
|
|
20514
|
+
|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.|
|
|
20496
20515
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name.|
|
|
20497
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties"
|
|
20498
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations.|
|
|
20516
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step.|
|
|
20517
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations.|
|
|
20499
20518
|
|requestType<sup>*required</sup>|"ICMP" | "TCP" | "DNS"|Request type.|
|
|
20500
20519
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter.|
|
|
20501
20520
|
|targetList|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list.|
|
|
@@ -20512,7 +20531,7 @@ The configuration of a network availability monitor request.
|
|
|
20512
20531
|
|
|
20513
20532
|
| Name | Type | Description |
|
|
20514
20533
|
| --- | --- | --- |
|
|
20515
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
20534
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|Request constraints.|
|
|
20516
20535
|
|
|
20517
20536
|
### SyntheticOnDemandBatchStatus
|
|
20518
20537
|
|
|
@@ -20524,12 +20543,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
20524
20543
|
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"|The status of the batch.|
|
|
20525
20544
|
|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.|
|
|
20526
20545
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED.|
|
|
20527
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>||
|
|
20528
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
20546
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>||
|
|
20547
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>||
|
|
20529
20548
|
|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.|
|
|
20530
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch|
|
|
20549
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch|
|
|
20531
20550
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch.|
|
|
20532
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
20551
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>||
|
|
20533
20552
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems.|
|
|
20534
20553
|
|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.|
|
|
20535
20554
|
|
|
@@ -20551,14 +20570,14 @@ Describes the status of an on-demand execution.
|
|
|
20551
20570
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution.|
|
|
20552
20571
|
|executionStage<sup>*required</sup>|"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"|Execution stage.|
|
|
20553
20572
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds.|
|
|
20554
|
-
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details.|
|
|
20573
|
+
|fullResults|<a href="#executionfullresults" target="_blank" rel="noopener noreferrer">ExecutionFullResults</a>|Contains extended monitor's execution details.|
|
|
20555
20574
|
|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.|
|
|
20556
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata"
|
|
20575
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch.|
|
|
20557
20576
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor.|
|
|
20558
20577
|
|nextExecutionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Next execution id for sequential mode.|
|
|
20559
20578
|
|processingMode<sup>*required</sup>|"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The processing mode of the execution.|
|
|
20560
20579
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds.|
|
|
20561
|
-
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution.|
|
|
20580
|
+
|simpleResults|<a href="#executionsimpleresults" target="_blank" rel="noopener noreferrer">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution.|
|
|
20562
20581
|
|source<sup>*required</sup>|"API" | "UI"|The source of the triggering request.|
|
|
20563
20582
|
|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.|
|
|
20564
20583
|
|
|
@@ -20576,9 +20595,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
20576
20595
|
| --- | --- | --- |
|
|
20577
20596
|
|failOnPerformanceIssue|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the execution will fail in case of performance issue.<br/><br/><strong>Default:</strong> <code>true</code>|
|
|
20578
20597
|
|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.<br/><br/><strong>Default:</strong> <code>true</code>|
|
|
20579
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup"
|
|
20580
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution|
|
|
20581
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor"
|
|
20598
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.|
|
|
20599
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution|
|
|
20600
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered.|
|
|
20582
20601
|
|processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode<br/><br/><strong>Default:</strong> <code>STANDARD</code>|
|
|
20583
20602
|
|stopOnProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, no executions will be scheduled if a problem occurs.<br/><br/><strong>Default:</strong> <code>false</code>|
|
|
20584
20603
|
|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.<br/><br/><strong>Default:</strong> <code>false</code>|
|
|
@@ -20619,10 +20638,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
20619
20638
|
| Name | Type | Description |
|
|
20620
20639
|
| --- | --- | --- |
|
|
20621
20640
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions.|
|
|
20622
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered.|
|
|
20641
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered.|
|
|
20623
20642
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch.|
|
|
20624
20643
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch.|
|
|
20625
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
20644
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred.|
|
|
20626
20645
|
|
|
20627
20646
|
### SyntheticOnDemandExecutions
|
|
20628
20647
|
|
|
@@ -20630,7 +20649,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
20630
20649
|
|
|
20631
20650
|
| Name | Type | Description |
|
|
20632
20651
|
| --- | --- | --- |
|
|
20633
|
-
|executions
|
|
20652
|
+
|executions|Array<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>>|The list of executions.|
|
|
20634
20653
|
|
|
20635
20654
|
### SyntheticOnDemandFailedExecutionStatus
|
|
20636
20655
|
|
|
@@ -20661,7 +20680,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
20661
20680
|
|
|
20662
20681
|
| Name | Type | Description |
|
|
20663
20682
|
| --- | --- | --- |
|
|
20664
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails"
|
|
20683
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions.|
|
|
20665
20684
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier.|
|
|
20666
20685
|
|
|
20667
20686
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -20747,7 +20766,7 @@ Target of Browser Monitor step.
|
|
|
20747
20766
|
|
|
20748
20767
|
| Name | Type | Description |
|
|
20749
20768
|
| --- | --- | --- |
|
|
20750
|
-
|locators<sup>*required</sup>|Array<<a href="#locatordto">LocatorDto</a>>|List of locators.|
|
|
20769
|
+
|locators<sup>*required</sup>|Array<<a href="#locatordto" target="_blank" rel="noopener noreferrer">LocatorDto</a>>|List of locators.|
|
|
20751
20770
|
|window<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target window.|
|
|
20752
20771
|
|
|
20753
20772
|
### TenantToken
|
|
@@ -20764,8 +20783,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
20764
20783
|
|
|
20765
20784
|
| Name | Type | Description |
|
|
20766
20785
|
| --- | --- | --- |
|
|
20767
|
-
|active|<a href="#tenanttoken"
|
|
20768
|
-
|old|<a href="#tenanttoken">TenantToken</a>|Tenant token|
|
|
20786
|
+
|active|<a href="#tenanttoken">TenantToken</a>|Tenant token|
|
|
20787
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token|
|
|
20769
20788
|
|
|
20770
20789
|
### TenantTokenRotationStatus
|
|
20771
20790
|
|
|
@@ -20821,9 +20840,9 @@ A credentials set of the `TOKEN` type.
|
|
|
20821
20840
|
| Name | Type | Description |
|
|
20822
20841
|
| --- | --- | --- |
|
|
20823
20842
|
|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).|
|
|
20824
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
20843
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
20825
20844
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
20826
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault|
|
|
20845
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault|
|
|
20827
20846
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
20828
20847
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
20829
20848
|
|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>).|
|
|
@@ -20862,9 +20881,9 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
20862
20881
|
| --- | --- | --- |
|
|
20863
20882
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence.|
|
|
20864
20883
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds|
|
|
20865
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
20884
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
20866
20885
|
|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> |
|
|
20867
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity.|
|
|
20886
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity.|
|
|
20868
20887
|
|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.|
|
|
20869
20888
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds.|
|
|
20870
20889
|
|unit<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric.|
|
|
@@ -20877,7 +20896,7 @@ The request to change ownership of an object.
|
|
|
20877
20896
|
|
|
20878
20897
|
| Name | Type | Description |
|
|
20879
20898
|
| --- | --- | --- |
|
|
20880
|
-
|newOwner|<a href="#identity"
|
|
20899
|
+
|newOwner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users).|
|
|
20881
20900
|
|
|
20882
20901
|
### TruncatableListAttackRequestHeader
|
|
20883
20902
|
|
|
@@ -20885,8 +20904,8 @@ A list of values that has possibly been truncated.
|
|
|
20885
20904
|
|
|
20886
20905
|
| Name | Type | Description |
|
|
20887
20906
|
| --- | --- | --- |
|
|
20888
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation.|
|
|
20889
|
-
|values|Array<<a href="#attackrequestheader"
|
|
20907
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation.|
|
|
20908
|
+
|values|Array<<a href="#attackrequestheader">AttackRequestHeader</a>>|Values of the list.|
|
|
20890
20909
|
|
|
20891
20910
|
### TruncatableListHttpRequestParameter
|
|
20892
20911
|
|
|
@@ -20894,8 +20913,8 @@ A list of values that has possibly been truncated.
|
|
|
20894
20913
|
|
|
20895
20914
|
| Name | Type | Description |
|
|
20896
20915
|
| --- | --- | --- |
|
|
20897
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation.|
|
|
20898
|
-
|values|Array<<a href="#httprequestparameter"
|
|
20916
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation.|
|
|
20917
|
+
|values|Array<<a href="#httprequestparameter">HttpRequestParameter</a>>|Values of the list.|
|
|
20899
20918
|
|
|
20900
20919
|
### TruncatableListString
|
|
20901
20920
|
|
|
@@ -20903,7 +20922,7 @@ A list of values that has possibly been truncated.
|
|
|
20903
20922
|
|
|
20904
20923
|
| Name | Type | Description |
|
|
20905
20924
|
| --- | --- | --- |
|
|
20906
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation.|
|
|
20925
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation.|
|
|
20907
20926
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list.|
|
|
20908
20927
|
|
|
20909
20928
|
### TruncationInfo
|
|
@@ -20923,7 +20942,7 @@ UI customization for defining a button that calls a function when pressed
|
|
|
20923
20942
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description to be shown in a tooltip when hovering over the button|
|
|
20924
20943
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The label of the button|
|
|
20925
20944
|
|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|
|
|
20926
|
-
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition"
|
|
20945
|
+
|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|
|
|
20927
20946
|
|
|
20928
20947
|
### UiCallbackCustomization
|
|
20929
20948
|
|
|
@@ -20931,7 +20950,7 @@ UI customization options for defining custom callbacks
|
|
|
20931
20950
|
|
|
20932
20951
|
| Name | Type | Description |
|
|
20933
20952
|
| --- | --- | --- |
|
|
20934
|
-
|buttons|Array<<a href="#uibuttoncustomization">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed|
|
|
20953
|
+
|buttons|Array<<a href="#uibuttoncustomization" target="_blank" rel="noopener noreferrer">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed|
|
|
20935
20954
|
|
|
20936
20955
|
### UiCustomization
|
|
20937
20956
|
|
|
@@ -20939,10 +20958,10 @@ Customization for UI elements
|
|
|
20939
20958
|
|
|
20940
20959
|
| Name | Type | Description |
|
|
20941
20960
|
| --- | --- | --- |
|
|
20942
|
-
|callback|<a href="#uicallbackcustomization"
|
|
20943
|
-
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|UI customization for expandable section|
|
|
20944
|
-
|table|<a href="#uitablecustomization"
|
|
20945
|
-
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|UI customization for tabs|
|
|
20961
|
+
|callback|<a href="#uicallbackcustomization">UiCallbackCustomization</a>|UI customization options for defining custom callbacks|
|
|
20962
|
+
|expandable|<a href="#uiexpandablecustomization" target="_blank" rel="noopener noreferrer">UiExpandableCustomization</a>|UI customization for expandable section|
|
|
20963
|
+
|table|<a href="#uitablecustomization">UiTableCustomization</a>|Customization for UI tables|
|
|
20964
|
+
|tabs|<a href="#uitabscustomization" target="_blank" rel="noopener noreferrer">UiTabsCustomization</a>|UI customization for tabs|
|
|
20946
20965
|
|
|
20947
20966
|
### UiEmptyStateCustomization
|
|
20948
20967
|
|
|
@@ -20960,7 +20979,7 @@ UI customization for expandable section
|
|
|
20960
20979
|
| --- | --- | --- |
|
|
20961
20980
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name|
|
|
20962
20981
|
|expanded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if the item should be expanded by default|
|
|
20963
|
-
|sections|Array<<a href="#uiexpandablesectioncustomization"
|
|
20982
|
+
|sections|Array<<a href="#uiexpandablesectioncustomization">UiExpandableSectionCustomization</a>>|A list of sections|
|
|
20964
20983
|
|
|
20965
20984
|
### UiExpandableSectionCustomization
|
|
20966
20985
|
|
|
@@ -20993,7 +21012,7 @@ Customization for UI table columns
|
|
|
20993
21012
|
|columnRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced column from the 'tableColumns' property of the schema for this column.<br/><br/><strong>Example:</strong> <code>myCustomColumn</code>|
|
|
20994
21013
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name for this column.<br/><br/><strong>Example:</strong> <code>Color</code>|
|
|
20995
21014
|
|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.<br/><br/><strong>Example:</strong> <code>color</code>|
|
|
20996
|
-
|items|Array<<a href="#uitablecolumnitemcustomization">UiTableColumnItemCustomization</a>>|The possible items of this column.|
|
|
21015
|
+
|items|Array<<a href="#uitablecolumnitemcustomization" target="_blank" rel="noopener noreferrer">UiTableColumnItemCustomization</a>>|The possible items of this column.|
|
|
20997
21016
|
|propertyRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced property for this column.<br/><br/><strong>Example:</strong> <code>apiColor</code>|
|
|
20998
21017
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ui specific type for this column.<br/><br/><strong>Example:</strong> <code>cell-color-picker</code>|
|
|
20999
21018
|
|width|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The width this column should take up on the table.<br/><br/><strong>Example:</strong> <code>10%</code>|
|
|
@@ -21014,8 +21033,8 @@ Customization for UI tables
|
|
|
21014
21033
|
|
|
21015
21034
|
| Name | Type | Description |
|
|
21016
21035
|
| --- | --- | --- |
|
|
21017
|
-
|columns|Array<<a href="#uitablecolumncustomization"
|
|
21018
|
-
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>|UI customization for empty state in a table|
|
|
21036
|
+
|columns|Array<<a href="#uitablecolumncustomization">UiTableColumnCustomization</a>>|A list of columns for the UI table|
|
|
21037
|
+
|emptyState|<a href="#uiemptystatecustomization" target="_blank" rel="noopener noreferrer">UiEmptyStateCustomization</a>|UI customization for empty state in a table|
|
|
21019
21038
|
|
|
21020
21039
|
### UiTabsCustomization
|
|
21021
21040
|
|
|
@@ -21023,7 +21042,7 @@ UI customization for tabs
|
|
|
21023
21042
|
|
|
21024
21043
|
| Name | Type | Description |
|
|
21025
21044
|
| --- | --- | --- |
|
|
21026
|
-
|groups|Array<<a href="#uitabgroupcustomization"
|
|
21045
|
+
|groups|Array<<a href="#uitabgroupcustomization">UiTabGroupCustomization</a>>|A list of groups|
|
|
21027
21046
|
|
|
21028
21047
|
### Unit
|
|
21029
21048
|
|
|
@@ -21053,7 +21072,7 @@ A list of units along with their properties.
|
|
|
21053
21072
|
| Name | Type | Description |
|
|
21054
21073
|
| --- | --- | --- |
|
|
21055
21074
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of units in the result.|
|
|
21056
|
-
|units<sup>*required</sup>|Array<<a href="#unit">Unit</a>>|A list of units.|
|
|
21075
|
+
|units<sup>*required</sup>|Array<<a href="#unit" target="_blank" rel="noopener noreferrer">Unit</a>>|A list of units.|
|
|
21057
21076
|
|
|
21058
21077
|
### UpdateJob
|
|
21059
21078
|
|
|
@@ -21081,7 +21100,7 @@ A list of update jobs of the ActiveGate.
|
|
|
21081
21100
|
| Name | Type | Description |
|
|
21082
21101
|
| --- | --- | --- |
|
|
21083
21102
|
|agId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate.<br/><br/><strong>Example:</strong> <code>0x3efdd092</code>|
|
|
21084
|
-
|updateJobs|Array<<a href="#updatejob"
|
|
21103
|
+
|updateJobs|Array<<a href="#updatejob">UpdateJob</a>>|A list of update jobs of the ActiveGate.|
|
|
21085
21104
|
|
|
21086
21105
|
### UpdateJobsAll
|
|
21087
21106
|
|
|
@@ -21089,7 +21108,7 @@ A list of ActiveGates with update jobs.
|
|
|
21089
21108
|
|
|
21090
21109
|
| Name | Type | Description |
|
|
21091
21110
|
| --- | --- | --- |
|
|
21092
|
-
|allUpdateJobs|Array<<a href="#updatejoblist">UpdateJobList</a>>|A list of ActiveGates with update jobs.|
|
|
21111
|
+
|allUpdateJobs|Array<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>>|A list of ActiveGates with update jobs.|
|
|
21093
21112
|
|
|
21094
21113
|
### UpdatePermissionsRequest
|
|
21095
21114
|
|
|
@@ -21114,7 +21133,7 @@ Basic information about all configured update windows
|
|
|
21114
21133
|
|
|
21115
21134
|
| Name | Type | Description |
|
|
21116
21135
|
| --- | --- | --- |
|
|
21117
|
-
|windows<sup>*required</sup>|Array<<a href="#updatewindow"
|
|
21136
|
+
|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.|
|
|
21118
21137
|
|
|
21119
21138
|
### UploadJavaScriptMappingFileAliasBody
|
|
21120
21139
|
|
|
@@ -21135,9 +21154,9 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
21135
21154
|
| Name | Type | Description |
|
|
21136
21155
|
| --- | --- | --- |
|
|
21137
21156
|
|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).|
|
|
21138
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
21157
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential.|
|
|
21139
21158
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set.|
|
|
21140
|
-
|externalVault|<a href="#externalvault"
|
|
21159
|
+
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault|
|
|
21141
21160
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set.|
|
|
21142
21161
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set.|
|
|
21143
21162
|
|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>).|
|
|
@@ -21145,16 +21164,16 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
21145
21164
|
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION"|The scope of the credentials set.|
|
|
21146
21165
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE" | "EXTENSION_AUTHENTICATION">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
21147
21166
|
|type<sup>*required</sup>|"CERTIFICATE" | "PUBLIC_CERTIFICATE" | "TOKEN" | "USERNAME_PASSWORD" | "AWS_MONITORING_KEY_BASED" | "AWS_MONITORING_ROLE_BASED" | "SNMPV3"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> <li><code>SNMPV3</code> -> SNMPV3Credentials</li> <li><code>AWS_MONITORING_KEY_BASED</code> -> AWSKeyBasedCredentialsDto</li> <li><code>AWS_MONITORING_ROLE_BASED</code> -> AWSRoleBasedCredentials</li> </ul> |
|
|
21148
|
-
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set.|
|
|
21167
|
+
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set. Must not contain any ":" character.|
|
|
21149
21168
|
|
|
21150
21169
|
### ValidationResponse
|
|
21151
21170
|
|
|
21152
21171
|
| Name | Type |
|
|
21153
21172
|
| --- | --- |
|
|
21154
|
-
|error|<a href="#metricingesterror">MetricIngestError</a>|
|
|
21173
|
+
|error|<a href="#metricingesterror" target="_blank" rel="noopener noreferrer">MetricIngestError</a>|
|
|
21155
21174
|
|linesInvalid|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
21156
21175
|
|linesOk|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
21157
|
-
|warnings|<a href="#warnings"
|
|
21176
|
+
|warnings|<a href="#warnings">Warnings</a>|
|
|
21158
21177
|
|
|
21159
21178
|
### ValidationRuleDto
|
|
21160
21179
|
|
|
@@ -21165,7 +21184,7 @@ Validation rule of Browser Monitor step.
|
|
|
21165
21184
|
|failIfFound<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if we should fail on found pattern. If not defined in request, it will be set to false by default.|
|
|
21166
21185
|
|matchingPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Text pattern that should match on the website.|
|
|
21167
21186
|
|regex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if the "matchingPattern" value is a regex. If not defined in request, it will be set to false by default.|
|
|
21168
|
-
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step.|
|
|
21187
|
+
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step.|
|
|
21169
21188
|
|type<sup>*required</sup>|"TEXT_MATCH" | "CONTENT_MATCH" | "ELEMENT_MATCH"|Type of validation.|
|
|
21170
21189
|
|
|
21171
21190
|
### ValidationWaitConditionDto
|
|
@@ -21176,7 +21195,7 @@ Validation wait condition for Browser Monitor step.
|
|
|
21176
21195
|
| --- | --- | --- |
|
|
21177
21196
|
|timeoutInMilliseconds<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Validation timeout in milliseconds.<br/><br/><strong>Minimum:</strong> <code>0</code>|
|
|
21178
21197
|
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
21179
|
-
|validationRule<sup>*required</sup>|<a href="#validationruledto"
|
|
21198
|
+
|validationRule<sup>*required</sup>|<a href="#validationruledto">ValidationRuleDto</a>|Validation rule of Browser Monitor step.|
|
|
21180
21199
|
|
|
21181
21200
|
### VisuallyCompleteOptionsDto
|
|
21182
21201
|
|
|
@@ -21196,11 +21215,11 @@ Describes the exploited vulnerability.
|
|
|
21196
21215
|
|
|
21197
21216
|
| Name | Type | Description |
|
|
21198
21217
|
| --- | --- | --- |
|
|
21199
|
-
|codeLocation|<a href="#codelocation">CodeLocation</a>|Information about a code location.|
|
|
21218
|
+
|codeLocation|<a href="#codelocation" target="_blank" rel="noopener noreferrer">CodeLocation</a>|Information about a code location.|
|
|
21200
21219
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the vulnerability.|
|
|
21201
21220
|
|vulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the vulnerability.|
|
|
21202
|
-
|vulnerableFunction|<a href="#functiondefinition"
|
|
21203
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability.|
|
|
21221
|
+
|vulnerableFunction|<a href="#functiondefinition">FunctionDefinition</a>|Information about a function definition.|
|
|
21222
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability.|
|
|
21204
21223
|
|
|
21205
21224
|
### VulnerableComponent
|
|
21206
21225
|
|
|
@@ -21231,7 +21250,7 @@ Describes what got passed into the code level vulnerability.
|
|
|
21231
21250
|
|
|
21232
21251
|
| Name | Type | Description |
|
|
21233
21252
|
| --- | --- | --- |
|
|
21234
|
-
|inputSegments|Array<<a href="#vulnerablefunctioninputsegment"
|
|
21253
|
+
|inputSegments|Array<<a href="#vulnerablefunctioninputsegment">VulnerableFunctionInputSegment</a>>|A list of input segments.|
|
|
21235
21254
|
|type|"COMMAND" | "HTTP_CLIENT" | "JNDI" | "SQL_STATEMENT"|The type of the input.|
|
|
21236
21255
|
|
|
21237
21256
|
### VulnerableFunctionInputSegment
|
|
@@ -21249,7 +21268,7 @@ A vulnerable function including its usage by specific process groups in context
|
|
|
21249
21268
|
|
|
21250
21269
|
| Name | Type | Description |
|
|
21251
21270
|
| --- | --- | --- |
|
|
21252
|
-
|function|<a href="#vulnerablefunction">VulnerableFunction</a>|Defines an vulnerable function.|
|
|
21271
|
+
|function|<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>|Defines an vulnerable function.|
|
|
21253
21272
|
|processGroupsInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is in use.|
|
|
21254
21273
|
|processGroupsNotAvailable|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where information about the usage of this function not available.|
|
|
21255
21274
|
|processGroupsNotInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is not in use.|
|
|
@@ -21262,8 +21281,8 @@ Optional: A list of vulnerable function usages per process group for a security
|
|
|
21262
21281
|
|
|
21263
21282
|
| Name | Type | Description |
|
|
21264
21283
|
| --- | --- | --- |
|
|
21265
|
-
|vulnerableFunctions|Array<<a href="#vulnerablefunctionprocessgroups"
|
|
21266
|
-
|vulnerableFunctionsByProcessGroup|Array<<a href="#processgroupvulnerablefunctions">ProcessGroupVulnerableFunctions</a>>|<p>A list of vulnerable function usages per process group for a security problem. The result is sorted based on the following criteria:</p> <ul> <li>the number of vulnerable functions in use (descending).</li> <li>the number of vulnerable functions not in use (descending).</li> <li>the number of vulnerable functions not available (descending).</li> <li>the process group identifier (ascending)</li> </ul> |
|
|
21284
|
+
|vulnerableFunctions|Array<<a href="#vulnerablefunctionprocessgroups">VulnerableFunctionProcessGroups</a>>|A list of vulnerable functions, their security problem wide usages and their usages per process group.|
|
|
21285
|
+
|vulnerableFunctionsByProcessGroup|Array<<a href="#processgroupvulnerablefunctions" target="_blank" rel="noopener noreferrer">ProcessGroupVulnerableFunctions</a>>|<p>A list of vulnerable function usages per process group for a security problem. The result is sorted based on the following criteria:</p> <ul> <li>the number of vulnerable functions in use (descending).</li> <li>the number of vulnerable functions not in use (descending).</li> <li>the number of vulnerable functions not available (descending).</li> <li>the process group identifier (ascending)</li> </ul> |
|
|
21267
21286
|
|
|
21268
21287
|
### WarningLine
|
|
21269
21288
|
|
|
@@ -21276,7 +21295,7 @@ Optional: A list of vulnerable function usages per process group for a security
|
|
|
21276
21295
|
|
|
21277
21296
|
| Name | Type |
|
|
21278
21297
|
| --- | --- |
|
|
21279
|
-
|changedMetricKeys|Array<<a href="#warningline"
|
|
21298
|
+
|changedMetricKeys|Array<<a href="#warningline">WarningLine</a>>|
|
|
21280
21299
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
21281
21300
|
|
|
21282
21301
|
### AnyValue
|
|
@@ -23983,7 +24002,7 @@ The type of default aggregation.
|
|
|
23983
24002
|
|
|
23984
24003
|
<div class="padding-left--md">
|
|
23985
24004
|
|
|
23986
|
-
`AsGauge` | `Default` | `Delta` | `EvaluateModel` | `Filter` | `Fold` | `Histogram` | `Last` | `LastReal` | `Limit` | `Merge` | `Names` | `Parents` | `Partition` | `Rate` | `Rollup` | `SetUnit` | `Smooth` | `Sort` | `SplitBy` | `Timeshift` | `ToUnit`
|
|
24005
|
+
`AsGauge` | `AsHistogram` | `Default` | `Delta` | `EvaluateModel` | `Filter` | `Fold` | `Histogram` | `Last` | `LastReal` | `Limit` | `Merge` | `Names` | `Parents` | `Partition` | `Rate` | `Rollup` | `SetUnit` | `Smooth` | `Sort` | `SplitBy` | `Timeshift` | `ToUnit`
|
|
23987
24006
|
|
|
23988
24007
|
</div>
|
|
23989
24008
|
|