@dynatrace-sdk/client-classic-environment-v2 3.6.7 → 3.7.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.
Files changed (62) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +65 -71
  3. package/cjs/index.js +867 -776
  4. package/dynatrace-metadata.json +5 -4
  5. package/esm/index.js +867 -776
  6. package/package.json +1 -1
  7. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +4 -1
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-agent-tokens-api.d.ts +4 -1
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +4 -1
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +4 -1
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +4 -1
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +6 -3
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +4 -1
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +4 -1
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/api-client-options.d.ts +7 -0
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +4 -1
  17. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +4 -1
  18. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +4 -1
  19. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +4 -1
  20. package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +4 -1
  21. package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +4 -1
  22. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +4 -1
  23. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +19 -26
  24. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +4 -1
  25. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +4 -1
  26. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +4 -1
  27. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +4 -1
  28. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +4 -1
  29. package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +4 -1
  30. package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +4 -1
  31. package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +4 -1
  32. package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +4 -1
  33. package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +4 -1
  34. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +4 -1
  35. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +6 -3
  36. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +4 -1
  37. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +4 -1
  38. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +4 -1
  39. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +9 -6
  40. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +4 -1
  41. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module-type.d.ts +1 -0
  42. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +1 -1
  43. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +4 -0
  44. package/types/packages/client/classic-environment-v2/src/lib/models/feature-set-details.d.ts +12 -0
  45. package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-disabled-module-item.d.ts +1 -0
  46. package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-enabled-module-item.d.ts +1 -0
  47. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +2 -2
  48. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +4 -6
  49. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.d.ts +8 -1
  50. package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +7 -0
  51. package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-constraint-dto-properties.d.ts → synthetic-monitor-constraint-dto-properties.d.ts} +1 -1
  52. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-constraint-dto.d.ts +14 -0
  53. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +3 -3
  54. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +2 -2
  55. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-thresholds-dto.d.ts +1 -1
  56. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.d.ts +4 -3
  57. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +5 -2
  58. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +3 -3
  59. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +1 -1
  60. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +2 -2
  61. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +7 -0
  62. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.d.ts +0 -14
package/CHANGELOG.md CHANGED
@@ -2,6 +2,25 @@
2
2
 
3
3
  @dynatrace-sdk/client-classic-environment-v2
4
4
 
5
+ ## 3.7.0
6
+
7
+ ### Minor Changes
8
+
9
+ - Fix `getPermissions` operation success response to return proper `AccessorPermissionsList` type instead of `AccessorPermissionsList[]` in **SettingsObjectsAPI**
10
+ - Add new `DEBUGGING` value to `ActiveGateModule.type` enum
11
+ - Add new optional fields (`description`, `displayName`, `isRecommended`) to the `FeatureSetDetails` model
12
+ - Add new optional `browserExecutionSupported` field to the `PrivateSyntheticLocation` and `SyntheticPrivateLocationUpdate` models
13
+ - Made `targetList` field optional in `SyntheticMultiProtocolMonitorStepDto`
14
+ - Add support for optional transformations. (APPDEV-11914)
15
+
16
+ ### Patch Changes
17
+
18
+ - Add fix for 'transformToFormDataField' function. (APPDEV-12478)
19
+
20
+ ## 3.6.8
21
+
22
+ Updated required scopes for `getMonitors` operation and minor documentation updates.
23
+
5
24
  ## 3.6.7
6
25
 
7
26
  ### Patch Changes
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @dynatrace-sdk/client-classic-environment-v2
2
2
 
