@dynatrace-sdk/client-classic-environment-v2 5.1.0 → 5.2.2
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 +19 -0
- package/README.md +647 -212
- package/cjs/index.js +729 -80
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +729 -80
- package/package.json +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +11 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +81 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module-attributes.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log-aggregation-result.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/availability-evidence.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/certificate-credentials.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/chromium-startup-flags-dto-disable-features.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/cookie-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/custom-device-creation-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-allowed-location-dto.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/enablement-dto-origin.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/enablement-dto-performance-metric.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/enablement-dto.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-from-relationships.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-to-relationships.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto-actions.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-feature-sets-details.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-upload-response-dto-feature-sets-details.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/hashicorp-approle.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/interaction-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/item-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/java-script-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/key-strokes-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record-additional-columns.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/maintenance-window-evidence.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-evidence.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-dimension-map.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/navigate-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/node-collection-element.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/node.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/plain-authentication-dto.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/plain-keystrokes-input-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-node-names.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/public-certificate-credentials.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/public-synthetic-location.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto-updates.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-enums.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-maturity.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-table-columns.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-types.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub-maturity.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/secure-authentication-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/secure-keystrokes-input-dto.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event-reason.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/select-option-step-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/service-impact.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/store-log-query-structure.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-configuration-dto.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-request.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-response.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-constraint-dto-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-origin.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto-type.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-primary-grail-tag-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-request.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-response.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-batch-status-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-public-location-update.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/time-wait-condition-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/transactional-evidence.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/validation-wait-condition-dto.d.ts +2 -2
- package/types/packages/http-client/src/index.d.ts +0 -2
- package/types/packages/http-client/src/lib/platform/abort-controller.d.ts +0 -6
- package/types/packages/http-client/src/lib/platform/abort-signal.d.ts +0 -6
- package/types/packages/http-client/src/lib/platform/apply-content-type-header.d.ts +0 -2
- package/types/packages/http-client/src/lib/platform/base-error.d.ts +0 -5
- package/types/packages/http-client/src/lib/platform/binary.d.ts +0 -13
- package/types/packages/http-client/src/lib/platform/data-type-error.d.ts +0 -6
- package/types/packages/http-client/src/lib/platform/decode-form-data.d.ts +0 -48
- package/types/packages/http-client/src/lib/platform/decode-response-body.d.ts +0 -3
- package/types/packages/http-client/src/lib/platform/default-status-validator.d.ts +0 -2
- package/types/packages/http-client/src/lib/platform/encode-request-body.d.ts +0 -2
- package/types/packages/http-client/src/lib/platform/http-client-abort-error.d.ts +0 -7
- package/types/packages/http-client/src/lib/platform/http-client-request-error.d.ts +0 -7
- package/types/packages/http-client/src/lib/platform/http-client-response-error-serializer.d.ts +0 -3
- package/types/packages/http-client/src/lib/platform/http-client-response-error.d.ts +0 -11
- package/types/packages/http-client/src/lib/platform/http-client-response.d.ts +0 -10
- package/types/packages/http-client/src/lib/platform/http-client.d.ts +0 -24
- package/types/packages/http-client/src/lib/platform/index.d.ts +0 -12
- package/types/packages/http-client/src/lib/platform/oauth-http-client.d.ts +0 -41
- package/types/packages/http-client/src/lib/platform/unsupported-operation-error.d.ts +0 -6
- package/types/packages/http-client/src/lib/types/abort-controller.d.ts +0 -14
- package/types/packages/http-client/src/lib/types/abort-signal.d.ts +0 -18
- package/types/packages/http-client/src/lib/types/base-error.d.ts +0 -4
- package/types/packages/http-client/src/lib/types/binary.d.ts +0 -15
- package/types/packages/http-client/src/lib/types/data-type-error.d.ts +0 -14
- package/types/packages/http-client/src/lib/types/data-types.d.ts +0 -36
- package/types/packages/http-client/src/lib/types/form-data-request-body.d.ts +0 -83
- package/types/packages/http-client/src/lib/types/form-data-response-body.d.ts +0 -15
- package/types/packages/http-client/src/lib/types/headers.d.ts +0 -6
- package/types/packages/http-client/src/lib/types/http-client-abort-error.d.ts +0 -15
- package/types/packages/http-client/src/lib/types/http-client-network-error.d.ts +0 -15
- package/types/packages/http-client/src/lib/types/http-client-request-error.d.ts +0 -15
- package/types/packages/http-client/src/lib/types/http-client-request-options.d.ts +0 -42
- package/types/packages/http-client/src/lib/types/http-client-response-error.d.ts +0 -20
- package/types/packages/http-client/src/lib/types/http-client-response.d.ts +0 -33
- package/types/packages/http-client/src/lib/types/http-client.d.ts +0 -24
- package/types/packages/http-client/src/lib/types/index.d.ts +0 -20
- package/types/packages/http-client/src/lib/types/request-body-types.d.ts +0 -26
- package/types/packages/http-client/src/lib/types/response-body-types.d.ts +0 -46
- package/types/packages/http-client/src/lib/types/status-validator.d.ts +0 -7
- package/types/packages/http-client/src/lib/types/unsupported-operation-error.d.ts +0 -14
- package/types/packages/platform/error-handlers/src/index.d.ts +0 -2
- package/types/packages/platform/error-handlers/src/lib/add-global-error-serializer.d.ts +0 -13
- package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts +0 -13
- package/types/packages/platform/error-handlers/src/lib/types/dt-runtime-error-handlers.d.ts +0 -5
- package/types/packages/platform/error-handlers/src/lib/types/error-type.d.ts +0 -9
- package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts +0 -7
- package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts +0 -10
- package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts +0 -16
- package/types/packages/platform/error-handlers/src/lib/types/index.d.ts +0 -6
- package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +0 -10
- package/types/packages/platform/shared/index.d.ts +0 -1
- package/types/packages/platform/shared/utils/get-global-with-dt-runtime.d.ts +0 -1
- package/types/packages/shared-errors/src/api-client-error.d.ts +0 -23
- package/types/packages/shared-errors/src/api-gateway-error.d.ts +0 -37
- package/types/packages/shared-errors/src/client-request-error.d.ts +0 -39
- package/types/packages/shared-errors/src/index.d.ts +0 -5
- package/types/packages/shared-errors/src/invalid-response-error.d.ts +0 -26
- package/types/packages/shared-errors/src/types.d.ts +0 -88
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/5.2.2)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -10,8 +10,6 @@ If you miss a resource, consider using the Dynatrace Environment API v1.
|
|
|
10
10
|
|
|
11
11
|
To read about use cases and examples, see [Dynatrace Documentation](https://dt-url.net/2u23k1k).
|
|
12
12
|
|
|
13
|
-
To authorize, use a valid access token or personal access token. For usage in a Dynatrace app, refer to the [Dynatrace Developer documentation](https://dt-url.net/tb23plz).
|
|
14
|
-
|
|
15
13
|
Notes about compatibility:
|
|
16
14
|
* Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
|
|
17
15
|
* We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.
|
|
@@ -2417,6 +2415,7 @@ const data = await credentialVaultClient.getCredentials({
|
|
|
2417
2415
|
Gets the details of the specified credentials set.
|
|
2418
2416
|
|
|
2419
2417
|
**Required scope:** environment-api:credentials:read
|
|
2418
|
+
**Required permission:** environment:roles:viewer
|
|
2420
2419
|
|
|
2421
2420
|
The credentials set including username/certificate, password or token is included in the response.
|
|
2422
2421
|
|
|
@@ -3705,7 +3704,7 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
3705
3704
|
|
|
3706
3705
|
| Name | Type | Description |
|
|
3707
3706
|
| --- | --- | --- |
|
|
3708
|
-
|config.acceptType<sup>*required</sup>|"application/octet-stream"| |
|
|
3707
|
+
|config.acceptType<sup>*required</sup>|"application/octet-stream" | "application/yaml"| |
|
|
3709
3708
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3710
3709
|
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
3711
3710
|
|
|
@@ -5571,8 +5570,10 @@ It is recommended to use an exponential backoff strategy for retrying requests.
|
|
|
5571
5570
|
| Name | Type | Description |
|
|
5572
5571
|
| --- | --- | --- |
|
|
5573
5572
|
|config.body<sup>*required</sup>|LogMessageJson | LogMessagePlain| |
|
|
5574
|
-
|config.type<sup>*required</sup>|"application/json" | "application/json
|
|
5573
|
+
|config.type<sup>*required</sup>|"application/json; charset=utf-8" | "application/json" | "application/jsonl" | "application/jsonl; charset=utf-8" | "application/jsonlines" | "application/jsonlines+json" | "application/jsonlines+json; charset=utf-8" | "application/jsonlines; charset=utf-8" | "application/x-jsonlines" | "application/x-jsonlines; charset=utf-8" | "application/x-ndjson" | "application/x-ndjson; charset=utf-8" | "text/plain; charset=utf-8"| |
|
|
5575
5574
|
|config.contentType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Allows to provide content type with query parameter. Has priority over value provided in Content-Type header. |
|
|
5575
|
+
|config.structure|"flattened" | "raw"|Specifies the JSON parsing mode for log ingestion (SaaS only). For more details, refer to the <a href="https://dt-url.net/rl03zti" target="_blank" rel="noopener noreferrer" >documentation</a>. |
|
|
5576
|
+
|config.xDynatraceOptions|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|(Optional) Contains ampersand-separated Dynatrace-specific parameters. Query parameter takes precedence over the header value. For more details, refer to the <a href="https://dt-url.net/rl03zti" target="_blank" rel="noopener noreferrer" >documentation</a>. |
|
|
5576
5577
|
|
|
5577
5578
|
|
|
5578
5579
|
|
|
@@ -5681,6 +5682,7 @@ You can additionally limit the output by using pagination:
|
|
|
5681
5682
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of metric schemata in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> <p>If a value higher than 500 is used, only 500 results per page are returned.</p> |
|
|
5682
5683
|
|config.text|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Metric registry search term. Only show metrics that contain the term in their key, display name, or description. Use the <code>metricSelector</code> parameter instead of this one to select a complete metric hierarchy instead of doing a text-based search. |
|
|
5683
5684
|
|config.writtenSince|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulted set of metrics to those that have data points within the specified 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> |
|
|
5685
|
+
|config.writtenSinceMode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Controls how the writtenSince filter is applied.</p> <ul> <li><code>INCLUDE</code>: Includes only metrics that have been written since the specified writtenSince timestamp (filters out metrics not written since then).</li> <li><code>EXCLUDE</code>: Excludes metrics that have been written since the specified writtenSince timestamp (only returns metrics not written since then).</li> </ul> <p>If not specified, the default is <code>INCLUDE</code>.</p> |
|
|
5684
5686
|
|
|
5685
5687
|
|
|
5686
5688
|
|
|
@@ -5716,6 +5718,70 @@ const data = await metricsClient.allMetrics({
|
|
|
5716
5718
|
|
|
5717
5719
|
|
|
5718
5720
|
|
|
5721
|
+
</div>
|
|
5722
|
+
|
|
5723
|
+
|
|
5724
|
+
<a name="bulkdelete"></a>
|
|
5725
|
+
### bulkDelete
|
|
5726
|
+
|
|
5727
|
+
<div class="padding-bottom--md">
|
|
5728
|
+
<strong>metricsClient.bulkDelete(config): Promise<void></strong>
|
|
5729
|
+
|
|
5730
|
+
<div class="padding-left--md">
|
|
5731
|
+
|
|
5732
|
+
Deletes all metrics older than the specified days
|
|
5733
|
+
|
|
5734
|
+
**Required scope:** environment-api:metrics:write
|
|
5735
|
+
**Required permission:** environment:roles:manage-settings
|
|
5736
|
+
|
|
5737
|
+
Deletion cannot be undone! timeframe for minUnusedDays: 30 days - 5 years
|
|
5738
|
+
|
|
5739
|
+
|
|
5740
|
+
|
|
5741
|
+
</div>
|
|
5742
|
+
|
|
5743
|
+
|
|
5744
|
+
#### Parameters
|
|
5745
|
+
|
|
5746
|
+
| Name | Type | Description |
|
|
5747
|
+
| --- | --- | --- |
|
|
5748
|
+
|config.metricSelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the required metric. |
|
|
5749
|
+
|config.minUnusedDays|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The key of the required metric. |
|
|
5750
|
+
|
|
5751
|
+
|
|
5752
|
+
|
|
5753
|
+
|
|
5754
|
+
#### Returns
|
|
5755
|
+
|
|
5756
|
+
| Return type | Status code | Description |
|
|
5757
|
+
|---|---|---|
|
|
5758
|
+
|void|202|Success. The deletion of the metrics has been triggered.|
|
|
5759
|
+
|
|
5760
|
+
|
|
5761
|
+
#### Throws
|
|
5762
|
+
|
|
5763
|
+
| Error Type | Error Message |
|
|
5764
|
+
|---|---|
|
|
5765
|
+
|ErrorEnvelopeError|Client side error. | Server side error.|
|
|
5766
|
+
|
|
5767
|
+
|
|
5768
|
+
<details>
|
|
5769
|
+
<summary>
|
|
5770
|
+
Code example
|
|
5771
|
+
</summary>
|
|
5772
|
+
|
|
5773
|
+
```ts
|
|
5774
|
+
import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
5775
|
+
|
|
5776
|
+
const data = await metricsClient.bulkDelete({
|
|
5777
|
+
metricSelector: "...",
|
|
5778
|
+
});
|
|
5779
|
+
```
|
|
5780
|
+
|
|
5781
|
+
</details>
|
|
5782
|
+
|
|
5783
|
+
|
|
5784
|
+
|
|
5719
5785
|
</div>
|
|
5720
5786
|
|
|
5721
5787
|
|
|
@@ -6258,7 +6324,9 @@ const data =
|
|
|
6258
6324
|
|
|
6259
6325
|
|
|
6260
6326
|
<a name="getentities"></a>
|
|
6261
|
-
### getEntities
|
|
6327
|
+
### ~~getEntities~~
|
|
6328
|
+
|
|
6329
|
+
> ⚠️ **Deprecated**
|
|
6262
6330
|
|
|
6263
6331
|
<div class="padding-bottom--md">
|
|
6264
6332
|
<strong>monitoredEntitiesClient.getEntities(config): Promise<<a href="#entitieslist">EntitiesList</a>></strong>
|
|
@@ -6335,7 +6403,9 @@ const data = await monitoredEntitiesClient.getEntities();
|
|
|
6335
6403
|
|
|
6336
6404
|
|
|
6337
6405
|
<a name="getentity"></a>
|
|
6338
|
-
### getEntity
|
|
6406
|
+
### ~~getEntity~~
|
|
6407
|
+
|
|
6408
|
+
> ⚠️ **Deprecated**
|
|
6339
6409
|
|
|
6340
6410
|
<div class="padding-bottom--md">
|
|
6341
6411
|
<strong>monitoredEntitiesClient.getEntity(config): Promise<<a href="#entity" target="_blank" rel="noopener noreferrer">Entity</a>></strong>
|
|
@@ -6399,7 +6469,9 @@ const data = await monitoredEntitiesClient.getEntity({
|
|
|
6399
6469
|
|
|
6400
6470
|
|
|
6401
6471
|
<a name="getentitytype"></a>
|
|
6402
|
-
### getEntityType
|
|
6472
|
+
### ~~getEntityType~~
|
|
6473
|
+
|
|
6474
|
+
> ⚠️ **Deprecated**
|
|
6403
6475
|
|
|
6404
6476
|
<div class="padding-bottom--md">
|
|
6405
6477
|
<strong>monitoredEntitiesClient.getEntityType(config): Promise<<a href="#entitytype">EntityType</a>></strong>
|
|
@@ -6460,7 +6532,9 @@ const data = await monitoredEntitiesClient.getEntityType({
|
|
|
6460
6532
|
|
|
6461
6533
|
|
|
6462
6534
|
<a name="getentitytypes"></a>
|
|
6463
|
-
### getEntityTypes
|
|
6535
|
+
### ~~getEntityTypes~~
|
|
6536
|
+
|
|
6537
|
+
> ⚠️ **Deprecated**
|
|
6464
6538
|
|
|
6465
6539
|
<div class="padding-bottom--md">
|
|
6466
6540
|
<strong>monitoredEntitiesClient.getEntityTypes(config): Promise<<a href="#entitytypelist" target="_blank" rel="noopener noreferrer">EntityTypeList</a>></strong>
|
|
@@ -6524,7 +6598,9 @@ const data = await monitoredEntitiesClient.getEntityTypes();
|
|
|
6524
6598
|
|
|
6525
6599
|
|
|
6526
6600
|
<a name="pushcustomdevice"></a>
|
|
6527
|
-
### pushCustomDevice
|
|
6601
|
+
### ~~pushCustomDevice~~
|
|
6602
|
+
|
|
6603
|
+
> ⚠️ **Deprecated**
|
|
6528
6604
|
|
|
6529
6605
|
<div class="padding-bottom--md">
|
|
6530
6606
|
<strong>monitoredEntitiesClient.pushCustomDevice(config): Promise<void | <a href="#customdevicecreationresult">CustomDeviceCreationResult</a>></strong>
|
|
@@ -10164,7 +10240,7 @@ Gets the history of settings objects
|
|
|
10164
10240
|
| Name | Type | Description |
|
|
10165
10241
|
| --- | --- | --- |
|
|
10166
10242
|
|config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects |
|
|
10167
|
-
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, <strong>revision,modificationInfo</strong>). Supported fields: <strong>revision</strong>, <strong>jsonPatch</strong>, <strong>jsonBefore</strong>, <strong>jsonAfter</strong>, <strong>objectId</strong>, <strong>type</strong>, <strong>schemaId</strong>, <strong>schemaVersion</strong>, <strong>schemaDisplayName</strong>, <strong>modificationInfo</strong>, <strong>summary</strong>, <strong>source</strong>, <strong>appId</strong>.(optional, default to revision, modificationInfo) |
|
|
10243
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, <strong>revision,modificationInfo</strong>). Supported fields: <strong>revision</strong>, <strong>jsonPatch</strong>, <strong>jsonBefore</strong>, <strong>jsonAfter</strong>, <strong>objectId</strong>, <strong>type</strong>, <strong>schemaId</strong>, <strong>schemaVersion</strong>, <strong>schemaDisplayName</strong>, <strong>modificationInfo</strong>, <strong>summary</strong>, <strong>source</strong>, <strong>appId</strong>, <strong>ownerBefore</strong>, <strong>ownerAfter</strong>.(optional, default to revision, modificationInfo) |
|
|
10168
10244
|
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Filtering is supported on the following fields:</p> <ul> <li><code>objectId</code></li> <li><code>modificationInfo.lastModifiedTime</code></li> </ul> <p>The fields can only be combined with <code>and</code> as a boolean operator. If this parameter is omitted only revisions of the last 2 weeks are returned. If <strong>modificationInfo.lastModifiedTime</strong> does not specify a full range, it will be completed with current time minus 1 year for the missing lower bound or the current time for the upper bound. (optional)</p> |
|
|
10169
10245
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
10170
10246
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
@@ -10952,7 +11028,7 @@ Lists available settings schemas
|
|
|
10952
11028
|
|
|
10953
11029
|
| Name | Type | Description |
|
|
10954
11030
|
| --- | --- | --- |
|
|
10955
|
-
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>schemaId,displayName</code>).</p> <p>Supported fields: <code>schemaId</code>, <code>displayName</code>, <code>latestSchemaVersion</code>, <code>multiObject</code>, <code>ordered</code>, <code>ownerBasedAccessControl</code>.</p> |
|
|
11031
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>schemaId,displayName</code>).</p> <p>Supported fields: <code>schemaId</code>, <code>displayName</code>, <code>maturity</code>, <code>latestSchemaVersion</code>, <code>multiObject</code>, <code>ordered</code>, <code>ownerBasedAccessControl</code>.</p> |
|
|
10956
11032
|
|
|
10957
11033
|
|
|
10958
11034
|
|
|
@@ -11319,11 +11395,11 @@ const data =
|
|
|
11319
11395
|
### getLocationDeploymentApplyCommands
|
|
11320
11396
|
|
|
11321
11397
|
<div class="padding-bottom--md">
|
|
11322
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands(config): Promise<
|
|
11398
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)></strong>
|
|
11323
11399
|
|
|
11324
11400
|
<div class="padding-left--md">
|
|
11325
11401
|
|
|
11326
|
-
Gets list of commands to deploy synthetic location in Kubernetes/Openshift cluster
|
|
11402
|
+
Gets list of commands to deploy synthetic location in Kubernetes/Openshift cluster
|
|
11327
11403
|
|
|
11328
11404
|
**Required scope:** environment-api:synthetic:read
|
|
11329
11405
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -11383,11 +11459,11 @@ const data =
|
|
|
11383
11459
|
### getLocationDeploymentDeleteCommands
|
|
11384
11460
|
|
|
11385
11461
|
<div class="padding-bottom--md">
|
|
11386
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(config): Promise<
|
|
11462
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)></strong>
|
|
11387
11463
|
|
|
11388
11464
|
<div class="padding-left--md">
|
|
11389
11465
|
|
|
11390
|
-
Gets list of commands to delete synthetic location in Kubernetes/Openshift cluster
|
|
11466
|
+
Gets list of commands to delete synthetic location in Kubernetes/Openshift cluster
|
|
11391
11467
|
|
|
11392
11468
|
**Required scope:** environment-api:synthetic:read
|
|
11393
11469
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -11448,11 +11524,11 @@ const data =
|
|
|
11448
11524
|
### getLocationDeploymentYaml
|
|
11449
11525
|
|
|
11450
11526
|
<div class="padding-bottom--md">
|
|
11451
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(config): Promise<
|
|
11527
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(config): Promise<Binary></strong>
|
|
11452
11528
|
|
|
11453
11529
|
<div class="padding-left--md">
|
|
11454
11530
|
|
|
11455
|
-
Gets yaml file content to deploy location in Kubernetes/Openshift cluster
|
|
11531
|
+
Gets yaml file content to deploy location in Kubernetes/Openshift cluster
|
|
11456
11532
|
|
|
11457
11533
|
**Required scope:** environment-api:synthetic:read
|
|
11458
11534
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -11622,6 +11698,190 @@ const data =
|
|
|
11622
11698
|
|
|
11623
11699
|
|
|
11624
11700
|
|
|
11701
|
+
</div>
|
|
11702
|
+
|
|
11703
|
+
|
|
11704
|
+
<a name="getmetricadapterdeploymentapplycommands"></a>
|
|
11705
|
+
### getMetricAdapterDeploymentApplyCommands
|
|
11706
|
+
|
|
11707
|
+
<div class="padding-bottom--md">
|
|
11708
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentApplyCommands(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)></strong>
|
|
11709
|
+
|
|
11710
|
+
<div class="padding-left--md">
|
|
11711
|
+
|
|
11712
|
+
Gets list of commands to deploy metric adapter in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
|
|
11713
|
+
|
|
11714
|
+
**Required scope:** environment-api:synthetic:read
|
|
11715
|
+
**Required permission:** environment:roles:manage-settings
|
|
11716
|
+
|
|
11717
|
+
|
|
11718
|
+
|
|
11719
|
+
</div>
|
|
11720
|
+
|
|
11721
|
+
|
|
11722
|
+
#### Parameters
|
|
11723
|
+
|
|
11724
|
+
| Name | Type | Description |
|
|
11725
|
+
| --- | --- | --- |
|
|
11726
|
+
|config.filename|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filename |
|
|
11727
|
+
|config.namespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Namespace |
|
|
11728
|
+
|config.platform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
|
|
11729
|
+
|
|
11730
|
+
|
|
11731
|
+
|
|
11732
|
+
|
|
11733
|
+
#### Returns
|
|
11734
|
+
|
|
11735
|
+
| Return type | Status code | Description |
|
|
11736
|
+
|---|---|---|
|
|
11737
|
+
|void|200|Success. The response contains the list of commands that needs to be executed to deploy a metric adapter.|
|
|
11738
|
+
|
|
11739
|
+
|
|
11740
|
+
#### Throws
|
|
11741
|
+
|
|
11742
|
+
| Error Type | Error Message |
|
|
11743
|
+
|---|---|
|
|
11744
|
+
|ErrorEnvelopeError|Client side error. | Server side error.|
|
|
11745
|
+
|
|
11746
|
+
|
|
11747
|
+
<details>
|
|
11748
|
+
<summary>
|
|
11749
|
+
Code example
|
|
11750
|
+
</summary>
|
|
11751
|
+
|
|
11752
|
+
```ts
|
|
11753
|
+
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
11754
|
+
|
|
11755
|
+
const data =
|
|
11756
|
+
await syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentApplyCommands();
|
|
11757
|
+
```
|
|
11758
|
+
|
|
11759
|
+
</details>
|
|
11760
|
+
|
|
11761
|
+
|
|
11762
|
+
|
|
11763
|
+
</div>
|
|
11764
|
+
|
|
11765
|
+
|
|
11766
|
+
<a name="getmetricadapterdeploymentdeletecommands"></a>
|
|
11767
|
+
### getMetricAdapterDeploymentDeleteCommands
|
|
11768
|
+
|
|
11769
|
+
<div class="padding-bottom--md">
|
|
11770
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentDeleteCommands(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)></strong>
|
|
11771
|
+
|
|
11772
|
+
<div class="padding-left--md">
|
|
11773
|
+
|
|
11774
|
+
Gets list of commands to delete metric adapter in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
|
|
11775
|
+
|
|
11776
|
+
**Required scope:** environment-api:synthetic:read
|
|
11777
|
+
**Required permission:** environment:roles:manage-settings
|
|
11778
|
+
|
|
11779
|
+
|
|
11780
|
+
|
|
11781
|
+
</div>
|
|
11782
|
+
|
|
11783
|
+
|
|
11784
|
+
#### Parameters
|
|
11785
|
+
|
|
11786
|
+
| Name | Type | Description |
|
|
11787
|
+
| --- | --- | --- |
|
|
11788
|
+
|config.filename|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filename |
|
|
11789
|
+
|config.platform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
|
|
11790
|
+
|
|
11791
|
+
|
|
11792
|
+
|
|
11793
|
+
|
|
11794
|
+
#### Returns
|
|
11795
|
+
|
|
11796
|
+
| Return type | Status code | Description |
|
|
11797
|
+
|---|---|---|
|
|
11798
|
+
|void|200|Success. The response contains the list of commands that needs to be executed to delete a metric adapter.|
|
|
11799
|
+
|
|
11800
|
+
|
|
11801
|
+
#### Throws
|
|
11802
|
+
|
|
11803
|
+
| Error Type | Error Message |
|
|
11804
|
+
|---|---|
|
|
11805
|
+
|ErrorEnvelopeError|Client side error. | Server side error.|
|
|
11806
|
+
|
|
11807
|
+
|
|
11808
|
+
<details>
|
|
11809
|
+
<summary>
|
|
11810
|
+
Code example
|
|
11811
|
+
</summary>
|
|
11812
|
+
|
|
11813
|
+
```ts
|
|
11814
|
+
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
11815
|
+
|
|
11816
|
+
const data =
|
|
11817
|
+
await syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentDeleteCommands();
|
|
11818
|
+
```
|
|
11819
|
+
|
|
11820
|
+
</details>
|
|
11821
|
+
|
|
11822
|
+
|
|
11823
|
+
|
|
11824
|
+
</div>
|
|
11825
|
+
|
|
11826
|
+
|
|
11827
|
+
<a name="getmetricadapterdeploymentyaml"></a>
|
|
11828
|
+
### getMetricAdapterDeploymentYaml
|
|
11829
|
+
|
|
11830
|
+
<div class="padding-bottom--md">
|
|
11831
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentYaml(config): Promise<Binary></strong>
|
|
11832
|
+
|
|
11833
|
+
<div class="padding-left--md">
|
|
11834
|
+
|
|
11835
|
+
Gets yaml file content to deploy metric adapter in Kubernetes/Openshift cluster | maturity=EARLY_ADOPTER
|
|
11836
|
+
|
|
11837
|
+
**Required scope:** environment-api:synthetic:read
|
|
11838
|
+
**Required permission:** environment:roles:manage-settings
|
|
11839
|
+
|
|
11840
|
+
|
|
11841
|
+
|
|
11842
|
+
</div>
|
|
11843
|
+
|
|
11844
|
+
|
|
11845
|
+
#### Parameters
|
|
11846
|
+
|
|
11847
|
+
| Name | Type | Description |
|
|
11848
|
+
| --- | --- | --- |
|
|
11849
|
+
|config.namespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Namespace |
|
|
11850
|
+
|config.platform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. |
|
|
11851
|
+
|
|
11852
|
+
|
|
11853
|
+
|
|
11854
|
+
|
|
11855
|
+
#### Returns
|
|
11856
|
+
|
|
11857
|
+
| Return type | Status code | Description |
|
|
11858
|
+
|---|---|---|
|
|
11859
|
+
|void|200|Success. The response contains the content of deployment yaml file.|
|
|
11860
|
+
|
|
11861
|
+
|
|
11862
|
+
#### Throws
|
|
11863
|
+
|
|
11864
|
+
| Error Type | Error Message |
|
|
11865
|
+
|---|---|
|
|
11866
|
+
|ErrorEnvelopeError|Client side error. | Server side error.|
|
|
11867
|
+
|
|
11868
|
+
|
|
11869
|
+
<details>
|
|
11870
|
+
<summary>
|
|
11871
|
+
Code example
|
|
11872
|
+
</summary>
|
|
11873
|
+
|
|
11874
|
+
```ts
|
|
11875
|
+
import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
11876
|
+
|
|
11877
|
+
const data =
|
|
11878
|
+
await syntheticLocationsNodesAndConfigurationClient.getMetricAdapterDeploymentYaml();
|
|
11879
|
+
```
|
|
11880
|
+
|
|
11881
|
+
</details>
|
|
11882
|
+
|
|
11883
|
+
|
|
11884
|
+
|
|
11625
11885
|
</div>
|
|
11626
11886
|
|
|
11627
11887
|
|
|
@@ -11698,7 +11958,7 @@ const data =
|
|
|
11698
11958
|
Lists all synthetic nodes available in your environment
|
|
11699
11959
|
|
|
11700
11960
|
**Required scope:** environment-api:synthetic:read
|
|
11701
|
-
**Required permission:** environment:roles:
|
|
11961
|
+
**Required permission:** environment:roles:viewer
|
|
11702
11962
|
|
|
11703
11963
|
|
|
11704
11964
|
|
|
@@ -12013,7 +12273,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
12013
12273
|
|
|
12014
12274
|
<div class="padding-left--md">
|
|
12015
12275
|
|
|
12016
|
-
Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12276
|
+
Creates a synthetic monitor definition. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12017
12277
|
|
|
12018
12278
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
12019
12279
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -12075,7 +12335,7 @@ const data =
|
|
|
12075
12335
|
|
|
12076
12336
|
<div class="padding-left--md">
|
|
12077
12337
|
|
|
12078
|
-
Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12338
|
+
Deletes a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12079
12339
|
|
|
12080
12340
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
12081
12341
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -12137,7 +12397,7 @@ const data =
|
|
|
12137
12397
|
|
|
12138
12398
|
<div class="padding-left--md">
|
|
12139
12399
|
|
|
12140
|
-
Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12400
|
+
Gets a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12141
12401
|
|
|
12142
12402
|
**Required scope:** environment-api:synthetic-monitors:read
|
|
12143
12403
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -12199,7 +12459,7 @@ const data =
|
|
|
12199
12459
|
|
|
12200
12460
|
<div class="padding-left--md">
|
|
12201
12461
|
|
|
12202
|
-
Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12462
|
+
Gets all synthetic monitors. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12203
12463
|
|
|
12204
12464
|
**Required scope:** environment-api:synthetic-monitors:read
|
|
12205
12465
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -12213,7 +12473,7 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
|
|
|
12213
12473
|
|
|
12214
12474
|
| Name | Type | Description |
|
|
12215
12475
|
| --- | --- | --- |
|
|
12216
|
-
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors 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.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL'
|
|
12476
|
+
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors 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.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'BROWSER' and 'MULTI_PROTOCOL' are currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag(\[context]key:value,key:value,key)</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-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>Monitor enablement: <code>enabled(true)</code>.</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> |
|
|
12217
12477
|
|
|
12218
12478
|
|
|
12219
12479
|
|
|
@@ -12259,7 +12519,7 @@ const data =
|
|
|
12259
12519
|
|
|
12260
12520
|
<div class="padding-left--md">
|
|
12261
12521
|
|
|
12262
|
-
Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12522
|
+
Updates a synthetic monitor definition for the given monitor ID. Currently browser and network availability monitors only. | maturity=EARLY_ADOPTER
|
|
12263
12523
|
|
|
12264
12524
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
12265
12525
|
**Required permission:** environment:roles:manage-settings
|
|
@@ -12708,17 +12968,17 @@ A credentials set of the `AWS_MONITORING_KEY_BASED` type.
|
|
|
12708
12968
|
|
|
12709
12969
|
| Name | Type | Description |
|
|
12710
12970
|
| --- | --- | --- |
|
|
12711
|
-
|accessKeyID
|
|
12971
|
+
|accessKeyID<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Access Key ID of the credentials set. |
|
|
12712
12972
|
|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). |
|
|
12713
12973
|
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
12714
|
-
|awsPartition
|
|
12974
|
+
|awsPartition<sup>*required</sup>|"CHINA" | "DEFAULT" | "US_GOV"|AWS partition of the credential. |
|
|
12715
12975
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
12716
12976
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
12717
12977
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12718
12978
|
|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>). |
|
|
12719
12979
|
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
12720
12980
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
12721
|
-
|secretKey
|
|
12981
|
+
|secretKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Secret access key of the credential. |
|
|
12722
12982
|
|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> |
|
|
12723
12983
|
|
|
12724
12984
|
### AWSRoleBasedCredentials
|
|
@@ -12727,11 +12987,11 @@ A credentials set of the `AWS_MONITORING_ROLE_BASED` type.
|
|
|
12727
12987
|
|
|
12728
12988
|
| Name | Type | Description |
|
|
12729
12989
|
| --- | --- | --- |
|
|
12730
|
-
|accountID
|
|
12990
|
+
|accountID<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Amazon account ID of the credential. |
|
|
12731
12991
|
|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). |
|
|
12732
12992
|
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
12733
12993
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
12734
|
-
|iamRole
|
|
12994
|
+
|iamRole<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The IAM role name of the credentials set. |
|
|
12735
12995
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
12736
12996
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
12737
12997
|
|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>). |
|
|
@@ -12901,7 +13161,7 @@ Information about ActiveGate module
|
|
|
12901
13161
|
|
|
12902
13162
|
The attributes of the ActiveGate module.
|
|
12903
13163
|
|
|
12904
|
-
**type**: Record<string, string
|
|
13164
|
+
**type**: Record<string, string>
|
|
12905
13165
|
|
|
12906
13166
|
### ActiveGateToken
|
|
12907
13167
|
|
|
@@ -13025,7 +13285,7 @@ Aggregated log records.
|
|
|
13025
13285
|
|
|
13026
13286
|
Aggregated log records.
|
|
13027
13287
|
|
|
13028
|
-
**type**: Record<string, object
|
|
13288
|
+
**type**: Record<string, object>
|
|
13029
13289
|
|
|
13030
13290
|
### AlertTemplateDto
|
|
13031
13291
|
|
|
@@ -13338,7 +13598,7 @@ Indicates an entity that has been unavailable during the problem lifespan and th
|
|
|
13338
13598
|
| Name | Type | Description |
|
|
13339
13599
|
| --- | --- | --- |
|
|
13340
13600
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
13341
|
-
|endTime
|
|
13601
|
+
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds. |
|
|
13342
13602
|
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
13343
13603
|
|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> |
|
|
13344
13604
|
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
@@ -13481,13 +13741,13 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
13481
13741
|
| --- | --- | --- |
|
|
13482
13742
|
|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). |
|
|
13483
13743
|
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
13484
|
-
|certificate
|
|
13485
|
-
|certificateFormat
|
|
13744
|
+
|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. |
|
|
13745
|
+
|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. |
|
|
13486
13746
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
13487
13747
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
13488
13748
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
13489
13749
|
|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>). |
|
|
13490
|
-
|password
|
|
13750
|
+
|password<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential encoded in Base64. Must be empty for <code>PEM</code> certificates. |
|
|
13491
13751
|
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
13492
13752
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
13493
13753
|
|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> |
|
|
@@ -13512,7 +13772,7 @@ Chromium startup flags of a Browser Monitor.
|
|
|
13512
13772
|
|
|
13513
13773
|
disable-features map
|
|
13514
13774
|
|
|
13515
|
-
**type**: Record<string, boolean
|
|
13775
|
+
**type**: Record<string, boolean>
|
|
13516
13776
|
|
|
13517
13777
|
### ClientCertificateDto
|
|
13518
13778
|
|
|
@@ -13663,7 +13923,7 @@ Cookie step of Browser Monitor.
|
|
|
13663
13923
|
|
|
13664
13924
|
| Name | Type | Description |
|
|
13665
13925
|
| --- | --- | --- |
|
|
13666
|
-
|cookies
|
|
13926
|
+
|cookies<sup>*required</sup>|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Field containing the list of cookies. |
|
|
13667
13927
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
13668
13928
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
13669
13929
|
|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> |
|
|
@@ -13836,7 +14096,7 @@ Configuration of a custom device.
|
|
|
13836
14096
|
|
|
13837
14097
|
The list of key-value pair properties that will be shown beneath the infographics of your custom device.
|
|
13838
14098
|
|
|
13839
|
-
**type**: Record<string, string
|
|
14099
|
+
**type**: Record<string, string>
|
|
13840
14100
|
|
|
13841
14101
|
### CustomDeviceCreationResult
|
|
13842
14102
|
|
|
@@ -13891,13 +14151,13 @@ Synchronization credentials with CyberArk Vault using allowed machines (location
|
|
|
13891
14151
|
|
|
13892
14152
|
| Name | Type | Description |
|
|
13893
14153
|
| --- | --- | --- |
|
|
13894
|
-
|accountName
|
|
13895
|
-
|applicationId
|
|
14154
|
+
|accountName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
14155
|
+
|applicationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
13896
14156
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
13897
14157
|
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
13898
14158
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
13899
14159
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
13900
|
-
|safeName
|
|
14160
|
+
|safeName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
13901
14161
|
|sourceAuthMethod|"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
13902
14162
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
13903
14163
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
@@ -13909,16 +14169,16 @@ Synchronization credentials with CyberArk Vault using username password authenti
|
|
|
13909
14169
|
|
|
13910
14170
|
| Name | Type | Description |
|
|
13911
14171
|
| --- | --- | --- |
|
|
13912
|
-
|accountName
|
|
13913
|
-
|applicationId
|
|
14172
|
+
|accountName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
14173
|
+
|applicationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
13914
14174
|
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
13915
14175
|
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
13916
14176
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
13917
14177
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
13918
|
-
|safeName
|
|
14178
|
+
|safeName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
13919
14179
|
|sourceAuthMethod|"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
13920
14180
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
13921
|
-
|usernamePasswordForCPM
|
|
14181
|
+
|usernamePasswordForCPM<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Dynatrace credential ID of the username-password pair used for authentication to the CyberArk Central Credential Provider |
|
|
13922
14182
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
13923
14183
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External vault URL. |
|
|
13924
14184
|
|
|
@@ -14038,6 +14298,16 @@ A list of effective settings values.
|
|
|
14038
14298
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
14039
14299
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
14040
14300
|
|
|
14301
|
+
### EnablementDto
|
|
14302
|
+
|
|
14303
|
+
Browser monitor enablement settings.
|
|
14304
|
+
|
|
14305
|
+
| Name | Type | Description |
|
|
14306
|
+
| --- | --- | --- |
|
|
14307
|
+
|enableOnGrail<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Enable 3rd gen JS agent reporting. Relevant only for grail-enabled SaaS environments. |
|
|
14308
|
+
|origin|"UNKNOWN" | "DEFAULT" | "MONITOR" | "TENANT"|Indicates the origin of these settings. |
|
|
14309
|
+
|performanceMetric<sup>*required</sup>|"classic.total_duration" | "duration"|The name of the performance metric, used for reporting on performance charts and for comparison against defined performance thresholds. |
|
|
14310
|
+
|
|
14041
14311
|
### EnrichedManagementZoneDto
|
|
14042
14312
|
|
|
14043
14313
|
| Name | Type | Description |
|
|
@@ -14090,7 +14360,7 @@ The properties of a monitored entity.
|
|
|
14090
14360
|
|
|
14091
14361
|
A list of relationships where the entity occupies the FROM position.
|
|
14092
14362
|
|
|
14093
|
-
**type**: Record<string, EntityId[]
|
|
14363
|
+
**type**: Record<string, EntityId[]>
|
|
14094
14364
|
|
|
14095
14365
|
### EntityIcon
|
|
14096
14366
|
|
|
@@ -14140,7 +14410,7 @@ A short representation of a monitored entity.
|
|
|
14140
14410
|
|
|
14141
14411
|
A list of relationships where the entity occupies the TO position.
|
|
14142
14412
|
|
|
14143
|
-
**type**: Record<string, EntityId[]
|
|
14413
|
+
**type**: Record<string, EntityId[]>
|
|
14144
14414
|
|
|
14145
14415
|
### EntityType
|
|
14146
14416
|
|
|
@@ -14289,10 +14559,10 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
14289
14559
|
| --- | --- | --- |
|
|
14290
14560
|
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>|Configuration of an event. |
|
|
14291
14561
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
14292
|
-
|endTime
|
|
14562
|
+
|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> |
|
|
14293
14563
|
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14294
|
-
|eventId
|
|
14295
|
-
|eventType
|
|
14564
|
+
|eventId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
14565
|
+
|eventType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
14296
14566
|
|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> |
|
|
14297
14567
|
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
14298
14568
|
|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. |
|
|
@@ -14324,7 +14594,7 @@ Values of event properties with predefined behavior must fulfill the requirement
|
|
|
14324
14594
|
|
|
14325
14595
|
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.
|
|
14326
14596
|
|
|
14327
|
-
**type**: Record<string, string
|
|
14597
|
+
**type**: Record<string, string>
|
|
14328
14598
|
|
|
14329
14599
|
### EventIngestResult
|
|
14330
14600
|
|
|
@@ -14444,7 +14714,7 @@ The evidence details of a problem.
|
|
|
14444
14714
|
|
|
14445
14715
|
Data Source defined action objects
|
|
14446
14716
|
|
|
14447
|
-
**type**: Record<string, JsonNode
|
|
14717
|
+
**type**: Record<string, JsonNode>
|
|
14448
14718
|
|
|
14449
14719
|
### ExecuteActionsResponse
|
|
14450
14720
|
|
|
@@ -14570,7 +14840,7 @@ A list of extension events.
|
|
|
14570
14840
|
|
|
14571
14841
|
Details of feature sets
|
|
14572
14842
|
|
|
14573
|
-
**type**: Record<string, FeatureSetDetails
|
|
14843
|
+
**type**: Record<string, FeatureSetDetails>
|
|
14574
14844
|
|
|
14575
14845
|
### ExtensionInfo
|
|
14576
14846
|
|
|
@@ -14653,7 +14923,7 @@ A list of extensions with additional metadata.
|
|
|
14653
14923
|
|
|
14654
14924
|
Details of feature sets
|
|
14655
14925
|
|
|
14656
|
-
**type**: Record<string, FeatureSetDetails
|
|
14926
|
+
**type**: Record<string, FeatureSetDetails>
|
|
14657
14927
|
|
|
14658
14928
|
### ExternalVault
|
|
14659
14929
|
|
|
@@ -14801,13 +15071,13 @@ Synchronization credentials with HashiCorp Vault using appRole authentication me
|
|
|
14801
15071
|
| --- | --- | --- |
|
|
14802
15072
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
14803
15073
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
14804
|
-
|pathToCredentials
|
|
14805
|
-
|roleId
|
|
14806
|
-
|secretId
|
|
15074
|
+
|pathToCredentials<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Path to folder where credentials in HashiCorp Vault are stored. |
|
|
15075
|
+
|roleId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Role ID is similar to username when you want to authenticate in HashiCorp Vault using AppRole. |
|
|
15076
|
+
|secretId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Secret ID is similar to password when you want to authenticate in HashiCorp Vault using AppRole. ID of token representing secret ID saved in Dynatrace CV. |
|
|
14807
15077
|
|sourceAuthMethod|"AZURE_KEY_VAULT_CLIENT_SECRET" | "CYBERARK_VAULT_ALLOWED_LOCATION" | "CYBERARK_VAULT_USERNAME_PASSWORD" | "HASHICORP_VAULT_APPROLE" | "HASHICORP_VAULT_CERTIFICATE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
14808
15078
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
14809
15079
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
14810
|
-
|vaultNamespace
|
|
15080
|
+
|vaultNamespace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Vault namespace in HashiCorp Vault. It is an information you set as environmental variable VAULT_NAMESPACE if you are accessing HashiCorp Vault from command line. |
|
|
14811
15081
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External vault URL. |
|
|
14812
15082
|
|
|
14813
15083
|
### HashicorpApproleConfig
|
|
@@ -14940,7 +15210,7 @@ Interaction step of Browser Monitor.
|
|
|
14940
15210
|
|
|
14941
15211
|
| Name | Type | Description |
|
|
14942
15212
|
| --- | --- | --- |
|
|
14943
|
-
|button
|
|
15213
|
+
|button<sup>*required</sup>|"MOUSE_LEFT" | "MOUSE_MIDDLE" | "MOUSE_RIGHT"|Integer containing the button index. |
|
|
14944
15214
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
14945
15215
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
14946
15216
|
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
@@ -14985,7 +15255,7 @@ An item of a collection property.
|
|
|
14985
15255
|
|
|
14986
15256
|
Metadata of the items.
|
|
14987
15257
|
|
|
14988
|
-
**type**: Record<string, string
|
|
15258
|
+
**type**: Record<string, string>
|
|
14989
15259
|
|
|
14990
15260
|
### JavaScriptAgentSettingsDto
|
|
14991
15261
|
|
|
@@ -15010,7 +15280,7 @@ JavaScript step of Browser Monitor.
|
|
|
15010
15280
|
| Name | Type | Description |
|
|
15011
15281
|
| --- | --- | --- |
|
|
15012
15282
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
15013
|
-
|javaScript
|
|
15283
|
+
|javaScript<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing a script in JavaScript. |
|
|
15014
15284
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15015
15285
|
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
15016
15286
|
|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> |
|
|
@@ -15032,7 +15302,7 @@ Key strokes step of Browser Monitor.
|
|
|
15032
15302
|
| Name | Type | Description |
|
|
15033
15303
|
| --- | --- | --- |
|
|
15034
15304
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
15035
|
-
|input
|
|
15305
|
+
|input<sup>*required</sup>|<a href="#keystrokesinputdto">KeystrokesInputDto</a>|Key strokes step input. |
|
|
15036
15306
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15037
15307
|
|simulateBlurEvent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if blur event should be simulated. |
|
|
15038
15308
|
|simulateReturnKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if return key should be simulated. |
|
|
@@ -15117,7 +15387,7 @@ A single log record.
|
|
|
15117
15387
|
|
|
15118
15388
|
Additional columns of the log record.
|
|
15119
15389
|
|
|
15120
|
-
**type**: Record<string, string[]
|
|
15390
|
+
**type**: Record<string, string[]>
|
|
15121
15391
|
|
|
15122
15392
|
### LogRecordsList
|
|
15123
15393
|
|
|
@@ -15150,11 +15420,11 @@ The maintenance window during which the problem occurred.
|
|
|
15150
15420
|
| Name | Type | Description |
|
|
15151
15421
|
| --- | --- | --- |
|
|
15152
15422
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
15153
|
-
|endTime
|
|
15423
|
+
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds. |
|
|
15154
15424
|
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
15155
15425
|
|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> |
|
|
15156
15426
|
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
15157
|
-
|maintenanceWindowConfigId
|
|
15427
|
+
|maintenanceWindowConfigId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the related maintenance window. |
|
|
15158
15428
|
|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. |
|
|
15159
15429
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
15160
15430
|
|
|
@@ -15194,7 +15464,7 @@ The default aggregation of a metric.
|
|
|
15194
15464
|
| Name | Type | Description |
|
|
15195
15465
|
| --- | --- | --- |
|
|
15196
15466
|
|parameter|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The percentile to be delivered. Valid values are between <code>0</code> and <code>100</code>.</p> <p>Applicable only to the <code>percentile</code> aggregation type.</p> |
|
|
15197
|
-
|type<sup>*required</sup>|"
|
|
15467
|
+
|type<sup>*required</sup>|"auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum" | "value"|The type of default aggregation. |
|
|
15198
15468
|
|
|
15199
15469
|
### MetricDescriptor
|
|
15200
15470
|
|
|
@@ -15202,7 +15472,7 @@ The descriptor of a metric.
|
|
|
15202
15472
|
|
|
15203
15473
|
| Name | Type | Description |
|
|
15204
15474
|
| --- | --- | --- |
|
|
15205
|
-
|aggregationTypes|Array<"
|
|
15475
|
+
|aggregationTypes|Array<"auto" | "avg" | "count" | "max" | "median" | "min" | "percentile" | "sum" | "value">|The list of allowed aggregations for this metric. |
|
|
15206
15476
|
|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> |
|
|
15207
15477
|
|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> |
|
|
15208
15478
|
|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> |
|
|
@@ -15224,7 +15494,7 @@ The descriptor of a metric.
|
|
|
15224
15494
|
|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> |
|
|
15225
15495
|
|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> |
|
|
15226
15496
|
|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> |
|
|
15227
|
-
|transformations|Array<"
|
|
15497
|
+
|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. |
|
|
15228
15498
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
15229
15499
|
|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> |
|
|
15230
15500
|
|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. |
|
|
@@ -15280,16 +15550,16 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
15280
15550
|
| Name | Type | Description |
|
|
15281
15551
|
| --- | --- | --- |
|
|
15282
15552
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
15283
|
-
|endTime
|
|
15553
|
+
|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> |
|
|
15284
15554
|
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
15285
15555
|
|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> |
|
|
15286
15556
|
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
15287
|
-
|metricId
|
|
15557
|
+
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the metric. |
|
|
15288
15558
|
|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. |
|
|
15289
15559
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
15290
|
-
|unit
|
|
15291
|
-
|valueAfterChangePoint
|
|
15292
|
-
|valueBeforeChangePoint
|
|
15560
|
+
|unit<sup>*required</sup>|"Ampere" | "Billion" | "Bit" | "BitPerHour" | "BitPerMinute" | "BitPerSecond" | "Byte" | "BytePerHour" | "BytePerMinute" | "BytePerSecond" | "Cores" | "Count" | "Day" | "DecibelMilliWatt" | "GibiByte" | "GibiBytePerHour" | "GibiBytePerMinute" | "GibiBytePerSecond" | "Giga" | "GigaByte" | "GigaBytePerHour" | "GigaBytePerMinute" | "GigaBytePerSecond" | "Hertz" | "Hour" | "KibiByte" | "KibiBytePerHour" | "KibiBytePerMinute" | "KibiBytePerSecond" | "Kilo" | "KiloByte" | "KiloBytePerHour" | "KiloBytePerMinute" | "KiloBytePerSecond" | "KiloMetrePerHour" | "MSU" | "MebiByte" | "MebiBytePerHour" | "MebiBytePerMinute" | "MebiBytePerSecond" | "Mega" | "MegaByte" | "MegaBytePerHour" | "MegaBytePerMinute" | "MegaBytePerSecond" | "MetrePerHour" | "MetrePerSecond" | "MicroSecond" | "MilliCores" | "MilliSecond" | "MilliSecondPerMinute" | "Million" | "Minute" | "Month" | "NanoSecond" | "NanoSecondPerMinute" | "NotApplicable" | "PerHour" | "PerMinute" | "PerSecond" | "Percent" | "Pixel" | "Promille" | "Ratio" | "Second" | "State" | "Trillion" | "Unspecified" | "Volt" | "Watt" | "Week" | "Year"|The unit of the metric. |
|
|
15561
|
+
|valueAfterChangePoint<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value after the problem start. |
|
|
15562
|
+
|valueBeforeChangePoint<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value before the problem start. |
|
|
15293
15563
|
|
|
15294
15564
|
### MetricIngestError
|
|
15295
15565
|
|
|
@@ -15348,7 +15618,7 @@ Data points of a metric.
|
|
|
15348
15618
|
|
|
15349
15619
|
### MetricSeriesDimensionMap
|
|
15350
15620
|
|
|
15351
|
-
**type**: Record<string, string
|
|
15621
|
+
**type**: Record<string, string>
|
|
15352
15622
|
|
|
15353
15623
|
### MetricValueType
|
|
15354
15624
|
|
|
@@ -15484,8 +15754,8 @@ Key-value parameter of the monitoring state.
|
|
|
15484
15754
|
|
|
15485
15755
|
| Name | Type | Description |
|
|
15486
15756
|
| --- | --- | --- |
|
|
15487
|
-
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the monitoring state
|
|
15488
|
-
|values|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the monitoring state
|
|
15757
|
+
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the monitoring state parameter. |
|
|
15758
|
+
|values|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the monitoring state parameter. |
|
|
15489
15759
|
|
|
15490
15760
|
### MonitoredEntityStates
|
|
15491
15761
|
|
|
@@ -15500,14 +15770,14 @@ Monitoring state of the process group instance.
|
|
|
15500
15770
|
|
|
15501
15771
|
### MonitoredStates
|
|
15502
15772
|
|
|
15503
|
-
A list of
|
|
15773
|
+
A list of process group instances and their monitoring states.
|
|
15504
15774
|
|
|
15505
15775
|
| Name | Type | Description |
|
|
15506
15776
|
| --- | --- | --- |
|
|
15507
15777
|
|monitoringStates|Array<<a href="#monitoredentitystates" target="_blank" rel="noopener noreferrer">MonitoredEntityStates</a>>|A list of process group instances and their monitoring states. |
|
|
15508
15778
|
|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> |
|
|
15509
15779
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
15510
|
-
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of
|
|
15780
|
+
|totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of unique process group instances in the response. |
|
|
15511
15781
|
|
|
15512
15782
|
### MonitoringConfigurationDto
|
|
15513
15783
|
|
|
@@ -15550,7 +15820,7 @@ Step of Browser Monitor that navigates to a website.
|
|
|
15550
15820
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
15551
15821
|
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
15552
15822
|
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
15553
|
-
|url
|
|
15823
|
+
|url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Field containing the url that the monitor should navigate to. |
|
|
15554
15824
|
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
15555
15825
|
|waitCondition|<a href="#basewaitconditiondto" target="_blank" rel="noopener noreferrer">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step. |
|
|
15556
15826
|
|
|
@@ -15577,7 +15847,7 @@ Configuration of a network zone.
|
|
|
15577
15847
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the network zone. |
|
|
15578
15848
|
|numOfConfiguredActiveGates|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of ActiveGates in the network zone. |
|
|
15579
15849
|
|numOfConfiguredOneAgents|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of OneAgents that are configured to use the network zone as primary. |
|
|
15580
|
-
|numOfOneAgentsFromOtherZones|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The number of OneAgents from other network zones that are using ActiveGates in the network zone.</p> <p>This is a fraction of
|
|
15850
|
+
|numOfOneAgentsFromOtherZones|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The number of OneAgents from other network zones that are using ActiveGates in the network zone.</p> <p>This is a fraction of <strong>numOfOneAgentsUsing</strong>.</p> <p>One possible reason for switching to another zone is that a firewall is preventing a OneAgent from connecting to any ActiveGate in the preferred network zone.</p> |
|
|
15581
15851
|
|numOfOneAgentsUsing|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of OneAgents that are using ActiveGates in the network zone. |
|
|
15582
15852
|
|overridesGlobal|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Indicates if a global network zone is overridden (managed only). |
|
|
15583
15853
|
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Specifies the scope of the network zone (managed only). |
|
|
@@ -15622,6 +15892,7 @@ Configuration of a synthetic node.
|
|
|
15622
15892
|
|browserMonitorsEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The synthetic node is able to execute browser monitors (<code>true</code>) or not (<code>false</code>). |
|
|
15623
15893
|
|browserType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The browser type. |
|
|
15624
15894
|
|browserVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The browser version. |
|
|
15895
|
+
|capabilities<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of node's capabilities. |
|
|
15625
15896
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the synthetic node. |
|
|
15626
15897
|
|healthCheckStatus<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The health check status of the synthetic node. |
|
|
15627
15898
|
|hostname<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The hostname of the synthetic node. |
|
|
@@ -15641,6 +15912,7 @@ The short representation of a synthetic object. Only contains the ID and the dis
|
|
|
15641
15912
|
|activeGateVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the Active Gate. |
|
|
15642
15913
|
|autoUpdateEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The Active Gate has the Auto update option enabled ('true') or not ('false') |
|
|
15643
15914
|
|browserMonitorsEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Browser check capabilities enabled flag. |
|
|
15915
|
+
|capabilities<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of node's capabilities. |
|
|
15644
15916
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a node. |
|
|
15645
15917
|
|healthCheckStatus<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The health check status of the synthetic node. |
|
|
15646
15918
|
|hostname<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The hostname of a node. |
|
|
@@ -15688,9 +15960,9 @@ Plain authentication dto for Browser Monitor step.
|
|
|
15688
15960
|
|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
15689
15961
|
|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
15690
15962
|
|inputType<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureAuthenticationDto</li> <li><code>PLAIN</code> -> PlainAuthenticationDto</li> </ul> |
|
|
15691
|
-
|password
|
|
15963
|
+
|password<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the password. |
|
|
15692
15964
|
|type<sup>*required</sup>|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |
|
|
15693
|
-
|username
|
|
15965
|
+
|username<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the username. |
|
|
15694
15966
|
|
|
15695
15967
|
### PlainKeystrokesInputDto
|
|
15696
15968
|
|
|
@@ -15699,7 +15971,7 @@ Credential-based input for keystrokes step.
|
|
|
15699
15971
|
| Name | Type | Description |
|
|
15700
15972
|
| --- | --- | --- |
|
|
15701
15973
|
|masked|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value set to true if key strokes should be masked. If not defined in request, the default value will be set to false. |
|
|
15702
|
-
|textValue
|
|
15974
|
+
|textValue<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String value containing the text. |
|
|
15703
15975
|
|type<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureKeystrokesInputDto</li> <li><code>PLAIN</code> -> PlainKeystrokesInputDto</li> </ul> |
|
|
15704
15976
|
|
|
15705
15977
|
### Precondition
|
|
@@ -15753,7 +16025,7 @@ Configuration of a private synthetic location.
|
|
|
15753
16025
|
|
|
15754
16026
|
A mapping id to name of the nodes belonging to the location.
|
|
15755
16027
|
|
|
15756
|
-
**type**: Record<string, string
|
|
16028
|
+
**type**: Record<string, string>
|
|
15757
16029
|
|
|
15758
16030
|
### Problem
|
|
15759
16031
|
|
|
@@ -15853,7 +16125,7 @@ Configuration of a property in a settings schema.
|
|
|
15853
16125
|
|
|
15854
16126
|
Metadata of the property.
|
|
15855
16127
|
|
|
15856
|
-
**type**: Record<string, string
|
|
16128
|
+
**type**: Record<string, string>
|
|
15857
16129
|
|
|
15858
16130
|
### ProtocolDetails
|
|
15859
16131
|
|
|
@@ -15879,13 +16151,13 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
15879
16151
|
| --- | --- | --- |
|
|
15880
16152
|
|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). |
|
|
15881
16153
|
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
15882
|
-
|certificate
|
|
15883
|
-
|certificateFormat
|
|
16154
|
+
|certificate<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The certificate in the string format. |
|
|
16155
|
+
|certificateFormat<sup>*required</sup>|"UNKNOWN" | "PEM" | "PKCS12"|The certificate format. |
|
|
15884
16156
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
15885
16157
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
15886
16158
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
15887
16159
|
|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>). |
|
|
15888
|
-
|password
|
|
16160
|
+
|password<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (not supported). |
|
|
15889
16161
|
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
15890
16162
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
15891
16163
|
|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> |
|
|
@@ -15898,22 +16170,22 @@ Configuration of a public synthetic location.
|
|
|
15898
16170
|
|
|
15899
16171
|
| Name | Type | Description |
|
|
15900
16172
|
| --- | --- | --- |
|
|
15901
|
-
|browserType
|
|
15902
|
-
|browserVersion
|
|
16173
|
+
|browserType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the browser the location is using to execute browser monitors. |
|
|
16174
|
+
|browserVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the browser the location is using to execute browser monitors. |
|
|
15903
16175
|
|capabilities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of location capabilities. |
|
|
15904
16176
|
|city|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The city of the location. |
|
|
15905
|
-
|cloudPlatform
|
|
16177
|
+
|cloudPlatform<sup>*required</sup>|"AZURE" | "ALIBABA" | "GOOGLE_CLOUD" | "OTHER" | "AMAZON_EC2" | "DYNATRACE_CLOUD" | "INTEROUTE" | "UNDEFINED"|The cloud provider where the location is hosted. |
|
|
15906
16178
|
|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> |
|
|
15907
16179
|
|countryName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The country name of the location. |
|
|
15908
16180
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the location. |
|
|
15909
16181
|
|geoLocationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace GeoLocation ID of the location. |
|
|
15910
|
-
|ips
|
|
16182
|
+
|ips<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of IP addresses assigned to the location. |
|
|
15911
16183
|
|latitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The latitude of the location in <code>DDD.dddd</code> format. |
|
|
15912
16184
|
|longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
15913
16185
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
15914
16186
|
|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> |
|
|
15915
16187
|
|regionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The region name of the location. |
|
|
15916
|
-
|stage
|
|
16188
|
+
|stage<sup>*required</sup>|"BETA" | "COMING_SOON" | "DELETED" | "GA"|The stage of the location. |
|
|
15917
16189
|
|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> |
|
|
15918
16190
|
|type<sup>*required</sup>|"CLUSTER" | "PUBLIC" | "PRIVATE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> PublicSyntheticLocation</li> <li><code>PRIVATE</code> -> PrivateSyntheticLocation</li> <li><code>CLUSTER</code> -> PrivateSyntheticLocation</li> </ul> |
|
|
15919
16191
|
|
|
@@ -16209,7 +16481,7 @@ Map of remediation item ID to tracking link objects.
|
|
|
16209
16481
|
|
|
16210
16482
|
Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.
|
|
16211
16483
|
|
|
16212
|
-
**type**: Record<string, TrackingLinkUpdate
|
|
16484
|
+
**type**: Record<string, TrackingLinkUpdate>
|
|
16213
16485
|
|
|
16214
16486
|
### RemediationProgress
|
|
16215
16487
|
|
|
@@ -16321,6 +16593,8 @@ The diff between two revisions.
|
|
|
16321
16593
|
|jsonPatch|AnyValue|The JSON Patch for this value. May be null if the diff type is not UPDATE. |
|
|
16322
16594
|
|modificationInfo|<a href="#historymodificationinfo" target="_blank" rel="noopener noreferrer">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
16323
16595
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
16596
|
+
|ownerAfter|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
16597
|
+
|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). |
|
|
16324
16598
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
16325
16599
|
|schemaDisplayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema to which the revision belongs. |
|
|
16326
16600
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Schema ID to which the revision belongs. |
|
|
@@ -16489,9 +16763,9 @@ A credentials set of the `SNMPV3` type.
|
|
|
16489
16763
|
|privacyProtocol|"AES" | "AES192" | "AES192C" | "AES256" | "AES256C" | "DES"|The privacy protocol |
|
|
16490
16764
|
|~~scope~~<sup>**DEPRECATED**</sup>|"EXTENSION" | "SYNTHETIC" | "APP_ENGINE"|The scope of the credentials set. |
|
|
16491
16765
|
|scopes<sup>*required</sup>|Array<"EXTENSION" | "SYNTHETIC" | "APP_ENGINE">|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
16492
|
-
|securityLevel
|
|
16766
|
+
|securityLevel<sup>*required</sup>|"AUTH_NO_PRIV" | "AUTH_PRIV" | "NO_AUTH_NO_PRIV"|The security level, supported levels: AUTH_PRIV, NO_AUTH_NO_PRIV, AUTH_NO_PRIV |
|
|
16493
16767
|
|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> |
|
|
16494
|
-
|username
|
|
16768
|
+
|username<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User name value |
|
|
16495
16769
|
|
|
16496
16770
|
### SchemaConstraintRestDto
|
|
16497
16771
|
|
|
@@ -16518,6 +16792,7 @@ A credentials set of the `SNMPV3` type.
|
|
|
16518
16792
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
16519
16793
|
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
16520
16794
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
16795
|
+
|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> |
|
|
16521
16796
|
|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> |
|
|
16522
16797
|
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting. |
|
|
16523
16798
|
|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. |
|
|
@@ -16535,25 +16810,25 @@ A credentials set of the `SNMPV3` type.
|
|
|
16535
16810
|
|
|
16536
16811
|
A list of definitions of enum properties.
|
|
16537
16812
|
|
|
16538
|
-
**type**: Record<string, EnumType
|
|
16813
|
+
**type**: Record<string, EnumType>
|
|
16539
16814
|
|
|
16540
16815
|
### SchemaDefinitionRestDtoMetadata
|
|
16541
16816
|
|
|
16542
16817
|
Metadata of the setting.
|
|
16543
16818
|
|
|
16544
|
-
**type**: Record<string, string
|
|
16819
|
+
**type**: Record<string, string>
|
|
16545
16820
|
|
|
16546
16821
|
### SchemaDefinitionRestDtoProperties
|
|
16547
16822
|
|
|
16548
16823
|
A list of schema's properties.
|
|
16549
16824
|
|
|
16550
|
-
**type**: Record<string, PropertyDefinition
|
|
16825
|
+
**type**: Record<string, PropertyDefinition>
|
|
16551
16826
|
|
|
16552
16827
|
### SchemaDefinitionRestDtoTableColumns
|
|
16553
16828
|
|
|
16554
16829
|
Table column definitions for use in the ui.
|
|
16555
16830
|
|
|
16556
|
-
**type**: Record<string, TableColumn
|
|
16831
|
+
**type**: Record<string, TableColumn>
|
|
16557
16832
|
|
|
16558
16833
|
### SchemaDefinitionRestDtoTypes
|
|
16559
16834
|
|
|
@@ -16561,7 +16836,7 @@ A list of definitions of types.
|
|
|
16561
16836
|
|
|
16562
16837
|
A type is a complex property that contains its own set of subproperties.
|
|
16563
16838
|
|
|
16564
|
-
**type**: Record<string, SchemaType
|
|
16839
|
+
**type**: Record<string, SchemaType>
|
|
16565
16840
|
|
|
16566
16841
|
### SchemaFiles
|
|
16567
16842
|
|
|
@@ -16586,6 +16861,7 @@ The short representation of the settings schema.
|
|
|
16586
16861
|
| --- | --- | --- |
|
|
16587
16862
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema. |
|
|
16588
16863
|
|latestSchemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The most recent version of the schema. |
|
|
16864
|
+
|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> |
|
|
16589
16865
|
|multiObject|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multi-object flag. <code>True</code> if the schema is a multi-object schema |
|
|
16590
16866
|
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Ordered flag. <code>True</code> if the schema is an ordered multi-object schema. |
|
|
16591
16867
|
|ownerBasedAccessControl|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Owner based access control flag. <code>True</code> if the schema has owner based access control enabled. |
|
|
@@ -16614,7 +16890,7 @@ A list of definitions of types.
|
|
|
16614
16890
|
|
|
16615
16891
|
Definition of properties that can be persisted.
|
|
16616
16892
|
|
|
16617
|
-
**type**: Record<string, PropertyDefinition
|
|
16893
|
+
**type**: Record<string, PropertyDefinition>
|
|
16618
16894
|
|
|
16619
16895
|
### SchemasList
|
|
16620
16896
|
|
|
@@ -16629,7 +16905,7 @@ Secure authentication dto for Browser Monitor step.
|
|
|
16629
16905
|
| Name | Type | Description |
|
|
16630
16906
|
| --- | --- | --- |
|
|
16631
16907
|
|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
16632
|
-
|credentialId
|
|
16908
|
+
|credentialId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the username and password credential which will be used for authentication. |
|
|
16633
16909
|
|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type. |
|
|
16634
16910
|
|inputType<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureAuthenticationDto</li> <li><code>PLAIN</code> -> PlainAuthenticationDto</li> </ul> |
|
|
16635
16911
|
|type<sup>*required</sup>|"HTTP_AUTHENTICATION" | "KERBEROS" | "WEBFORM"|Type of authentication. |
|
|
@@ -16640,8 +16916,8 @@ Credential-based input for keystrokes step.
|
|
|
16640
16916
|
|
|
16641
16917
|
| Name | Type | Description |
|
|
16642
16918
|
| --- | --- | --- |
|
|
16643
|
-
|credentialField
|
|
16644
|
-
|credentialId
|
|
16919
|
+
|credentialField<sup>*required</sup>|"TOKEN" | "USERNAME" | "PASSWORD"|Enum value of the credential field. |
|
|
16920
|
+
|credentialId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String value containing the credential id. |
|
|
16645
16921
|
|type<sup>*required</sup>|"PLAIN" | "SECURE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -> SecureKeystrokesInputDto</li> <li><code>PLAIN</code> -> PlainKeystrokesInputDto</li> </ul> |
|
|
16646
16922
|
|
|
16647
16923
|
### SecurityContextDtoImpl
|
|
@@ -16741,7 +17017,7 @@ The event of a security problem.
|
|
|
16741
17017
|
| Name | Type | Description |
|
|
16742
17018
|
| --- | --- | --- |
|
|
16743
17019
|
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event. |
|
|
16744
|
-
|reason|"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED"|The reason of the event creation. |
|
|
17020
|
+
|reason|"ASSESSMENT_CHANGED" | "SECURITY_PROBLEM_CREATED" | "SECURITY_PROBLEM_MUTED" | "SECURITY_PROBLEM_REOPENED" | "SECURITY_PROBLEM_RESOLVED" | "SECURITY_PROBLEM_UNMUTED" | "VULNERABILITY_DISCONTINUED" | "VULNERABILITY_ID_CHANGED"|The reason of the event creation. |
|
|
16745
17021
|
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
16746
17022
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
16747
17023
|
|
|
@@ -16829,7 +17105,7 @@ Select option step of Browser Monitor.
|
|
|
16829
17105
|
| --- | --- | --- |
|
|
16830
17106
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Entity Id. |
|
|
16831
17107
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step. |
|
|
16832
|
-
|selections
|
|
17108
|
+
|selections<sup>*required</sup>|Array<<a href="#selectiondto">SelectionDto</a>>|Field containing the credential. |
|
|
16833
17109
|
|target|<a href="#targetdto" target="_blank" rel="noopener noreferrer">TargetDto</a>|Target of Browser Monitor step. |
|
|
16834
17110
|
|type<sup>*required</sup>|"CLICK" | "COOKIE" | "JAVASCRIPT" | "KEYSTROKES" | "NAVIGATE" | "SELECT_OPTION" | "TAP"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -> NavigateStepDto</li> <li><code>CLICK</code> -> InteractionStepDto</li> <li><code>TAP</code> -> InteractionStepDto</li> <li><code>KEYSTROKES</code> -> KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -> JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -> SelectOptionStepDto</li> <li><code>COOKIE</code> -> CookieStepDto</li> </ul> |
|
|
16835
17111
|
|validationRules|Array<<a href="#validationruledto">ValidationRuleDto</a>>|List of validation rules for the step to perform. |
|
|
@@ -16853,7 +17129,7 @@ Analysis of problem impact to a service.
|
|
|
16853
17129
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
16854
17130
|
|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> |
|
|
16855
17131
|
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
16856
|
-
|numberOfPotentiallyAffectedServiceCalls
|
|
17132
|
+
|numberOfPotentiallyAffectedServiceCalls<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
16857
17133
|
|
|
16858
17134
|
### SettingsObject
|
|
16859
17135
|
|
|
@@ -17037,14 +17313,15 @@ Browser Monitor configuration.
|
|
|
17037
17313
|
|clientCertificates|Array<<a href="#clientcertificatedto">ClientCertificateDto</a>>|Identifier of stored client's certificate. |
|
|
17038
17314
|
|cookies|Array<<a href="#syntheticmonitorcookiedto" target="_blank" rel="noopener noreferrer">SyntheticMonitorCookieDto</a>>|Cookies list. |
|
|
17039
17315
|
|device<sup>*required</sup>|<a href="#testdevicedto">TestDeviceDto</a>|Test device of a Browser Monitor. |
|
|
17040
|
-
|
|
|
17041
|
-
|
|
|
17042
|
-
|
|
|
17043
|
-
|
|
|
17316
|
+
|enablement|<a href="#enablementdto" target="_blank" rel="noopener noreferrer">EnablementDto</a>|Browser monitor enablement settings. |
|
|
17317
|
+
|experimentalProperties|Array<<a href="#monitorpropertydto">MonitorPropertyDto</a>>|Experimental properties list. |
|
|
17318
|
+
|filteredRequests|<a href="#filteredrequestsdto" target="_blank" rel="noopener noreferrer">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor. |
|
|
17319
|
+
|ignoredErrorCodes|<a href="#ignorederrorcodesdto">IgnoredErrorCodesDto</a>|Ignored Error Codes of a Browser Monitor. |
|
|
17320
|
+
|javaScriptSettings|<a href="#javascriptagentsettingsdto" target="_blank" rel="noopener noreferrer">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings. |
|
|
17044
17321
|
|monitorFrames|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default. |
|
|
17045
|
-
|networkThrottling|<a href="#networkthrottlingdto"
|
|
17046
|
-
|proxy|<a href="#proxydto">ProxyDto</a>|Browser Monitor proxy. |
|
|
17047
|
-
|requestHeaderOptions|<a href="#requestheaderoptionsdto"
|
|
17322
|
+
|networkThrottling|<a href="#networkthrottlingdto">NetworkThrottlingDto</a>|Network throttling of a Browser Monitor. |
|
|
17323
|
+
|proxy|<a href="#proxydto" target="_blank" rel="noopener noreferrer">ProxyDto</a>|Browser Monitor proxy. |
|
|
17324
|
+
|requestHeaderOptions|<a href="#requestheaderoptionsdto">RequestHeaderOptionsDto</a>|Header Options of a Browser Monitor. |
|
|
17048
17325
|
|useIESupportedAgent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|useIESupportedAgent flag. If not defined in request, it will be set to false by default. |
|
|
17049
17326
|
|userAgent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User agent |
|
|
17050
17327
|
|
|
@@ -17054,15 +17331,16 @@ Browser monitor update.
|
|
|
17054
17331
|
|
|
17055
17332
|
| Name | Type | Description |
|
|
17056
17333
|
| --- | --- | --- |
|
|
17057
|
-
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
17334
|
+
|configuration<sup>*required</sup>|<a href="#syntheticbrowsermonitorconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorConfigurationDto</a>|Browser Monitor configuration. |
|
|
17058
17335
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
17059
17336
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
17060
17337
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
17061
|
-
|keyPerformanceMetrics|<a href="#keyperformancemetrics"
|
|
17338
|
+
|keyPerformanceMetrics|<a href="#keyperformancemetrics">KeyPerformanceMetrics</a>|The key performance metrics configuration. |
|
|
17062
17339
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
17063
17340
|
|manuallyAssignedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Manually assigned entities. |
|
|
17064
17341
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17065
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17342
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17343
|
+
|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. |
|
|
17066
17344
|
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
17067
17345
|
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17068
17346
|
|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> |
|
|
@@ -17086,9 +17364,10 @@ Browser Monitor.
|
|
|
17086
17364
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
17087
17365
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17088
17366
|
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17089
|
-
|
|
|
17090
|
-
|
|
|
17091
|
-
|
|
|
17367
|
+
|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. |
|
|
17368
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticbrowsermonitorstepdto">SyntheticBrowserMonitorStepDto</a>>|The steps of the monitor. |
|
|
17369
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17370
|
+
|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> |
|
|
17092
17371
|
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
17093
17372
|
|
|
17094
17373
|
### SyntheticBrowserMonitorStepDto
|
|
@@ -17156,7 +17435,7 @@ A list of synthetic locations.
|
|
|
17156
17435
|
|
|
17157
17436
|
| Name | Type | Description |
|
|
17158
17437
|
| --- | --- | --- |
|
|
17159
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
17438
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement" target="_blank" rel="noopener noreferrer">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
17160
17439
|
|
|
17161
17440
|
### SyntheticMonitorConstraintDto
|
|
17162
17441
|
|
|
@@ -17164,14 +17443,14 @@ Synthetic monitor constraint.
|
|
|
17164
17443
|
|
|
17165
17444
|
| Name | Type | Description |
|
|
17166
17445
|
| --- | --- | --- |
|
|
17167
|
-
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties"
|
|
17446
|
+
|properties<sup>*required</sup>|<a href="#syntheticmonitorconstraintdtoproperties">SyntheticMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
17168
17447
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
17169
17448
|
|
|
17170
17449
|
### SyntheticMonitorConstraintDtoProperties
|
|
17171
17450
|
|
|
17172
17451
|
The properties of the constraint.
|
|
17173
17452
|
|
|
17174
|
-
**type**: Record<string, string
|
|
17453
|
+
**type**: Record<string, string>
|
|
17175
17454
|
|
|
17176
17455
|
### SyntheticMonitorCookieDto
|
|
17177
17456
|
|
|
@@ -17190,7 +17469,7 @@ List of available synthetic monitors.
|
|
|
17190
17469
|
|
|
17191
17470
|
| Name | Type | Description |
|
|
17192
17471
|
| --- | --- | --- |
|
|
17193
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
17472
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
17194
17473
|
|
|
17195
17474
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
17196
17475
|
|
|
@@ -17203,6 +17482,7 @@ Outage handling configuration.
|
|
|
17203
17482
|
|localConsecutiveOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of consecutive failures. |
|
|
17204
17483
|
|localLocationOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of failing locations. |
|
|
17205
17484
|
|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. |
|
|
17485
|
+
|origin|"UNKNOWN" | "DEFAULT" | "MONITOR" | "TENANT"|Indicates the origin of these settings. |
|
|
17206
17486
|
|
|
17207
17487
|
### SyntheticMonitorPerformanceThresholdDto
|
|
17208
17488
|
|
|
@@ -17211,12 +17491,12 @@ The performance threshold rule.
|
|
|
17211
17491
|
| Name | Type | Description |
|
|
17212
17492
|
| --- | --- | --- |
|
|
17213
17493
|
|aggregation|"AVG" | "MAX" | "MIN"|Aggregation type <i>default:</i> <code>"AVG"</code>|
|
|
17214
|
-
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
|
|
17215
|
-
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
|
|
17216
|
-
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
|
|
17217
|
-
|threshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em>
|
|
17218
|
-
|type|"MONITOR" | "STEP"|Type of performance threshold |
|
|
17219
|
-
|violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window |
|
|
17494
|
+
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem. |
|
|
17495
|
+
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size). |
|
|
17496
|
+
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. If threshold is monitor-level, no index is needed. |
|
|
17497
|
+
|threshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> time units to execute. For Network Availability monitors the time unit is milliseconds, for browser monitors - seconds. |
|
|
17498
|
+
|type|"MONITOR" | "STEP"|Type of performance threshold. |
|
|
17499
|
+
|violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window. |
|
|
17220
17500
|
|
|
17221
17501
|
### SyntheticMonitorPerformanceThresholdsDto
|
|
17222
17502
|
|
|
@@ -17225,7 +17505,16 @@ Performance thresholds configuration.
|
|
|
17225
17505
|
| Name | Type | Description |
|
|
17226
17506
|
| --- | --- | --- |
|
|
17227
17507
|
|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>). |
|
|
17228
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto"
|
|
17508
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
17509
|
+
|
|
17510
|
+
### SyntheticMonitorPrimaryGrailTagDto
|
|
17511
|
+
|
|
17512
|
+
Primary grail tag key-value pair.
|
|
17513
|
+
|
|
17514
|
+
| Name | Type | Description |
|
|
17515
|
+
| --- | --- | --- |
|
|
17516
|
+
|key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Tag key. |
|
|
17517
|
+
|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Tag value. |
|
|
17229
17518
|
|
|
17230
17519
|
### SyntheticMonitorSummaryDto
|
|
17231
17520
|
|
|
@@ -17249,7 +17538,8 @@ Network Availability monitor.
|
|
|
17249
17538
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
17250
17539
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
17251
17540
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17252
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17541
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17542
|
+
|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. |
|
|
17253
17543
|
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
17254
17544
|
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17255
17545
|
|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> |
|
|
@@ -17269,9 +17559,10 @@ Network Availability monitor.
|
|
|
17269
17559
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
17270
17560
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
17271
17561
|
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
17272
|
-
|
|
|
17273
|
-
|
|
|
17274
|
-
|
|
|
17562
|
+
|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. |
|
|
17563
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
17564
|
+
|syntheticMonitorOutageHandlingSettings<sup>*required</sup>|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
17565
|
+
|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> |
|
|
17275
17566
|
|type<sup>*required</sup>|"BROWSER" | "MULTI_PROTOCOL"|Monitor type. |
|
|
17276
17567
|
|
|
17277
17568
|
### SyntheticMultiProtocolMonitorStepDto
|
|
@@ -17280,10 +17571,10 @@ The step of a network availability monitor.
|
|
|
17280
17571
|
|
|
17281
17572
|
| Name | Type | Description |
|
|
17282
17573
|
| --- | --- | --- |
|
|
17283
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
17574
|
+
|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. |
|
|
17284
17575
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
17285
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties"
|
|
17286
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
17576
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
17577
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
17287
17578
|
|requestType<sup>*required</sup>|"ICMP" | "TCP" | "DNS"|Request type. |
|
|
17288
17579
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
17289
17580
|
|targetList|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -17292,7 +17583,7 @@ The step of a network availability monitor.
|
|
|
17292
17583
|
|
|
17293
17584
|
The properties which apply to all requests in the step.
|
|
17294
17585
|
|
|
17295
|
-
**type**: Record<string, string
|
|
17586
|
+
**type**: Record<string, string>
|
|
17296
17587
|
|
|
17297
17588
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
17298
17589
|
|
|
@@ -17300,7 +17591,7 @@ The configuration of a network availability monitor request.
|
|
|
17300
17591
|
|
|
17301
17592
|
| Name | Type | Description |
|
|
17302
17593
|
| --- | --- | --- |
|
|
17303
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto"
|
|
17594
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmonitorconstraintdto">SyntheticMonitorConstraintDto</a>>|Request constraints. |
|
|
17304
17595
|
|
|
17305
17596
|
### SyntheticOnDemandBatchStatus
|
|
17306
17597
|
|
|
@@ -17312,12 +17603,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
17312
17603
|
|batchStatus<sup>*required</sup>|"SUCCESS" | "FAILED" | "NOT_TRIGGERED" | "FAILED_TO_EXECUTE" | "RUNNING"|The status of the batch. |
|
|
17313
17604
|
|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. |
|
|
17314
17605
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
17315
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
17316
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
17606
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
17607
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
17317
17608
|
|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. |
|
|
17318
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
17609
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
17319
17610
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
17320
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
17611
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
17321
17612
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
17322
17613
|
|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. |
|
|
17323
17614
|
|
|
@@ -17325,7 +17616,7 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
17325
17616
|
|
|
17326
17617
|
String to string map of metadata properties for batch
|
|
17327
17618
|
|
|
17328
|
-
**type**: Record<string, string
|
|
17619
|
+
**type**: Record<string, string>
|
|
17329
17620
|
|
|
17330
17621
|
### SyntheticOnDemandExecution
|
|
17331
17622
|
|
|
@@ -17339,14 +17630,14 @@ Describes the status of an on-demand execution.
|
|
|
17339
17630
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
17340
17631
|
|executionStage<sup>*required</sup>|"TRIGGERED" | "EXECUTED" | "DATA_RETRIEVED" | "NOT_TRIGGERED" | "TIMED_OUT" | "WAITING"|Execution stage. |
|
|
17341
17632
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
17342
|
-
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
17633
|
+
|fullResults|<a href="#executionfullresults" target="_blank" rel="noopener noreferrer">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
17343
17634
|
|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. |
|
|
17344
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata"
|
|
17635
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
17345
17636
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
17346
17637
|
|nextExecutionId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Next execution id for sequential mode. |
|
|
17347
17638
|
|processingMode<sup>*required</sup>|"UNKNOWN" | "NONE" | "STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The processing mode of the execution. |
|
|
17348
17639
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
17349
|
-
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
17640
|
+
|simpleResults|<a href="#executionsimpleresults" target="_blank" rel="noopener noreferrer">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
17350
17641
|
|source<sup>*required</sup>|"API" | "UI"|The source of the triggering request. |
|
|
17351
17642
|
|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. |
|
|
17352
17643
|
|
|
@@ -17354,7 +17645,7 @@ Describes the status of an on-demand execution.
|
|
|
17354
17645
|
|
|
17355
17646
|
Metadata map for the execution batch.
|
|
17356
17647
|
|
|
17357
|
-
**type**: Record<string, string
|
|
17648
|
+
**type**: Record<string, string>
|
|
17358
17649
|
|
|
17359
17650
|
### SyntheticOnDemandExecutionRequest
|
|
17360
17651
|
|
|
@@ -17364,9 +17655,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
17364
17655
|
| --- | --- | --- |
|
|
17365
17656
|
|failOnPerformanceIssue|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code>|
|
|
17366
17657
|
|failOnSslWarning|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code>|
|
|
17367
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup"
|
|
17368
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
17369
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor"
|
|
17658
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
17659
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
17660
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
17370
17661
|
|processingMode|"STANDARD" | "DISABLE_PROBLEM_DETECTION" | "EXECUTIONS_DETAILS_ONLY"|The execution's processing mode <i>default:</i> <code>"STANDARD"</code>|
|
|
17371
17662
|
|stopOnProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code>|
|
|
17372
17663
|
|takeScreenshotsOnSuccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code>|
|
|
@@ -17386,7 +17677,7 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
17386
17677
|
|
|
17387
17678
|
String to string map of metadata properties for execution
|
|
17388
17679
|
|
|
17389
|
-
**type**: Record<string, string
|
|
17680
|
+
**type**: Record<string, string>
|
|
17390
17681
|
|
|
17391
17682
|
### SyntheticOnDemandExecutionRequestMonitor
|
|
17392
17683
|
|
|
@@ -17407,10 +17698,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
17407
17698
|
| Name | Type | Description |
|
|
17408
17699
|
| --- | --- | --- |
|
|
17409
17700
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
17410
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
17701
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
17411
17702
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
17412
17703
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
17413
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails"
|
|
17704
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
17414
17705
|
|
|
17415
17706
|
### SyntheticOnDemandExecutions
|
|
17416
17707
|
|
|
@@ -17418,7 +17709,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
17418
17709
|
|
|
17419
17710
|
| Name | Type | Description |
|
|
17420
17711
|
| --- | --- | --- |
|
|
17421
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
17712
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
17422
17713
|
|
|
17423
17714
|
### SyntheticOnDemandFailedExecutionStatus
|
|
17424
17715
|
|
|
@@ -17449,7 +17740,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
17449
17740
|
|
|
17450
17741
|
| Name | Type | Description |
|
|
17451
17742
|
| --- | --- | --- |
|
|
17452
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails"
|
|
17743
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
17453
17744
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
17454
17745
|
|
|
17455
17746
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -17479,13 +17770,13 @@ Configuration of a private synthetic location
|
|
|
17479
17770
|
|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> |
|
|
17480
17771
|
|deploymentType|"UNKNOWN" | "KUBERNETES" | "OPENSHIFT" | "STANDARD"|<p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
|
|
17481
17772
|
|fipsMode|"ENABLED" | "DISABLED" | "ENABLED_WITH_CORPORATE_PROXY"|<p>Containerized location property indicating whether FIPS mode is enabled on this location:</p> <ul> <li><code>DISABLED</code>: FIPS is not enabled on the location.</li> <li><code>ENABLED</code>: FIPS is enabled on the location.</li> <li><code>ENABLED_WITH_CORPORATE_PROXY</code>: FIPS with corporate proxy is enabled on this location. Default: DISABLED</li> </ul> |
|
|
17482
|
-
|latitude
|
|
17773
|
+
|latitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The latitude of the location in <code>DDD.dddd</code> format. |
|
|
17483
17774
|
|locationNodeOutageDelayInMinutes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
|
|
17484
|
-
|longitude
|
|
17775
|
+
|longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
17485
17776
|
|maxActiveGateCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location). |
|
|
17486
17777
|
|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). |
|
|
17487
17778
|
|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> |
|
|
17488
|
-
|name
|
|
17779
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
17489
17780
|
|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> |
|
|
17490
17781
|
|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> |
|
|
17491
17782
|
|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> |
|
|
@@ -17499,7 +17790,7 @@ The update of a public Synthetic location.
|
|
|
17499
17790
|
|
|
17500
17791
|
| Name | Type | Description |
|
|
17501
17792
|
| --- | --- | --- |
|
|
17502
|
-
|status
|
|
17793
|
+
|status<sup>*required</sup>|"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> |
|
|
17503
17794
|
|type<sup>*required</sup>|"PUBLIC" | "PRIVATE"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> SyntheticPublicLocationUpdate</li> <li><code>PRIVATE</code> -> SyntheticPrivateLocationUpdate</li> </ul> |
|
|
17504
17795
|
|
|
17505
17796
|
### SyntheticPublicLocationsStatus
|
|
@@ -17535,7 +17826,7 @@ Target of Browser Monitor step.
|
|
|
17535
17826
|
|
|
17536
17827
|
| Name | Type | Description |
|
|
17537
17828
|
| --- | --- | --- |
|
|
17538
|
-
|locators<sup>*required</sup>|Array<<a href="#locatordto">LocatorDto</a>>|List of locators. |
|
|
17829
|
+
|locators<sup>*required</sup>|Array<<a href="#locatordto" target="_blank" rel="noopener noreferrer">LocatorDto</a>>|List of locators. |
|
|
17539
17830
|
|window<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target window. |
|
|
17540
17831
|
|
|
17541
17832
|
### TenantToken
|
|
@@ -17552,8 +17843,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
17552
17843
|
|
|
17553
17844
|
| Name | Type | Description |
|
|
17554
17845
|
| --- | --- | --- |
|
|
17555
|
-
|active|<a href="#tenanttoken"
|
|
17556
|
-
|old|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
17846
|
+
|active|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
17847
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token |
|
|
17557
17848
|
|
|
17558
17849
|
### TestDeviceDto
|
|
17559
17850
|
|
|
@@ -17573,7 +17864,7 @@ Time wait condition for Browser Monitor step.
|
|
|
17573
17864
|
|
|
17574
17865
|
| Name | Type | Description |
|
|
17575
17866
|
| --- | --- | --- |
|
|
17576
|
-
|milliseconds
|
|
17867
|
+
|milliseconds<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Wait time in milliseconds. |
|
|
17577
17868
|
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
17578
17869
|
|
|
17579
17870
|
### TimeoutSettingsDto
|
|
@@ -17601,9 +17892,9 @@ A credentials set of the `TOKEN` type.
|
|
|
17601
17892
|
| Name | Type | Description |
|
|
17602
17893
|
| --- | --- | --- |
|
|
17603
17894
|
|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). |
|
|
17604
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
17895
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
17605
17896
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
17606
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
17897
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
17607
17898
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
17608
17899
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
17609
17900
|
|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>). |
|
|
@@ -17641,15 +17932,15 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
17641
17932
|
| Name | Type | Description |
|
|
17642
17933
|
| --- | --- | --- |
|
|
17643
17934
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
17644
|
-
|endTime
|
|
17645
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
17935
|
+
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
17936
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17646
17937
|
|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> |
|
|
17647
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
17938
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
17648
17939
|
|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. |
|
|
17649
17940
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
17650
|
-
|unit
|
|
17651
|
-
|valueAfterChangePoint
|
|
17652
|
-
|valueBeforeChangePoint
|
|
17941
|
+
|unit<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
17942
|
+
|valueAfterChangePoint<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value after the problem start. |
|
|
17943
|
+
|valueBeforeChangePoint<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The metric's value before the problem start. |
|
|
17653
17944
|
|
|
17654
17945
|
### TransferOwnershipRequest
|
|
17655
17946
|
|
|
@@ -17657,7 +17948,7 @@ The request to change ownership of an object.
|
|
|
17657
17948
|
|
|
17658
17949
|
| Name | Type | Description |
|
|
17659
17950
|
| --- | --- | --- |
|
|
17660
|
-
|newOwner|<a href="#identity"
|
|
17951
|
+
|newOwner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
17661
17952
|
|
|
17662
17953
|
### TruncatableListAttackRequestHeader
|
|
17663
17954
|
|
|
@@ -17665,8 +17956,8 @@ A list of values that has possibly been truncated.
|
|
|
17665
17956
|
|
|
17666
17957
|
| Name | Type | Description |
|
|
17667
17958
|
| --- | --- | --- |
|
|
17668
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
17669
|
-
|values|Array<<a href="#attackrequestheader"
|
|
17959
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
17960
|
+
|values|Array<<a href="#attackrequestheader">AttackRequestHeader</a>>|Values of the list. |
|
|
17670
17961
|
|
|
17671
17962
|
### TruncatableListHttpRequestParameter
|
|
17672
17963
|
|
|
@@ -17674,8 +17965,8 @@ A list of values that has possibly been truncated.
|
|
|
17674
17965
|
|
|
17675
17966
|
| Name | Type | Description |
|
|
17676
17967
|
| --- | --- | --- |
|
|
17677
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
17678
|
-
|values|Array<<a href="#httprequestparameter"
|
|
17968
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
17969
|
+
|values|Array<<a href="#httprequestparameter">HttpRequestParameter</a>>|Values of the list. |
|
|
17679
17970
|
|
|
17680
17971
|
### TruncatableListString
|
|
17681
17972
|
|
|
@@ -17683,7 +17974,7 @@ A list of values that has possibly been truncated.
|
|
|
17683
17974
|
|
|
17684
17975
|
| Name | Type | Description |
|
|
17685
17976
|
| --- | --- | --- |
|
|
17686
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
17977
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
17687
17978
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list. |
|
|
17688
17979
|
|
|
17689
17980
|
### TruncationInfo
|
|
@@ -17703,7 +17994,7 @@ UI customization for defining a button that calls a function when pressed
|
|
|
17703
17994
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description to be shown in a tooltip when hovering over the button |
|
|
17704
17995
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The label of the button |
|
|
17705
17996
|
|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 |
|
|
17706
|
-
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition"
|
|
17997
|
+
|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 |
|
|
17707
17998
|
|
|
17708
17999
|
### UiCallbackCustomization
|
|
17709
18000
|
|
|
@@ -17711,7 +18002,7 @@ UI customization options for defining custom callbacks
|
|
|
17711
18002
|
|
|
17712
18003
|
| Name | Type | Description |
|
|
17713
18004
|
| --- | --- | --- |
|
|
17714
|
-
|buttons|Array<<a href="#uibuttoncustomization">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
18005
|
+
|buttons|Array<<a href="#uibuttoncustomization" target="_blank" rel="noopener noreferrer">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
17715
18006
|
|
|
17716
18007
|
### UiCustomization
|
|
17717
18008
|
|
|
@@ -17719,10 +18010,10 @@ Customization for UI elements
|
|
|
17719
18010
|
|
|
17720
18011
|
| Name | Type | Description |
|
|
17721
18012
|
| --- | --- | --- |
|
|
17722
|
-
|callback|<a href="#uicallbackcustomization"
|
|
17723
|
-
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|UI customization for expandable section |
|
|
17724
|
-
|table|<a href="#uitablecustomization"
|
|
17725
|
-
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|UI customization for tabs |
|
|
18013
|
+
|callback|<a href="#uicallbackcustomization">UiCallbackCustomization</a>|UI customization options for defining custom callbacks |
|
|
18014
|
+
|expandable|<a href="#uiexpandablecustomization" target="_blank" rel="noopener noreferrer">UiExpandableCustomization</a>|UI customization for expandable section |
|
|
18015
|
+
|table|<a href="#uitablecustomization">UiTableCustomization</a>|Customization for UI tables |
|
|
18016
|
+
|tabs|<a href="#uitabscustomization" target="_blank" rel="noopener noreferrer">UiTabsCustomization</a>|UI customization for tabs |
|
|
17726
18017
|
|
|
17727
18018
|
### UiEmptyStateCustomization
|
|
17728
18019
|
|
|
@@ -17740,7 +18031,7 @@ UI customization for expandable section
|
|
|
17740
18031
|
| --- | --- | --- |
|
|
17741
18032
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name |
|
|
17742
18033
|
|expanded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if the item should be expanded by default |
|
|
17743
|
-
|sections|Array<<a href="#uiexpandablesectioncustomization"
|
|
18034
|
+
|sections|Array<<a href="#uiexpandablesectioncustomization">UiExpandableSectionCustomization</a>>|A list of sections |
|
|
17744
18035
|
|
|
17745
18036
|
### UiExpandableSectionCustomization
|
|
17746
18037
|
|
|
@@ -17773,7 +18064,7 @@ Customization for UI table columns
|
|
|
17773
18064
|
|columnRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced column from the 'tableColumns' property of the schema for this column. |
|
|
17774
18065
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name for this column. |
|
|
17775
18066
|
|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. |
|
|
17776
|
-
|items|Array<<a href="#uitablecolumnitemcustomization">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
18067
|
+
|items|Array<<a href="#uitablecolumnitemcustomization" target="_blank" rel="noopener noreferrer">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
17777
18068
|
|propertyRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced property for this column. |
|
|
17778
18069
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ui specific type for this column. |
|
|
17779
18070
|
|width|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The width this column should take up on the table. |
|
|
@@ -17794,8 +18085,8 @@ Customization for UI tables
|
|
|
17794
18085
|
|
|
17795
18086
|
| Name | Type | Description |
|
|
17796
18087
|
| --- | --- | --- |
|
|
17797
|
-
|columns|Array<<a href="#uitablecolumncustomization"
|
|
17798
|
-
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>|UI customization for empty state in a table |
|
|
18088
|
+
|columns|Array<<a href="#uitablecolumncustomization">UiTableColumnCustomization</a>>|A list of columns for the UI table |
|
|
18089
|
+
|emptyState|<a href="#uiemptystatecustomization" target="_blank" rel="noopener noreferrer">UiEmptyStateCustomization</a>|UI customization for empty state in a table |
|
|
17799
18090
|
|
|
17800
18091
|
### UiTabsCustomization
|
|
17801
18092
|
|
|
@@ -17803,7 +18094,7 @@ UI customization for tabs
|
|
|
17803
18094
|
|
|
17804
18095
|
| Name | Type | Description |
|
|
17805
18096
|
| --- | --- | --- |
|
|
17806
|
-
|groups|Array<<a href="#uitabgroupcustomization"
|
|
18097
|
+
|groups|Array<<a href="#uitabgroupcustomization">UiTabGroupCustomization</a>>|A list of groups |
|
|
17807
18098
|
|
|
17808
18099
|
### Unit
|
|
17809
18100
|
|
|
@@ -17833,7 +18124,7 @@ A list of units along with their properties.
|
|
|
17833
18124
|
| Name | Type | Description |
|
|
17834
18125
|
| --- | --- | --- |
|
|
17835
18126
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of units in the result. |
|
|
17836
|
-
|units<sup>*required</sup>|Array<<a href="#unit">Unit</a>>|A list of units. |
|
|
18127
|
+
|units<sup>*required</sup>|Array<<a href="#unit" target="_blank" rel="noopener noreferrer">Unit</a>>|A list of units. |
|
|
17837
18128
|
|
|
17838
18129
|
### UpdateJob
|
|
17839
18130
|
|
|
@@ -17861,7 +18152,7 @@ A list of update jobs of the ActiveGate.
|
|
|
17861
18152
|
| Name | Type | Description |
|
|
17862
18153
|
| --- | --- | --- |
|
|
17863
18154
|
|agId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate. |
|
|
17864
|
-
|updateJobs|Array<<a href="#updatejob"
|
|
18155
|
+
|updateJobs|Array<<a href="#updatejob">UpdateJob</a>>|A list of update jobs of the ActiveGate. |
|
|
17865
18156
|
|
|
17866
18157
|
### UpdateJobsAll
|
|
17867
18158
|
|
|
@@ -17869,7 +18160,7 @@ A list of ActiveGates with update jobs.
|
|
|
17869
18160
|
|
|
17870
18161
|
| Name | Type | Description |
|
|
17871
18162
|
| --- | --- | --- |
|
|
17872
|
-
|allUpdateJobs|Array<<a href="#updatejoblist">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
18163
|
+
|allUpdateJobs|Array<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
17873
18164
|
|
|
17874
18165
|
### UpdatePermissionsRequest
|
|
17875
18166
|
|
|
@@ -17886,9 +18177,9 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
17886
18177
|
| Name | Type | Description |
|
|
17887
18178
|
| --- | --- | --- |
|
|
17888
18179
|
|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). |
|
|
17889
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
18180
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
17890
18181
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
17891
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
18182
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
17892
18183
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
17893
18184
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
17894
18185
|
|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>). |
|
|
@@ -17902,10 +18193,10 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
17902
18193
|
|
|
17903
18194
|
| Name | Type |
|
|
17904
18195
|
| --- | --- |
|
|
17905
|
-
|error|<a href="#metricingesterror"
|
|
18196
|
+
|error|<a href="#metricingesterror">MetricIngestError</a>|
|
|
17906
18197
|
|linesInvalid|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
17907
18198
|
|linesOk|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
17908
|
-
|warnings|<a href="#warnings">Warnings</a>|
|
|
18199
|
+
|warnings|<a href="#warnings" target="_blank" rel="noopener noreferrer">Warnings</a>|
|
|
17909
18200
|
|
|
17910
18201
|
### ValidationRuleDto
|
|
17911
18202
|
|
|
@@ -17916,7 +18207,7 @@ Validation rule of Browser Monitor step.
|
|
|
17916
18207
|
|failIfFound<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if we should fail on found pattern. If not defined in request, it will be set to false by default. |
|
|
17917
18208
|
|matchingPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Text pattern that should match on the website. |
|
|
17918
18209
|
|regex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Boolean value, true if the "matchingPattern" value is a regex. If not defined in request, it will be set to false by default. |
|
|
17919
|
-
|target|<a href="#targetdto"
|
|
18210
|
+
|target|<a href="#targetdto">TargetDto</a>|Target of Browser Monitor step. |
|
|
17920
18211
|
|type<sup>*required</sup>|"TEXT_MATCH" | "CONTENT_MATCH" | "ELEMENT_MATCH"|Type of validation. |
|
|
17921
18212
|
|
|
17922
18213
|
### ValidationWaitConditionDto
|
|
@@ -17925,9 +18216,9 @@ Validation wait condition for Browser Monitor step.
|
|
|
17925
18216
|
|
|
17926
18217
|
| Name | Type | Description |
|
|
17927
18218
|
| --- | --- | --- |
|
|
17928
|
-
|timeoutInMilliseconds
|
|
18219
|
+
|timeoutInMilliseconds<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Validation timeout in milliseconds. |
|
|
17929
18220
|
|type<sup>*required</sup>|"NETWORK" | "NEXT_EVENT" | "PAGE_COMPLETE" | "TIME" | "VALIDATION"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -> TimeWaitConditionDto</li> <li><code>VALIDATION</code> -> ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -> BaseWaitConditionDto</li> <li><code>NETWORK</code> -> BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -> BaseWaitConditionDto</li> </ul> |
|
|
17930
|
-
|validationRule
|
|
18221
|
+
|validationRule<sup>*required</sup>|<a href="#validationruledto" target="_blank" rel="noopener noreferrer">ValidationRuleDto</a>|Validation rule of Browser Monitor step. |
|
|
17931
18222
|
|
|
17932
18223
|
### VisuallyCompleteOptionsDto
|
|
17933
18224
|
|
|
@@ -17947,11 +18238,11 @@ Describes the exploited vulnerability.
|
|
|
17947
18238
|
|
|
17948
18239
|
| Name | Type | Description |
|
|
17949
18240
|
| --- | --- | --- |
|
|
17950
|
-
|codeLocation|<a href="#codelocation"
|
|
18241
|
+
|codeLocation|<a href="#codelocation">CodeLocation</a>|Information about a code location. |
|
|
17951
18242
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the vulnerability. |
|
|
17952
18243
|
|vulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the vulnerability. |
|
|
17953
|
-
|vulnerableFunction|<a href="#functiondefinition">FunctionDefinition</a>|Information about a function definition. |
|
|
17954
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput"
|
|
18244
|
+
|vulnerableFunction|<a href="#functiondefinition" target="_blank" rel="noopener noreferrer">FunctionDefinition</a>|Information about a function definition. |
|
|
18245
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability. |
|
|
17955
18246
|
|
|
17956
18247
|
### VulnerableComponent
|
|
17957
18248
|
|
|
@@ -17982,7 +18273,7 @@ Describes what got passed into the code level vulnerability.
|
|
|
17982
18273
|
|
|
17983
18274
|
| Name | Type | Description |
|
|
17984
18275
|
| --- | --- | --- |
|
|
17985
|
-
|inputSegments|Array<<a href="#vulnerablefunctioninputsegment">VulnerableFunctionInputSegment</a>>|A list of input segments. |
|
|
18276
|
+
|inputSegments|Array<<a href="#vulnerablefunctioninputsegment" target="_blank" rel="noopener noreferrer">VulnerableFunctionInputSegment</a>>|A list of input segments. |
|
|
17986
18277
|
|type|"COMMAND" | "HTTP_CLIENT" | "JNDI" | "SQL_STATEMENT"|The type of the input. |
|
|
17987
18278
|
|
|
17988
18279
|
### VulnerableFunctionInputSegment
|
|
@@ -18000,7 +18291,7 @@ A vulnerable function including its usage by specific process groups in context
|
|
|
18000
18291
|
|
|
18001
18292
|
| Name | Type | Description |
|
|
18002
18293
|
| --- | --- | --- |
|
|
18003
|
-
|function|<a href="#vulnerablefunction"
|
|
18294
|
+
|function|<a href="#vulnerablefunction">VulnerableFunction</a>|Defines an vulnerable function. |
|
|
18004
18295
|
|processGroupsInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is in use. |
|
|
18005
18296
|
|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. |
|
|
18006
18297
|
|processGroupsNotInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is not in use. |
|
|
@@ -18013,8 +18304,8 @@ Optional: A list of vulnerable function usages per process group for a security
|
|
|
18013
18304
|
|
|
18014
18305
|
| Name | Type | Description |
|
|
18015
18306
|
| --- | --- | --- |
|
|
18016
|
-
|vulnerableFunctions|Array<<a href="#vulnerablefunctionprocessgroups">VulnerableFunctionProcessGroups</a>>|A list of vulnerable functions, their security problem wide usages and their usages per process group. |
|
|
18017
|
-
|vulnerableFunctionsByProcessGroup|Array<<a href="#processgroupvulnerablefunctions"
|
|
18307
|
+
|vulnerableFunctions|Array<<a href="#vulnerablefunctionprocessgroups" target="_blank" rel="noopener noreferrer">VulnerableFunctionProcessGroups</a>>|A list of vulnerable functions, their security problem wide usages and their usages per process group. |
|
|
18308
|
+
|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> |
|
|
18018
18309
|
|
|
18019
18310
|
### WarningLine
|
|
18020
18311
|
|
|
@@ -18027,9 +18318,15 @@ Optional: A list of vulnerable function usages per process group for a security
|
|
|
18027
18318
|
|
|
18028
18319
|
| Name | Type |
|
|
18029
18320
|
| --- | --- |
|
|
18030
|
-
|changedMetricKeys|Array<<a href="#warningline">WarningLine</a>>|
|
|
18321
|
+
|changedMetricKeys|Array<<a href="#warningline" target="_blank" rel="noopener noreferrer">WarningLine</a>>|
|
|
18031
18322
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
18032
18323
|
|
|
18324
|
+
### AnyValue
|
|
18325
|
+
|
|
18326
|
+
A schema representing an arbitrary value type.
|
|
18327
|
+
|
|
18328
|
+
**type**: [string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number) | [boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean) | Array<[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)> | Record<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) &#124; [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>
|
|
18329
|
+
|
|
18033
18330
|
## Enums
|
|
18034
18331
|
|
|
18035
18332
|
<a name="abstractcredentialsresponseelementscope"></a>
|
|
@@ -19129,6 +19426,48 @@ The type of the deletion constraint.
|
|
|
19129
19426
|
</div>
|
|
19130
19427
|
|
|
19131
19428
|
|
|
19429
|
+
</div>
|
|
19430
|
+
|
|
19431
|
+
<a name="enablementdtoorigin"></a>
|
|
19432
|
+
### ~~EnablementDtoOrigin~~
|
|
19433
|
+
|
|
19434
|
+
> ⚠️ **Deprecated**
|
|
19435
|
+
> Use literal values.
|
|
19436
|
+
|
|
19437
|
+
<div class="padding-left--md">
|
|
19438
|
+
|
|
19439
|
+
Indicates the origin of these settings.
|
|
19440
|
+
|
|
19441
|
+
#### Enum keys
|
|
19442
|
+
|
|
19443
|
+
<div class="padding-left--md">
|
|
19444
|
+
|
|
19445
|
+
`Default` | `Monitor` | `Tenant` | `Unknown`
|
|
19446
|
+
|
|
19447
|
+
</div>
|
|
19448
|
+
|
|
19449
|
+
|
|
19450
|
+
</div>
|
|
19451
|
+
|
|
19452
|
+
<a name="enablementdtoperformancemetric"></a>
|
|
19453
|
+
### ~~EnablementDtoPerformanceMetric~~
|
|
19454
|
+
|
|
19455
|
+
> ⚠️ **Deprecated**
|
|
19456
|
+
> Use literal values.
|
|
19457
|
+
|
|
19458
|
+
<div class="padding-left--md">
|
|
19459
|
+
|
|
19460
|
+
The name of the performance metric, used for reporting on performance charts and for comparison against defined performance thresholds.
|
|
19461
|
+
|
|
19462
|
+
#### Enum keys
|
|
19463
|
+
|
|
19464
|
+
<div class="padding-left--md">
|
|
19465
|
+
|
|
19466
|
+
`ClassicTotalDuration` | `Duration`
|
|
19467
|
+
|
|
19468
|
+
</div>
|
|
19469
|
+
|
|
19470
|
+
|
|
19132
19471
|
</div>
|
|
19133
19472
|
|
|
19134
19473
|
<a name="entrypointusagesegmentsegmenttype"></a>
|
|
@@ -21849,6 +22188,60 @@ The type of the schema constraint.
|
|
|
21849
22188
|
</div>
|
|
21850
22189
|
|
|
21851
22190
|
|
|
22191
|
+
</div>
|
|
22192
|
+
|
|
22193
|
+
<a name="schemadefinitionrestdtomaturity"></a>
|
|
22194
|
+
### ~~SchemaDefinitionRestDtoMaturity~~
|
|
22195
|
+
|
|
22196
|
+
> ⚠️ **Deprecated**
|
|
22197
|
+
> Use literal values.
|
|
22198
|
+
|
|
22199
|
+
<div class="padding-left--md">
|
|
22200
|
+
|
|
22201
|
+
The maturity of the schema.
|
|
22202
|
+
Possible values:
|
|
22203
|
+
- 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.
|
|
22204
|
+
- 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.
|
|
22205
|
+
- 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.
|
|
22206
|
+
|
|
22207
|
+
In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
22208
|
+
|
|
22209
|
+
#### Enum keys
|
|
22210
|
+
|
|
22211
|
+
<div class="padding-left--md">
|
|
22212
|
+
|
|
22213
|
+
`EarlyAdopter` | `GeneralAvailability` | `Preview`
|
|
22214
|
+
|
|
22215
|
+
</div>
|
|
22216
|
+
|
|
22217
|
+
|
|
22218
|
+
</div>
|
|
22219
|
+
|
|
22220
|
+
<a name="schemastubmaturity"></a>
|
|
22221
|
+
### ~~SchemaStubMaturity~~
|
|
22222
|
+
|
|
22223
|
+
> ⚠️ **Deprecated**
|
|
22224
|
+
> Use literal values.
|
|
22225
|
+
|
|
22226
|
+
<div class="padding-left--md">
|
|
22227
|
+
|
|
22228
|
+
The maturity of the schema.
|
|
22229
|
+
Possible values:
|
|
22230
|
+
- 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.
|
|
22231
|
+
- 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.
|
|
22232
|
+
- 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.
|
|
22233
|
+
|
|
22234
|
+
In any case, automations should make use of the `schemaVersion` field when writing settings objects.
|
|
22235
|
+
|
|
22236
|
+
#### Enum keys
|
|
22237
|
+
|
|
22238
|
+
<div class="padding-left--md">
|
|
22239
|
+
|
|
22240
|
+
`EarlyAdopter` | `GeneralAvailability` | `Preview`
|
|
22241
|
+
|
|
22242
|
+
</div>
|
|
22243
|
+
|
|
22244
|
+
|
|
21852
22245
|
</div>
|
|
21853
22246
|
|
|
21854
22247
|
<a name="schematypetype"></a>
|
|
@@ -21970,7 +22363,7 @@ The reason of the event creation.
|
|
|
21970
22363
|
|
|
21971
22364
|
<div class="padding-left--md">
|
|
21972
22365
|
|
|
21973
|
-
`AssessmentChanged` | `SecurityProblemCreated` | `SecurityProblemMuted` | `SecurityProblemReopened` | `SecurityProblemResolved` | `SecurityProblemUnmuted`
|
|
22366
|
+
`AssessmentChanged` | `SecurityProblemCreated` | `SecurityProblemMuted` | `SecurityProblemReopened` | `SecurityProblemResolved` | `SecurityProblemUnmuted` | `VulnerabilityDiscontinued` | `VulnerabilityIdChanged`
|
|
21974
22367
|
|
|
21975
22368
|
</div>
|
|
21976
22369
|
|
|
@@ -22208,6 +22601,27 @@ The status of the calculated SLO.
|
|
|
22208
22601
|
</div>
|
|
22209
22602
|
|
|
22210
22603
|
|
|
22604
|
+
</div>
|
|
22605
|
+
|
|
22606
|
+
<a name="storelogquerystructure"></a>
|
|
22607
|
+
### ~~StoreLogQueryStructure~~
|
|
22608
|
+
|
|
22609
|
+
> ⚠️ **Deprecated**
|
|
22610
|
+
> Use literal values.
|
|
22611
|
+
|
|
22612
|
+
<div class="padding-left--md">
|
|
22613
|
+
|
|
22614
|
+
|
|
22615
|
+
|
|
22616
|
+
#### Enum keys
|
|
22617
|
+
|
|
22618
|
+
<div class="padding-left--md">
|
|
22619
|
+
|
|
22620
|
+
`Flattened` | `Raw`
|
|
22621
|
+
|
|
22622
|
+
</div>
|
|
22623
|
+
|
|
22624
|
+
|
|
22211
22625
|
</div>
|
|
22212
22626
|
|
|
22213
22627
|
<a name="syntheticbrowsermonitorrequesttype"></a>
|
|
@@ -22353,6 +22767,27 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
22353
22767
|
</div>
|
|
22354
22768
|
|
|
22355
22769
|
|
|
22770
|
+
</div>
|
|
22771
|
+
|
|
22772
|
+
<a name="syntheticmonitoroutagehandlingsettingsdtoorigin"></a>
|
|
22773
|
+
### ~~SyntheticMonitorOutageHandlingSettingsDtoOrigin~~
|
|
22774
|
+
|
|
22775
|
+
> ⚠️ **Deprecated**
|
|
22776
|
+
> Use literal values.
|
|
22777
|
+
|
|
22778
|
+
<div class="padding-left--md">
|
|
22779
|
+
|
|
22780
|
+
Indicates the origin of these settings.
|
|
22781
|
+
|
|
22782
|
+
#### Enum keys
|
|
22783
|
+
|
|
22784
|
+
<div class="padding-left--md">
|
|
22785
|
+
|
|
22786
|
+
`Default` | `Monitor` | `Tenant` | `Unknown`
|
|
22787
|
+
|
|
22788
|
+
</div>
|
|
22789
|
+
|
|
22790
|
+
|
|
22356
22791
|
</div>
|
|
22357
22792
|
|
|
22358
22793
|
<a name="syntheticmonitorperformancethresholddtoaggregation"></a>
|
|
@@ -22384,7 +22819,7 @@ Aggregation type
|
|
|
22384
22819
|
|
|
22385
22820
|
<div class="padding-left--md">
|
|
22386
22821
|
|
|
22387
|
-
Type of performance threshold
|
|
22822
|
+
Type of performance threshold.
|
|
22388
22823
|
|
|
22389
22824
|
#### Enum keys
|
|
22390
22825
|
|