3
- [![npm](https://img.shields.io/badge/npm-v3.6.7-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.6.7)
3
+ [![npm](https://img.shields.io/badge/npm-v3.7.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.7.0)
4
4
  [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
5
 
6
6
 
@@ -1820,8 +1820,8 @@ The response includes all ActiveGates that are currently connected to the enviro
1820
1820
  | --- | --- | --- |
1821
1821
  |config.autoUpdate|"ENABLED" | "DISABLED"|Filters the resulting set of ActiveGates by the actual state of auto-update. |
1822
1822
  |config.containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Filters the resulting set of ActiveGates to those which are running in container (<code>true</code>) or not (<code>false</code>). |
1823
- |config.disabledModule|Array&lt;"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"&gt;|Filters the resulting set of ActiveGates by the disabled modules. |
1824
- |config.enabledModule|Array&lt;"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"&gt;|Filters the resulting set of ActiveGates by the enabled modules. |
1823
+ |config.disabledModule|Array&lt;"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "DEBUGGING" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"&gt;|Filters the resulting set of ActiveGates by the disabled modules. |
1824
+ |config.enabledModule|Array&lt;"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "DEBUGGING" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"&gt;|Filters the resulting set of ActiveGates by the enabled modules. |
1825
1825
  |config.group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the group.</p> <p>You can specify a partial name. In that case, the <code>CONTAINS</code> operator is used.</p> |
1826
1826
  |config.hostname|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the name of the host it's running on.</p> <p>You can specify a partial name. In that case, the <code>CONTAINS</code> operator is used.</p> |
1827
1827
  |config.loadBalancerAddress|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the Load Balancer address.</p> <p>You can specify a partial address. In that case, the <code>CONTAINS</code> operator is used.</p> |
@@ -5293,41 +5293,29 @@ Ingested logs are stored in the indexed log storage.
5293
5293
 
5294
5294
  This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
5295
5295
 
5296
- The maximum payload size of a single request is **10 MB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
5297
-
5298
- If the ingested payload is a JSON array, the maximum array size is **50000**. Requests with a greater payload are rejected, and the API returns a 413 response code.
5299
-
5300
-
5301
- **Log events per minute (SaaS)**:
5302
-
5303
- Grail tenants: no limit, other tenants: 1M per minute by default.
5304
-
5305
- If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
5306
-
5307
-
5308
- **Log events per minute (Managed)**:
5309
-
5310
- 1k/minute per cluster by default.
5311
-
5312
- If your log data stream within your cluster exceeds the limit, all log events above the limit are ignored.
5313
-
5314
- If you increase resources (RAM) in your nodes, you can increase the limit based on the cluster resources size using an API call or Cluster Management Console (CMC).
5296
+ **High-cardinality attributes:**
5315
5297
 
5298
+ Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren&apos;t listed in log viewer facets. You can still use them in a log viewer advanced search query.
5316
5299
 
5317
- Refresh cluster limit using the API call
5318
5300
 
5319
- See [Update log events per cluster for Log Monitoring](https://dt-url.net/f123yeu).
5301
+ **Limitations:**
5320
5302
 
5303
+ Please refer to the following documentation pages:
5304
+ * [Grail tenant limits](https://docs.dynatrace.com/docs/analyze-explore-automate/logs/lma-limits)
5305
+ * [LM v2 SaaS tenant limits](https://docs.dynatrace.com/docs/analyze-explore-automate/log-monitoring/log-monitoring-limits)
5306
+ * [LM v2 Managed tenant limits](https://docs.dynatrace.com/managed/analyze-explore-automate/log-monitoring/log-monitoring-limits)
5321
5307
 
5322
- Refresh cluster limit using Cluster Management Console (CMC)
5323
5308
 
5324
- 1. In the CMC, select **Environments** and the environment for which you wish to update the total log events per cluster.
5309
+ **Error handling:**
5325
5310
 
5326
- 2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
5311
+ The following HTTP status codes are considered retryable:
5327
5312
 
5328
- **High-cardinality attributes:**
5313
+ * 429 Too Many Requests
5314
+ * 502 Bad Gateway
5315
+ * 503 Service Unavailable
5316
+ * 504 Gateway Timeout
5329
5317
 
5330
- Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren&apos;t listed in log viewer facets. You can still use them in a log viewer advanced search query.
5318
+ It is recommended to use an exponential backoff strategy for retrying requests.
5331
5319
 
5332
5320
 
5333
5321
 
@@ -5356,7 +5344,7 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
5356
5344
 
5357
5345
  | Error Type | Error Message |
5358
5346
  |---|---|
5359
- |ErrorEnvelopeError|Failed. The input is invalid. \| Failed. This is due either to the status of your licensing agreement or because you&apos;ve exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). \| Failed. The requested resource doesn&apos;t exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. \| Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. \| Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. \| Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. \| Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. \| Client side error. \| Server side error.|
5347
+ |ErrorEnvelopeError|Failed. The input is invalid. \| Failed. This is due either to the status of your licensing agreement or because you&apos;ve exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). \| Failed. The requested resource doesn&apos;t exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. \| Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. \| Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. \| Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. \| Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. \| Client side error. \| Server side error.|
5360
5348
 
5361
5349
 
5362
5350
  <details>
@@ -9581,7 +9569,7 @@ const data =
9581
9569
  ### getPermissions
9582
9570
 
9583
9571
  <div class="padding-bottom--md">
9584
- <strong>settingsObjectsClient.getPermissions(config): Promise&lt;Array&lt;<a href="#accessorpermissionslist">AccessorPermissionsList</a>&gt;&gt;</strong>
9572
+ <strong>settingsObjectsClient.getPermissions(config): Promise&lt;<a href="#accessorpermissionslist">AccessorPermissionsList</a>&gt;</strong>
9585
9573
 
9586
9574
  <div class="padding-left--md">
9587
9575
 
@@ -11521,7 +11509,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
11521
11509
  Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11522
11510
 
11523
11511
  **Required scope:** environment-api:synthetic-monitors:write
11524
- **Required permission:** environment:roles:viewer
11512
+ **Required permission:** environment:roles:manage-settings
11525
11513
 
11526
11514
 
11527
11515
 
@@ -11583,7 +11571,7 @@ const data =
11583
11571
  Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11584
11572
 
11585
11573
  **Required scope:** environment-api:synthetic-monitors:write
11586
- **Required permission:** environment:roles:viewer
11574
+ **Required permission:** environment:roles:manage-settings
11587
11575
 
11588
11576
 
11589
11577
 
@@ -11645,7 +11633,7 @@ const data =
11645
11633
  Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11646
11634
 
11647
11635
  **Required scope:** environment-api:synthetic-monitors:read
11648
- **Required permission:** environment:roles:viewer
11636
+ **Required permission:** environment:roles:manage-settings
11649
11637
 
11650
11638
 
11651
11639
 
@@ -11707,7 +11695,7 @@ const data =
11707
11695
  Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11708
11696
 
11709
11697
  **Required scope:** environment-api:synthetic-monitors:read
11710
- **Required permission:** environment:roles:viewer
11698
+ **Required permission:** environment:roles:manage-settings
11711
11699
 
11712
11700
 
11713
11701
 
@@ -11767,7 +11755,7 @@ const data =
11767
11755
  Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
11768
11756
 
11769
11757
  **Required scope:** environment-api:synthetic-monitors:write
11770
- **Required permission:** environment:roles:viewer
11758
+ **Required permission:** environment:roles:manage-settings
11771
11759
 
11772
11760
 
11773
11761
 
@@ -12398,7 +12386,7 @@ Information about ActiveGate module
12398
12386
  |attributes|<a href="#activegatemoduleattributes">ActiveGateModuleAttributes</a>|The attributes of the ActiveGate module. |
12399
12387
  |enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is enabled (<code>true</code>) or disabled (<code>false</code>). |
12400
12388
  |misconfigured|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is misconfigured (<code>true</code>) or not (<code>false</code>). |
12401
- |type|"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"|The type of ActiveGate module. |
12389
+ |type|"SYNTHETIC" &#124; "AWS" &#124; "AZURE" &#124; "BEACON_FORWARDER" &#124; "CLOUD_FOUNDRY" &#124; "DB_INSIGHT" &#124; "DEBUGGING" &#124; "EXTENSIONS_V1" &#124; "EXTENSIONS_V2" &#124; "KUBERNETES" &#124; "LOGS" &#124; "MEMORY_DUMPS" &#124; "METRIC_API" &#124; "ONE_AGENT_ROUTING" &#124; "OTLP_INGEST" &#124; "REST_API" &#124; "VMWARE" &#124; "Z_OS"|The type of ActiveGate module. |
12402
12390
  |version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the ActiveGate module. |
12403
12391
 
12404
12392
  ### ActiveGateModuleAttributes
@@ -13071,6 +13059,7 @@ A constraint on the values accepted for a settings property.
13071
13059
  | --- | --- | --- |
13072
13060
  |customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
13073
13061
  |customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
13062
+ |disallowDangerousRegex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to disallow usage of dangerous regexes |
13074
13063
  |maxLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed length of string values. |
13075
13064
  |maximum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed value. |
13076
13065
  |minLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum required length of string values. |
@@ -14072,6 +14061,9 @@ Additional information about a Feature Set
14072
14061
 
14073
14062
  | Name | Type | Description |
14074
14063
  | --- | --- | --- |
14064
+ |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional description for the FeatureSet |
14065
+ |displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional display name of the FeatureSet |
14066
+ |isRecommended|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Marks the feature set as recommended (selected by default during activation) |
14075
14067
  |metrics|Array&lt;<a href="#metricdto" target="_blank" rel="noopener noreferrer">MetricDto</a>&gt;|Feature set metrics |
14076
14068
 
14077
14069
  ### Filter
@@ -14931,6 +14923,7 @@ Configuration of a private synthetic location.
14931
14923
  |availabilityLocationOutage|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
14932
14924
  |availabilityNodeOutage|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
14933
14925
  |availabilityNotificationsEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
14926
+ |browserExecutionSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes if browser monitors will be executed on this location:</p> <ul> <li><code>false</code>: Browser monitor executions disabled.</li> <li><code>true</code>: Browser monitor executions enabled.</li> </ul> |
14934
14927
  |city|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The city of the location. |
14935
14928
  |countryCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go" target="_blank" rel="noopener noreferrer" >GET all countries</a> request.</p> |
14936
14929
  |countryName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The country name of the location. |
@@ -16208,13 +16201,28 @@ A list of synthetic locations.
16208
16201
  | --- | --- | --- |
16209
16202
  |locations<sup>*required</sup>|Array&lt;<a href="#locationcollectionelement">LocationCollectionElement</a>&gt;|A list of synthetic locations. |
16210
16203
 
16204
+ ### SyntheticMonitorConstraintDto
16205
+
16206
+ Synthetic monitor constraint.
16207
+
16208
+ | Name | Type | Description |
16209
+ | --- | --- | --- |
16210
+ |properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDtoProperties</a>|The properties of the constraint. |
16211
+ |type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
16212
+
16213
+ ### SyntheticMonitorConstraintDtoProperties
16214
+
16215
+ The properties of the constraint.
16216
+
16217
+ **type**: Record&lt;string, string | undefined&gt;
16218
+
16211
16219
  ### SyntheticMonitorListDto
16212
16220
 
16213
16221
  List of available synthetic monitors.
16214
16222
 
16215
16223
  | Name | Type | Description |
16216
16224
  | --- | --- | --- |
16217
- |monitors|Array&lt;<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>&gt;|List of monitors. |
16225
+ |monitors|Array&lt;<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>&gt;|List of monitors. |
16218
16226
 
16219
16227
  ### SyntheticMonitorOutageHandlingSettingsDto
16220
16228
 
@@ -16222,11 +16230,11 @@ Outage handling configuration.
16222
16230
 
16223
16231
  | Name | Type | Description |
16224
16232
  | --- | --- | --- |
16225
- |globalConsecutiveOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures for all locations. |
16226
- |globalOutages|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
16233
+ |globalConsecutiveOutageCountThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures for all locations. |
16234
+ |globalOutages<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
16227
16235
  |localConsecutiveOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures. |
16228
16236
  |localLocationOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of failing locations. |
16229
- |localOutages|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
16237
+ |localOutages<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
16230
16238
 
16231
16239
  ### SyntheticMonitorPerformanceThresholdDto
16232
16240
 
@@ -16237,8 +16245,8 @@ The performance threshold rule.
16237
16245
  |aggregation|"AVG" &#124; "MAX" &#124; "MIN"|Aggregation type <i>default:</i> <code>"AVG"</code>|
16238
16246
  |dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
16239
16247
  |samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
16240
- |stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
16241
- |threshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> milliseconds to execute. |
16248
+ |stepIndex<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
16249
+ |threshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> milliseconds to execute. |
16242
16250
  |violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window |
16243
16251
 
16244
16252
  ### SyntheticMonitorPerformanceThresholdsDto
@@ -16247,8 +16255,8 @@ Performance thresholds configuration.
16247
16255
 
16248
16256
  | Name | Type | Description |
16249
16257
  | --- | --- | --- |
16250
- |enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
16251
- |thresholds|Array&lt;<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>&gt;|The list of performance threshold rules. |
16258
+ |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>). |
16259
+ |thresholds|Array&lt;<a href="#syntheticmonitorperformancethresholddto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdDto</a>&gt;|The list of performance threshold rules. |
16252
16260
 
16253
16261
  ### SyntheticMonitorSummaryDto
16254
16262
 
@@ -16261,21 +16269,6 @@ Basic monitor data.
16261
16269
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
16262
16270
  |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "THIRD_PARTY" &#124; "MULTI_PROTOCOL"| |
16263
16271
 
16264
- ### SyntheticMultiProtocolMonitorConstraintDto
16265
-
16266
- The network availability monitor constraint.
16267
-
16268
- | Name | Type | Description |
16269
- | --- | --- | --- |
16270
- |properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>|The properties of the constraint. |
16271
- |type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
16272
-
16273
- ### SyntheticMultiProtocolMonitorConstraintDtoProperties
16274
-
16275
- The properties of the constraint.
16276
-
16277
- **type**: Record&lt;string, string | undefined&gt;
16278
-
16279
16272
  ### SyntheticMultiProtocolMonitorDto
16280
16273
 
16281
16274
  Network Availability monitor.
@@ -16291,9 +16284,9 @@ Network Availability monitor.
16291
16284
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
16292
16285
  |performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
16293
16286
  |steps<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>&gt;|The steps of the monitor. |
16294
- |syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
16287
+ |syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
16295
16288
  |tags|Array&lt;<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>&gt;|<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> |
16296
- |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "THIRD_PARTY" &#124; "MULTI_PROTOCOL"| |
16289
+ |type<sup>*required</sup>|"BROWSER" &#124; "HTTP" &#124; "MULTI_PROTOCOL"|Monitor type. |
16297
16290
 
16298
16291
  ### SyntheticMultiProtocolMonitorStepDto
16299
16292
 
@@ -16301,13 +16294,13 @@ The step of a network availability monitor.
16301
16294
 
16302
16295
  | Name | Type | Description |
16303
16296
  | --- | --- | --- |
16304
- |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>&gt;|The list of constraints which apply to all requests in the step. |
16297
+ |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>&gt;|The list of constraints which apply to all requests in the step. |
16305
16298
  |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
16306
16299
  |properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
16307
16300
  |requestConfigurations<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>&gt;|Request configurations. |
16308
16301
  |requestType<sup>*required</sup>|"ICMP" &#124; "TCP" &#124; "DNS"|Request type. |
16309
16302
  |targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
16310
- |targetList<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Target list. |
16303
+ |targetList|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Target list. |
16311
16304
 
16312
16305
  ### SyntheticMultiProtocolMonitorStepDtoProperties
16313
16306
 
@@ -16317,7 +16310,7 @@ The properties which apply to all requests in the step.
16317
16310
 
16318
16311
  ### SyntheticMultiProtocolMonitorUpdateDto
16319
16312
 
16320
- Network availability monitor.
16313
+ Network Availability monitor.
16321
16314
 
16322
16315
  | Name | Type | Description |
16323
16316
  | --- | --- | --- |
@@ -16338,7 +16331,7 @@ The configuration of a network availability monitor request.
16338
16331
 
16339
16332
  | Name | Type | Description |
16340
16333
  | --- | --- | --- |
16341
- |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDto</a>&gt;|Request constraints. |
16334
+ |constraints<sup>*required</sup>|Array&lt;<a href="#syntheticmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorConstraintDto</a>&gt;|Request constraints. |
16342
16335
 
16343
16336
  ### SyntheticOnDemandBatchStatus
16344
16337
 
@@ -16512,6 +16505,7 @@ Configuration of a private synthetic location
16512
16505
  |availabilityLocationOutage|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
16513
16506
  |availabilityNodeOutage|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
16514
16507
  |availabilityNotificationsEnabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
16508
+ |browserExecutionSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes if browser monitors will be executed on this location:</p> <ul> <li><code>false</code>: Browser monitor executions disabled.</li> <li><code>true</code>: Browser monitor executions enabled.</li> </ul> |
16515
16509
  |city|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The city of the location. |
16516
16510
  |countryCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go" target="_blank" rel="noopener noreferrer" >GET all countries</a> request.</p> |
16517
16511
  |deploymentType|"UNKNOWN" &#124; "KUBERNETES" &#124; "OPENSHIFT" &#124; "STANDARD"|<p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
@@ -17161,7 +17155,7 @@ The type of ActiveGate module.
17161
17155
 
17162
17156
  <div class="padding-left--md">
17163
17157
 
17164
- `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
17158
+ `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `Debugging` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
17165
17159
 
17166
17160
  </div>
17167
17161
 
@@ -18197,7 +18191,7 @@ Type of this filter, determines which other fields are present.Can be any of:
18197
18191
 
18198
18192
  <div class="padding-left--md">
18199
18193
 
18200
- `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
18194
+ `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `Debugging` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
18201
18195
 
18202
18196
  </div>
18203
18197
 
@@ -18215,7 +18209,7 @@ Type of this filter, determines which other fields are present.Can be any of:
18215
18209
 
18216
18210
  <div class="padding-left--md">
18217
18211
 
18218
- `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
18212
+ `Aws` | `Azure` | `BeaconForwarder` | `CloudFoundry` | `DbInsight` | `Debugging` | `ExtensionsV1` | `ExtensionsV2` | `Kubernetes` | `Logs` | `MemoryDumps` | `MetricApi` | `OneAgentRouting` | `OtlpIngest` | `RestApi` | `Synthetic` | `Vmware` | `ZOs`
18219
18213
 
18220
18214
  </div>
18221
18215
 
@@ -20392,13 +20386,13 @@ Aggregation type
20392
20386
 
20393
20387
  <div class="padding-left--md">
20394
20388
 
20395
-
20389
+ Monitor type.
20396
20390
 
20397
20391
  #### Enum keys
20398
20392
 
20399
20393
  <div class="padding-left--md">
20400
20394
 
20401
- `Browser` | `Http` | `MultiProtocol` | `ThirdParty`
20395
+ `Browser` | `Http` | `MultiProtocol`
20402
20396
 
20403
20397
  </div>
20404
20398