@dynatrace-sdk/client-classic-environment-v2 1.4.2 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/README.md +1 -1
- package/cjs/index.js +12229 -8765
- package/docs/DOCS.md +818 -122
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +12375 -8791
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +61 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +6 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-multi-protocol-monitors-api.d.ts +112 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-client-error.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/client-request-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.transformation.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-architecture.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/custom-device-creation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info-list.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info-list.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-os-architecture.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +66 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.transformation.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-entity-id-dto.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-entity-id-dto.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/registered-extension-result-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/registered-extension-result-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/{security-problem-details-related-container-images-item.d.ts → related-container-list.d.ts} +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/related-container-list.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-assessment-accuracy.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-assessment-accuracy.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-base-risk-level.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-base-risk-level.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-data-assets.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-data-assets.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-exposure.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-exposure.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-public-exploit.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-public-exploit.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-risk-level.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-risk-level.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-vulnerable-function-usage.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-vulnerable-function-usage.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.d.ts +41 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.transformation.d.ts +24 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +4 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.transformation.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-list-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-list-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.transformation.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-summary-dto-type.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-summary-dto-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-summary-dto.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-summary-dto.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto-properties.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto-properties.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +43 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-properties.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-properties.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-request-type.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-request-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.transformation.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-type.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +39 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto-source.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto-source.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto.transformation.d.ts +10 -0
- package/types/packages/http-client/src/index.d.ts +1 -1
- package/types/packages/http-client/src/lib/types/http-client-abort-error.d.ts +1 -0
- package/types/packages/http-client/src/lib/types/http-client-network-error.d.ts +1 -0
- package/types/packages/http-client/src/lib/types/http-client-request-error.d.ts +1 -0
- package/types/packages/http-client/src/lib/types/http-client-response-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.d.ts +0 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.transformation.d.ts +0 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-related-container-images-item.transformation.d.ts +0 -7
package/docs/DOCS.md
CHANGED
|
@@ -24,7 +24,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
|
|
|
24
24
|
</a>
|
|
25
25
|
</div>
|
|
26
26
|
<div class="col" style={{textAlign: 'right'}}>
|
|
27
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.
|
|
27
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.7.0">v1.7.0</a>
|
|
28
28
|
</div>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
@@ -260,7 +260,7 @@ Code example
|
|
|
260
260
|
import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
261
261
|
|
|
262
262
|
const data = await accessTokensApiTokensClient.createApiToken({
|
|
263
|
-
body: { name: "tokenName", scopes: "metrics.read" },
|
|
263
|
+
body: { name: "tokenName", scopes: ["metrics.read"] },
|
|
264
264
|
});
|
|
265
265
|
```
|
|
266
266
|
|
|
@@ -2410,7 +2410,13 @@ const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
|
|
|
2410
2410
|
|
|
2411
2411
|
<div class="padding-left--md">
|
|
2412
2412
|
|
|
2413
|
-
List all
|
|
2413
|
+
List all activeGate groups available for extension
|
|
2414
|
+
|
|
2415
|
+
**Required scope:** environment-api:extension-configurations:write
|
|
2416
|
+
**One of the following permissions is required:**
|
|
2417
|
+
|
|
2418
|
+
- environment:roles:manage-settings
|
|
2419
|
+
- extensions:configurations:write
|
|
2414
2420
|
|
|
2415
2421
|
</div>
|
|
2416
2422
|
|
|
@@ -2688,6 +2694,97 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
2688
2694
|
|
|
2689
2695
|
</div>
|
|
2690
2696
|
|
|
2697
|
+
### installExtension
|
|
2698
|
+
|
|
2699
|
+
<div class="padding-bottom--md">
|
|
2700
|
+
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto">RegisteredExtensionResultDto</a>></strong>
|
|
2701
|
+
|
|
2702
|
+
<div class="padding-left--md">
|
|
2703
|
+
|
|
2704
|
+
Installs Extension from HUB
|
|
2705
|
+
|
|
2706
|
+
**Required scope:** environment-api:extensions:write
|
|
2707
|
+
**One of the following permissions is required:**
|
|
2708
|
+
|
|
2709
|
+
- environment:roles:manage-settings
|
|
2710
|
+
- extensions:definitions:write
|
|
2711
|
+
|
|
2712
|
+
</div>
|
|
2713
|
+
|
|
2714
|
+
#### Parameters
|
|
2715
|
+
|
|
2716
|
+
| Name | Type | Description |
|
|
2717
|
+
| ----------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
2718
|
+
| config.extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the requested extension 2.0. |
|
|
2719
|
+
| config.version | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of configurations by extension 2.0 version. |
|
|
2720
|
+
|
|
2721
|
+
#### Returns
|
|
2722
|
+
|
|
2723
|
+
Success. The extension 2.0 has been uploaded.
|
|
2724
|
+
|
|
2725
|
+
<details>
|
|
2726
|
+
<summary>
|
|
2727
|
+
Code example
|
|
2728
|
+
|
|
2729
|
+
</summary>
|
|
2730
|
+
|
|
2731
|
+
```ts
|
|
2732
|
+
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2733
|
+
|
|
2734
|
+
const data = await extensions_2_0Client.installExtension({
|
|
2735
|
+
extensionName: "...",
|
|
2736
|
+
});
|
|
2737
|
+
```
|
|
2738
|
+
|
|
2739
|
+
</details>
|
|
2740
|
+
|
|
2741
|
+
</div>
|
|
2742
|
+
|
|
2743
|
+
### listExtensionInfos
|
|
2744
|
+
|
|
2745
|
+
<div class="padding-bottom--md">
|
|
2746
|
+
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist">ExtensionInfoList</a>></strong>
|
|
2747
|
+
|
|
2748
|
+
<div class="padding-left--md">
|
|
2749
|
+
|
|
2750
|
+
Lists all the extensions 2.0 available in your environment with additional metadata
|
|
2751
|
+
|
|
2752
|
+
**Required scope:** environment-api:extensions:read
|
|
2753
|
+
**One of the following permissions is required:**
|
|
2754
|
+
|
|
2755
|
+
- environment:roles:manage-settings
|
|
2756
|
+
- extensions:definitions:read
|
|
2757
|
+
|
|
2758
|
+
</div>
|
|
2759
|
+
|
|
2760
|
+
#### Parameters
|
|
2761
|
+
|
|
2762
|
+
| Name | Type | Description |
|
|
2763
|
+
| ------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
2764
|
+
| config.name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of extensions 2.0 by name. You can specify a partial name. In that case, the CONTAINS operator is used. |
|
|
2765
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
|
|
2766
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of extensions in a single response payload.</p> <p>The maximal allowed page size is 100.</p> <p>If not set, 20 is used.</p> |
|
|
2767
|
+
|
|
2768
|
+
#### Returns
|
|
2769
|
+
|
|
2770
|
+
Success
|
|
2771
|
+
|
|
2772
|
+
<details>
|
|
2773
|
+
<summary>
|
|
2774
|
+
Code example
|
|
2775
|
+
|
|
2776
|
+
</summary>
|
|
2777
|
+
|
|
2778
|
+
```ts
|
|
2779
|
+
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2780
|
+
|
|
2781
|
+
const data = await extensions_2_0Client.listExtensionInfos();
|
|
2782
|
+
```
|
|
2783
|
+
|
|
2784
|
+
</details>
|
|
2785
|
+
|
|
2786
|
+
</div>
|
|
2787
|
+
|
|
2691
2788
|
### listExtensionVersions
|
|
2692
2789
|
|
|
2693
2790
|
<div class="padding-bottom--md">
|
|
@@ -3225,6 +3322,8 @@ It is possible that the timeframe covered by results exceeds the specified timef
|
|
|
3225
3322
|
|
|
3226
3323
|
If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OAuth token (with _storage:logs:read_ and _storage:buckets:read_ scopes) needs to be used for authentication.
|
|
3227
3324
|
|
|
3325
|
+
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication
|
|
3326
|
+
|
|
3228
3327
|
</div>
|
|
3229
3328
|
|
|
3230
3329
|
#### Parameters
|
|
@@ -3278,6 +3377,8 @@ Results can be distributed unevenly between slices and some slices might be empt
|
|
|
3278
3377
|
|
|
3279
3378
|
If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OAuth token (with _storage:logs:read_ and _storage:buckets:read_ scopes) needs to be used for authentication.
|
|
3280
3379
|
|
|
3380
|
+
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication
|
|
3381
|
+
|
|
3281
3382
|
</div>
|
|
3282
3383
|
|
|
3283
3384
|
#### Parameters
|
|
@@ -3377,7 +3478,7 @@ Code example
|
|
|
3377
3478
|
import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
3378
3479
|
|
|
3379
3480
|
const data = await logsClient.storeLog({
|
|
3380
|
-
type: "application/json
|
|
3481
|
+
type: "application/json",
|
|
3381
3482
|
body: [
|
|
3382
3483
|
{
|
|
3383
3484
|
content: "Exception: Custom error log sent via Generic Log Ingest",
|
|
@@ -3832,7 +3933,7 @@ You can limit the output by using pagination:
|
|
|
3832
3933
|
| Name | Type | Description |
|
|
3833
3934
|
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
3834
3935
|
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The field is <strong>required</strong> when you're querying the first page of results.</p> |
|
|
3835
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p>
|
|
3936
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
|
|
3836
3937
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
3837
3938
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
|
|
3838
3939
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of entities.</p> <p>If not set, 50 is used.</p> |
|
|
@@ -3878,7 +3979,7 @@ Gets the properties of the specified monitored entity
|
|
|
3878
3979
|
| Name | Type | Description |
|
|
3879
3980
|
| ------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3880
3981
|
| config.entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required entity. |
|
|
3881
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p>
|
|
3982
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
|
|
3882
3983
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
3883
3984
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3884
3985
|
|
|
@@ -5226,10 +5327,10 @@ Lists remediation items of a third-party security problem
|
|
|
5226
5327
|
|
|
5227
5328
|
#### Parameters
|
|
5228
5329
|
|
|
5229
|
-
| Name | Type | Description
|
|
5230
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5231
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem.
|
|
5232
|
-
| config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState("value")</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets("value")</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure("value")</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy("value")</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains("value")</code>. The <code>CONTAINS</code> operator is used.</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> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5330
|
+
| Name | Type | Description |
|
|
5331
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5332
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5333
|
+
| config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState("value")</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets("value")</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure("value")</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy("value")</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains("value")</code>. The <code>CONTAINS</code> operator is used.</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> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5233
5334
|
|
|
5234
5335
|
#### Returns
|
|
5235
5336
|
|
|
@@ -5272,11 +5373,11 @@ Lists remediation progress entities
|
|
|
5272
5373
|
|
|
5273
5374
|
#### Parameters
|
|
5274
5375
|
|
|
5275
|
-
| Name | Type | Description
|
|
5276
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5277
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem.
|
|
5278
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5279
|
-
| config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state("value")</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</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> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5376
|
+
| Name | Type | Description |
|
|
5377
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5378
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5379
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5380
|
+
| config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state("value")</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</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> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5280
5381
|
|
|
5281
5382
|
#### Returns
|
|
5282
5383
|
|
|
@@ -6954,6 +7055,215 @@ const data =
|
|
|
6954
7055
|
|
|
6955
7056
|
</div>
|
|
6956
7057
|
|
|
7058
|
+
## syntheticMultiProtocolMonitorsClient
|
|
7059
|
+
|
|
7060
|
+
```js
|
|
7061
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7062
|
+
```
|
|
7063
|
+
|
|
7064
|
+
### createMonitor
|
|
7065
|
+
|
|
7066
|
+
<div class="padding-bottom--md">
|
|
7067
|
+
<strong>syntheticMultiProtocolMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto">MonitorEntityIdDto</a>></strong>
|
|
7068
|
+
|
|
7069
|
+
<div class="padding-left--md">
|
|
7070
|
+
|
|
7071
|
+
Creates a synthetic monitor definition. Currently multi-protocol monitors only. | maturity=EARLY_ADOPTER
|
|
7072
|
+
|
|
7073
|
+
**Required scope:** environment-api:synthetic-monitors:write
|
|
7074
|
+
**Required permission:** environment:roles:viewer
|
|
7075
|
+
|
|
7076
|
+
</div>
|
|
7077
|
+
|
|
7078
|
+
#### Parameters
|
|
7079
|
+
|
|
7080
|
+
| Name | Type |
|
|
7081
|
+
| -------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
7082
|
+
| config.body<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a> |
|
|
7083
|
+
|
|
7084
|
+
#### Returns
|
|
7085
|
+
|
|
7086
|
+
Success
|
|
7087
|
+
|
|
7088
|
+
<details>
|
|
7089
|
+
<summary>
|
|
7090
|
+
Code example
|
|
7091
|
+
|
|
7092
|
+
</summary>
|
|
7093
|
+
|
|
7094
|
+
```ts
|
|
7095
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7096
|
+
|
|
7097
|
+
const data = await syntheticMultiProtocolMonitorsClient.createMonitor({});
|
|
7098
|
+
```
|
|
7099
|
+
|
|
7100
|
+
</details>
|
|
7101
|
+
|
|
7102
|
+
</div>
|
|
7103
|
+
|
|
7104
|
+
### deleteMonitor
|
|
7105
|
+
|
|
7106
|
+
<div class="padding-bottom--md">
|
|
7107
|
+
<strong>syntheticMultiProtocolMonitorsClient.deleteMonitor(config): Promise<void></strong>
|
|
7108
|
+
|
|
7109
|
+
<div class="padding-left--md">
|
|
7110
|
+
|
|
7111
|
+
Deletes a synthetic monitor definition for the given monitor ID. Currently multi-protocol monitors only. | maturity=EARLY_ADOPTER
|
|
7112
|
+
|
|
7113
|
+
**Required scope:** environment-api:synthetic-monitors:write
|
|
7114
|
+
**Required permission:** environment:roles:viewer
|
|
7115
|
+
|
|
7116
|
+
</div>
|
|
7117
|
+
|
|
7118
|
+
#### Parameters
|
|
7119
|
+
|
|
7120
|
+
| Name | Type | Description |
|
|
7121
|
+
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------ |
|
|
7122
|
+
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7123
|
+
|
|
7124
|
+
<!-- no returns -->
|
|
7125
|
+
|
|
7126
|
+
<details>
|
|
7127
|
+
<summary>
|
|
7128
|
+
Code example
|
|
7129
|
+
|
|
7130
|
+
</summary>
|
|
7131
|
+
|
|
7132
|
+
```ts
|
|
7133
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7134
|
+
|
|
7135
|
+
const data = await syntheticMultiProtocolMonitorsClient.deleteMonitor({
|
|
7136
|
+
monitorId: "...",
|
|
7137
|
+
});
|
|
7138
|
+
```
|
|
7139
|
+
|
|
7140
|
+
</details>
|
|
7141
|
+
|
|
7142
|
+
</div>
|
|
7143
|
+
|
|
7144
|
+
### getMonitor
|
|
7145
|
+
|
|
7146
|
+
<div class="padding-bottom--md">
|
|
7147
|
+
<strong>syntheticMultiProtocolMonitorsClient.getMonitor(config): Promise<<a href="#syntheticmultiprotocolmonitordto">SyntheticMultiProtocolMonitorDto</a>></strong>
|
|
7148
|
+
|
|
7149
|
+
<div class="padding-left--md">
|
|
7150
|
+
|
|
7151
|
+
Gets a synthetic monitor definition for the given monitor ID. Currently multi-protocol monitors only. | maturity=EARLY_ADOPTER
|
|
7152
|
+
|
|
7153
|
+
**Required scope:** environment-api:synthetic-monitors:read
|
|
7154
|
+
**Required permission:** environment:roles:viewer
|
|
7155
|
+
|
|
7156
|
+
</div>
|
|
7157
|
+
|
|
7158
|
+
#### Parameters
|
|
7159
|
+
|
|
7160
|
+
| Name | Type | Description |
|
|
7161
|
+
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------ |
|
|
7162
|
+
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7163
|
+
|
|
7164
|
+
#### Returns
|
|
7165
|
+
|
|
7166
|
+
Success
|
|
7167
|
+
|
|
7168
|
+
<details>
|
|
7169
|
+
<summary>
|
|
7170
|
+
Code example
|
|
7171
|
+
|
|
7172
|
+
</summary>
|
|
7173
|
+
|
|
7174
|
+
```ts
|
|
7175
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7176
|
+
|
|
7177
|
+
const data = await syntheticMultiProtocolMonitorsClient.getMonitor({
|
|
7178
|
+
monitorId: "...",
|
|
7179
|
+
});
|
|
7180
|
+
```
|
|
7181
|
+
|
|
7182
|
+
</details>
|
|
7183
|
+
|
|
7184
|
+
</div>
|
|
7185
|
+
|
|
7186
|
+
### getMonitors
|
|
7187
|
+
|
|
7188
|
+
<div class="padding-bottom--md">
|
|
7189
|
+
<strong>syntheticMultiProtocolMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto">SyntheticMonitorListDto</a>></strong>
|
|
7190
|
+
|
|
7191
|
+
<div class="padding-left--md">
|
|
7192
|
+
|
|
7193
|
+
Gets all synthetic monitors. Currently multi-protocol monitors only. | maturity=EARLY_ADOPTER
|
|
7194
|
+
|
|
7195
|
+
**Required scope:** environment-api:synthetic-monitors:read
|
|
7196
|
+
**Required permission:** environment:roles:viewer
|
|
7197
|
+
|
|
7198
|
+
</div>
|
|
7199
|
+
|
|
7200
|
+
#### Parameters
|
|
7201
|
+
|
|
7202
|
+
| Name | Type | Description |
|
|
7203
|
+
| --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7204
|
+
| config.managementZone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>Filters the resulting set of monitors to those which are part of the specified management zone.</p> <p>Specify the ID of the management zone here.</p> |
|
|
7205
|
+
|
|
7206
|
+
#### Returns
|
|
7207
|
+
|
|
7208
|
+
Success
|
|
7209
|
+
|
|
7210
|
+
<details>
|
|
7211
|
+
<summary>
|
|
7212
|
+
Code example
|
|
7213
|
+
|
|
7214
|
+
</summary>
|
|
7215
|
+
|
|
7216
|
+
```ts
|
|
7217
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7218
|
+
|
|
7219
|
+
const data = await syntheticMultiProtocolMonitorsClient.getMonitors();
|
|
7220
|
+
```
|
|
7221
|
+
|
|
7222
|
+
</details>
|
|
7223
|
+
|
|
7224
|
+
</div>
|
|
7225
|
+
|
|
7226
|
+
### updateMonitor
|
|
7227
|
+
|
|
7228
|
+
<div class="padding-bottom--md">
|
|
7229
|
+
<strong>syntheticMultiProtocolMonitorsClient.updateMonitor(config): Promise<void></strong>
|
|
7230
|
+
|
|
7231
|
+
<div class="padding-left--md">
|
|
7232
|
+
|
|
7233
|
+
Updates a synthetic monitor definition for the given monitor ID. Currently multi-protocol monitors only. | maturity=EARLY_ADOPTER
|
|
7234
|
+
|
|
7235
|
+
**Required scope:** environment-api:synthetic-monitors:write
|
|
7236
|
+
**Required permission:** environment:roles:viewer
|
|
7237
|
+
|
|
7238
|
+
</div>
|
|
7239
|
+
|
|
7240
|
+
#### Parameters
|
|
7241
|
+
|
|
7242
|
+
| Name | Type | Description |
|
|
7243
|
+
| ------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------ |
|
|
7244
|
+
| config.body<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a> | |
|
|
7245
|
+
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7246
|
+
|
|
7247
|
+
<!-- no returns -->
|
|
7248
|
+
|
|
7249
|
+
<details>
|
|
7250
|
+
<summary>
|
|
7251
|
+
Code example
|
|
7252
|
+
|
|
7253
|
+
</summary>
|
|
7254
|
+
|
|
7255
|
+
```ts
|
|
7256
|
+
import { syntheticMultiProtocolMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7257
|
+
|
|
7258
|
+
const data = await syntheticMultiProtocolMonitorsClient.updateMonitor({
|
|
7259
|
+
monitorId: "...",
|
|
7260
|
+
});
|
|
7261
|
+
```
|
|
7262
|
+
|
|
7263
|
+
</details>
|
|
7264
|
+
|
|
7265
|
+
</div>
|
|
7266
|
+
|
|
6957
7267
|
## syntheticOnDemandMonitorExecutionsClient
|
|
6958
7268
|
|
|
6959
7269
|
```js
|
|
@@ -7263,11 +7573,11 @@ Global configuration of ActiveGates auto-update.
|
|
|
7263
7573
|
|
|
7264
7574
|
Metadata for each ActiveGate group.
|
|
7265
7575
|
|
|
7266
|
-
| Name
|
|
7267
|
-
|
|
|
7268
|
-
| activeGates | Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>> | ActiveGates in group. |
|
|
7269
|
-
| availableActiveGates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of ActiveGates in group available for
|
|
7270
|
-
| groupName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ActiveGate group name. |
|
|
7576
|
+
| Name | Type | Description |
|
|
7577
|
+
| ----------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
7578
|
+
| activeGates<sup>\*required</sup> | Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>> | ActiveGates in group. |
|
|
7579
|
+
| availableActiveGates<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of ActiveGates in group available for extension. |
|
|
7580
|
+
| groupName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ActiveGate group name. |
|
|
7271
7581
|
|
|
7272
7582
|
### ActiveGateGroupsInfoDto
|
|
7273
7583
|
|
|
@@ -7281,10 +7591,10 @@ ActiveGate groups metadata for extensions.
|
|
|
7281
7591
|
|
|
7282
7592
|
ActiveGates in group.
|
|
7283
7593
|
|
|
7284
|
-
| Name
|
|
7285
|
-
|
|
|
7286
|
-
| errors | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors if Extension cannot be run on the ActiveGate |
|
|
7287
|
-
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ActiveGate ID. |
|
|
7594
|
+
| Name | Type | Description |
|
|
7595
|
+
| --------------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
|
7596
|
+
| errors<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors if Extension cannot be run on the ActiveGate |
|
|
7597
|
+
| id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ActiveGate ID. |
|
|
7288
7598
|
|
|
7289
7599
|
### ActiveGateList
|
|
7290
7600
|
|
|
@@ -7437,12 +7747,12 @@ Metadata of an API token.
|
|
|
7437
7747
|
|
|
7438
7748
|
Parameters of a new API token.
|
|
7439
7749
|
|
|
7440
|
-
| Name | Type | Description
|
|
7441
|
-
| --------------------------- | ------------------------------------------------------------------------------- |
|
|
7442
|
-
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p>
|
|
7443
|
-
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token.
|
|
7444
|
-
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p>
|
|
7445
|
-
| scopes<sup>\*required</sup> | Array<ApiTokenCreateScopesItem> | <p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> </ul> |
|
|
7750
|
+
| Name | Type | Description |
|
|
7751
|
+
| --------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7752
|
+
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> |
|
|
7753
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7754
|
+
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p> |
|
|
7755
|
+
| scopes<sup>\*required</sup> | Array<ApiTokenCreateScopesItem> | <p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7446
7756
|
|
|
7447
7757
|
### ApiTokenCreated
|
|
7448
7758
|
|
|
@@ -7475,11 +7785,11 @@ A list of API tokens.
|
|
|
7475
7785
|
|
|
7476
7786
|
The update of the API token.
|
|
7477
7787
|
|
|
7478
|
-
| Name | Type | Description
|
|
7479
|
-
| ------- | ------------------------------------------------------------------------------- |
|
|
7480
|
-
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is enabled (<code>true</code>) or disabled (<code>false</code>)
|
|
7481
|
-
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token.
|
|
7482
|
-
| scopes | Array<ApiTokenUpdateScopesItem> | <p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> </ul> |
|
|
7788
|
+
| Name | Type | Description |
|
|
7789
|
+
| ------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7790
|
+
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
7791
|
+
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7792
|
+
| scopes | Array<ApiTokenUpdateScopesItem> | <p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7483
7793
|
|
|
7484
7794
|
### ApplicationImpact
|
|
7485
7795
|
|
|
@@ -7707,7 +8017,7 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
7707
8017
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
7708
8018
|
| ownerAccessOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
7709
8019
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The password of the credential (Base64 encoded). |
|
|
7710
|
-
| scope
|
|
8020
|
+
| scope | CredentialsScope | |
|
|
7711
8021
|
| scopes<sup>\*required</sup> | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
|
|
7712
8022
|
| type | CredentialsType | |
|
|
7713
8023
|
|
|
@@ -7856,7 +8166,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
7856
8166
|
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the credentials set. |
|
|
7857
8167
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
7858
8168
|
| ownerAccessOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
7859
|
-
| scope
|
|
8169
|
+
| scope | CredentialsScope | |
|
|
7860
8170
|
| scopes<sup>\*required</sup> | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
|
|
7861
8171
|
| type | CredentialsType | |
|
|
7862
8172
|
|
|
@@ -7970,7 +8280,7 @@ Configuration of a custom device.
|
|
|
7970
8280
|
| configUrl | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The URL of a configuration web page for the custom device, such as a login page for a firewall or router. |
|
|
7971
8281
|
| customDeviceId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The internal ID of the custom device.</p> <p>If you use the ID of an existing device, the respective parameters will be updated.</p> |
|
|
7972
8282
|
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the custom device to be displayed in the user interface. |
|
|
7973
|
-
| dnsNames | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The list of DNS names related to the custom device.</p> <p>These names are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If you send a value, the existing values will be overwritten.</p> <p>If you send <code>null</code> or an empty value; or omit this field, the existing values will be kept.</p>
|
|
8283
|
+
| dnsNames | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The list of DNS names related to the custom device.</p> <p>These names are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>Non-public DNS addresses can also be mapped internally. This is applicable only if the domain name consists of at least two parts, for example <code>hostname.xyz</code>.</p> <p>If you send a value, the existing values will be overwritten.</p> <p>If you send <code>null</code> or an empty value; or omit this field, the existing values will be kept.</p> |
|
|
7974
8284
|
| faviconUrl | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The icon to be displayed for your custom component within Smartscape. Provide the full URL of the icon file. |
|
|
7975
8285
|
| group | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>User defined group ID of entity.</p> <p>The group ID helps to keep a consistent picture of device-group relations. One of many cases where a proper group is important is service detection: you can define which custom devices should lead to the same service by defining the same group ID for them.</p> <p>If you set a group ID, it will be hashed into the Dynatrace entity ID of the custom device. In that case the custom device can only be part of one custom device group.</p> <p>If you don't set the group ID, Dynatrace will create it based on the ID or type of the custom device. Also, the group will not be hashed into the device ID which means the device may switch groups.</p> |
|
|
7976
8286
|
| ipAddresses | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The list of IP addresses that belong to the custom device.</p> <p>These addresses are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If you send a value (including an empty value), the existing values will be overwritten.</p> <p>If you send <code>null</code> or omit this field, the existing values will be kept.</p> |
|
|
@@ -8400,15 +8710,15 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
8400
8710
|
|
|
8401
8711
|
The configuration of an event to be ingested.
|
|
8402
8712
|
|
|
8403
|
-
| Name | Type | Description
|
|
8404
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
8405
|
-
| endTime | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The end time of the event, in UTC milliseconds.</p> <p>If not set, the start time plus timeout is used.</p>
|
|
8406
|
-
| entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The <a href="https://dt-url.net/apientityselector">entity selector</a>, defining a set of Dynatrace entities to be associated with the event.</p> <p>Only entities that have been active within the last 24 hours can be selected.</p> <p>If not set, the event is associated with the environment (<code>dt.entity.environment</code>) entity.</p>
|
|
8407
|
-
| eventType<sup>\*required</sup> | EventIngestEventType |
|
|
8408
|
-
| properties | <a href="#eventingestproperties">EventIngestProperties</a> |
|
|
8409
|
-
| startTime | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The start time of the event, in UTC milliseconds.</p> <p>If not set, the current timestamp is used.</p> <p>Depending on the event type, the start time must not lie in the future more than 5 minutes for
|
|
8410
|
-
| timeout | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The timeout of the event, in minutes.</p> <p>If not set, 15 is used.</p> <p>The timeout will automatically be capped to a maximum of 360 minutes (6 hours).</p> <p>Problem-opening events can be refreshed and therefore kept open by sending the same payload again.</p>
|
|
8411
|
-
| title<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the event.
|
|
8713
|
+
| Name | Type | Description |
|
|
8714
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8715
|
+
| endTime | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The end time of the event, in UTC milliseconds.</p> <p>If not set, the start time plus timeout is used.</p> |
|
|
8716
|
+
| entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The <a href="https://dt-url.net/apientityselector">entity selector</a>, defining a set of Dynatrace entities to be associated with the event.</p> <p>Only entities that have been active within the last 24 hours can be selected.</p> <p>If not set, the event is associated with the environment (<code>dt.entity.environment</code>) entity.</p> |
|
|
8717
|
+
| eventType<sup>\*required</sup> | EventIngestEventType | |
|
|
8718
|
+
| properties | <a href="#eventingestproperties">EventIngestProperties</a> | |
|
|
8719
|
+
| startTime | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The start time of the event, in UTC milliseconds.</p> <p>If not set, the current timestamp is used.</p> <p>Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events.</p> <p>Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events.</p> |
|
|
8720
|
+
| timeout | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The timeout of the event, in minutes.</p> <p>If not set, 15 is used.</p> <p>The timeout will automatically be capped to a maximum of 360 minutes (6 hours).</p> <p>Problem-opening events can be refreshed and therefore kept open by sending the same payload again.</p> |
|
|
8721
|
+
| title<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the event. |
|
|
8412
8722
|
|
|
8413
8723
|
### EventIngestProperties
|
|
8414
8724
|
|
|
@@ -8643,6 +8953,25 @@ A list of extension events.
|
|
|
8643
8953
|
|
|
8644
8954
|
Details of feature sets
|
|
8645
8955
|
|
|
8956
|
+
### ExtensionInfo
|
|
8957
|
+
|
|
8958
|
+
A list of extensions with additional metadata.
|
|
8959
|
+
|
|
8960
|
+
| Name | Type | Description |
|
|
8961
|
+
| ---------------------------------- | ------------------------------------------------------------------------------------------ | ------------------ |
|
|
8962
|
+
| extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension name |
|
|
8963
|
+
| keywords<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | Extension keywords |
|
|
8964
|
+
| version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension version |
|
|
8965
|
+
|
|
8966
|
+
### ExtensionInfoList
|
|
8967
|
+
|
|
8968
|
+
| Name | Type | Description |
|
|
8969
|
+
| ------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8970
|
+
| extensions<sup>\*required</sup> | Array<<a href="#extensioninfo">ExtensionInfo</a>> | A list of extensions with additional metadata. |
|
|
8971
|
+
| nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
|
|
8972
|
+
| pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of entries per page. |
|
|
8973
|
+
| totalCount<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of entries in the result. |
|
|
8974
|
+
|
|
8646
8975
|
### ExtensionList
|
|
8647
8976
|
|
|
8648
8977
|
| Name | Type | Description |
|
|
@@ -8942,7 +9271,12 @@ A synthetic location.
|
|
|
8942
9271
|
| ---------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
8943
9272
|
| cloudPlatform | LocationCollectionElementCloudPlatform | |
|
|
8944
9273
|
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location. |
|
|
9274
|
+
| geoCity | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Location's city. |
|
|
9275
|
+
| geoContinent | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Location's continent. |
|
|
9276
|
+
| geoCountry | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Location's country. |
|
|
9277
|
+
| geoLatitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Location's latitude. |
|
|
8945
9278
|
| geoLocationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location. |
|
|
9279
|
+
| geoLongitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Location's longitude. |
|
|
8946
9280
|
| ips | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The list of IP addresses assigned to the location.</p> <p>Only applicable to <code>PUBLIC</code> locations.</p> |
|
|
8947
9281
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
|
|
8948
9282
|
| stage | LocationCollectionElementStage | |
|
|
@@ -8996,15 +9330,6 @@ The tag of a monitored entity.
|
|
|
8996
9330
|
| stringRepresentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The string representation of the tag. |
|
|
8997
9331
|
| value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the tag. |
|
|
8998
9332
|
|
|
8999
|
-
### MainEvent
|
|
9000
|
-
|
|
9001
|
-
The main event of a problem, determined by matching root cause entity id or first event.
|
|
9002
|
-
|
|
9003
|
-
| Name | Type | Description |
|
|
9004
|
-
| ----------- | ----------------------------------------------------------------------------- | ----------------------------- |
|
|
9005
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the event. |
|
|
9006
|
-
| title | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the event. |
|
|
9007
|
-
|
|
9008
9333
|
### MaintenanceWindowEvidence
|
|
9009
9334
|
|
|
9010
9335
|
The maintenance window evidence of the problem.
|
|
@@ -9233,6 +9558,14 @@ The modification info for a single updatable setting.
|
|
|
9233
9558
|
| movable | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If settings value can be moved/reordered. Only applicable for ordered list schema |
|
|
9234
9559
|
| nonModifiablePaths | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | Property paths which are not modifiable, when <code>modifiable</code> is true |
|
|
9235
9560
|
|
|
9561
|
+
### MonitorEntityIdDto
|
|
9562
|
+
|
|
9563
|
+
A DTO for monitor entity ID.
|
|
9564
|
+
|
|
9565
|
+
| Name | Type | Description |
|
|
9566
|
+
| ----------------------------- | ----------------------------------------------------------------------------- | ------------------ |
|
|
9567
|
+
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Monitor entity ID. |
|
|
9568
|
+
|
|
9236
9569
|
### MonitorExecutionResults
|
|
9237
9570
|
|
|
9238
9571
|
Results of the execution of all HTTP monitor's requests.
|
|
@@ -9512,7 +9845,6 @@ The properties of a problem.
|
|
|
9512
9845
|
| impactLevel<sup>\*required</sup> | ProblemImpactLevel | |
|
|
9513
9846
|
| impactedEntities<sup>\*required</sup> | Array<<a href="#entitystub">EntityStub</a>> | A list of all entities that are impacted by the problem. |
|
|
9514
9847
|
| linkedProblemInfo | <a href="#linkedproblem">LinkedProblem</a> | |
|
|
9515
|
-
| mainEvent | <a href="#mainevent">MainEvent</a> | |
|
|
9516
9848
|
| managementZones<sup>\*required</sup> | Array<<a href="#managementzone">ManagementZone</a>> | A list of all management zones that the problem belongs to. |
|
|
9517
9849
|
| problemFilters<sup>\*required</sup> | Array<<a href="#alertingprofilestub">AlertingProfileStub</a>> | A list of alerting profiles that match the problem. |
|
|
9518
9850
|
| problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the problem. |
|
|
@@ -9579,6 +9911,7 @@ Configuration of a property in a settings schema.
|
|
|
9579
9911
|
| items | <a href="#item">Item</a> | |
|
|
9580
9912
|
| maxObjects<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
|
|
9581
9913
|
| metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a> | |
|
|
9914
|
+
| migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pattern with references to properties to create a new value. |
|
|
9582
9915
|
| minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The minimum number of <strong>objects</strong> in a collection property. |
|
|
9583
9916
|
| modificationPolicy | PropertyDefinitionModificationPolicy | |
|
|
9584
9917
|
| nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
|
|
@@ -9606,7 +9939,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
9606
9939
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
9607
9940
|
| ownerAccessOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
9608
9941
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The password of the credential (not supported). |
|
|
9609
|
-
| scope
|
|
9942
|
+
| scope | CredentialsScope | |
|
|
9610
9943
|
| scopes<sup>\*required</sup> | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
|
|
9611
9944
|
| type | CredentialsType | |
|
|
9612
9945
|
|
|
@@ -9643,6 +9976,13 @@ Object with a pointer to a JSON object
|
|
|
9643
9976
|
| ------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
9644
9977
|
| $ref<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pointer to a JSON object this object should be logically replaced with. |
|
|
9645
9978
|
|
|
9979
|
+
### RegisteredExtensionResultDto
|
|
9980
|
+
|
|
9981
|
+
| Name | Type | Description |
|
|
9982
|
+
| ---------------- | ----------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
9983
|
+
| extensionName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | FQN of the extension registered in the tenant. |
|
|
9984
|
+
| extensionVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Version number of the extension. |
|
|
9985
|
+
|
|
9646
9986
|
### RelatedAttacksList
|
|
9647
9987
|
|
|
9648
9988
|
A list of related attacks of the security problem.
|
|
@@ -9664,6 +10004,14 @@ Related container image of a security problem.
|
|
|
9664
10004
|
| imageName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The image name of the related container image. |
|
|
9665
10005
|
| numberOfAffectedEntities | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of affected entities. |
|
|
9666
10006
|
|
|
10007
|
+
### RelatedContainerList
|
|
10008
|
+
|
|
10009
|
+
A list of related container images.
|
|
10010
|
+
|
|
10011
|
+
| Name | Type | Description |
|
|
10012
|
+
| --------------- | ----------------------------------------------------------------------- | ----------------------------------- |
|
|
10013
|
+
| containerImages | Array<<a href="#relatedcontainerimage">RelatedContainerImage</a>> | A list of related container images. |
|
|
10014
|
+
|
|
9667
10015
|
### RelatedEntitiesList
|
|
9668
10016
|
|
|
9669
10017
|
A list of related entities of the security problem.
|
|
@@ -9756,15 +10104,16 @@ A list of releases.
|
|
|
9756
10104
|
|
|
9757
10105
|
Assessment of the remediation item.
|
|
9758
10106
|
|
|
9759
|
-
| Name
|
|
9760
|
-
|
|
|
9761
|
-
| dataAssets
|
|
9762
|
-
| exposure
|
|
9763
|
-
| numberOfDataAssets
|
|
9764
|
-
|
|
|
9765
|
-
|
|
|
9766
|
-
|
|
|
9767
|
-
|
|
|
10107
|
+
| Name | Type | Description |
|
|
10108
|
+
| --------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
10109
|
+
| dataAssets | RemediationAssessmentDataAssets | |
|
|
10110
|
+
| exposure | RemediationAssessmentExposure | |
|
|
10111
|
+
| numberOfDataAssets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of related data assets. |
|
|
10112
|
+
| vulnerableFunctionRestartRequired | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Whether a restart is required for the latest vulnerable function data. |
|
|
10113
|
+
| vulnerableFunctionUsage | RemediationAssessmentVulnerableFunctionUsage | |
|
|
10114
|
+
| vulnerableFunctionsInUse | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are in use. |
|
|
10115
|
+
| vulnerableFunctionsNotAvailable | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are not available. |
|
|
10116
|
+
| vulnerableFunctionsNotInUse | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are not in use. |
|
|
9768
10117
|
|
|
9769
10118
|
### RemediationDetailsItem
|
|
9770
10119
|
|
|
@@ -9935,12 +10284,13 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
9935
10284
|
|
|
9936
10285
|
Assessment of the remediation progress entity.
|
|
9937
10286
|
|
|
9938
|
-
| Name
|
|
9939
|
-
|
|
|
9940
|
-
|
|
|
9941
|
-
|
|
|
9942
|
-
|
|
|
9943
|
-
|
|
|
10287
|
+
| Name | Type | Description |
|
|
10288
|
+
| --------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
10289
|
+
| vulnerableFunctionRestartRequired | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Whether a restart is required for the latest vulnerable function data. |
|
|
10290
|
+
| vulnerableFunctionUsage | RemediationProgressEntityAssessmentVulnerableFunctionUsage | |
|
|
10291
|
+
| vulnerableFunctionsInUse | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are in use. |
|
|
10292
|
+
| vulnerableFunctionsNotAvailable | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are not available. |
|
|
10293
|
+
| vulnerableFunctionsNotInUse | Array<<a href="#vulnerablefunction">VulnerableFunction</a>> | A list of vulnerable functions that are not in use. |
|
|
9944
10294
|
|
|
9945
10295
|
### RemediationProgressEntityList
|
|
9946
10296
|
|
|
@@ -9996,6 +10346,25 @@ All changes of the risk assessment.
|
|
|
9996
10346
|
| previousPublicExploit | RiskAssessmentChangesPreviousPublicExploit | |
|
|
9997
10347
|
| previousVulnerableFunctionUsage | RiskAssessmentChangesPreviousVulnerableFunctionUsage | |
|
|
9998
10348
|
|
|
10349
|
+
### RiskAssessmentDetails
|
|
10350
|
+
|
|
10351
|
+
Risk assessment of a security problem.
|
|
10352
|
+
|
|
10353
|
+
| Name | Type | Description |
|
|
10354
|
+
| --------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
10355
|
+
| assessmentAccuracy | RiskAssessmentDetailsAssessmentAccuracy | |
|
|
10356
|
+
| baseRiskLevel | RiskAssessmentDetailsBaseRiskLevel | |
|
|
10357
|
+
| baseRiskScore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The risk score (1-10) from the CVSS score. |
|
|
10358
|
+
| baseRiskVector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The original attack vector of the CVSS assessment. |
|
|
10359
|
+
| dataAssets | RiskAssessmentDetailsDataAssets | |
|
|
10360
|
+
| exposure | RiskAssessmentDetailsExposure | |
|
|
10361
|
+
| publicExploit | RiskAssessmentDetailsPublicExploit | |
|
|
10362
|
+
| riskLevel | RiskAssessmentDetailsRiskLevel | |
|
|
10363
|
+
| riskScore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The Davis risk score (1-10).</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
10364
|
+
| riskVector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The attack vector calculated by Dynatrace based on the CVSS attack vector. |
|
|
10365
|
+
| vulnerableFunctionRestartRequired | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Whether a restart is required for new vulnerable function data. |
|
|
10366
|
+
| vulnerableFunctionUsage | RiskAssessmentDetailsVulnerableFunctionUsage | |
|
|
10367
|
+
|
|
9999
10368
|
### RiskAssessmentSnapshot
|
|
10000
10369
|
|
|
10001
10370
|
A snapshot of the risk assessment of a security problem.
|
|
@@ -10221,47 +10590,39 @@ Summary of (un-)muting a security problem.
|
|
|
10221
10590
|
|
|
10222
10591
|
Parameters of a security problem
|
|
10223
10592
|
|
|
10224
|
-
| Name | Type
|
|
10225
|
-
| ----------------------------- |
|
|
10226
|
-
| affectedEntities | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
10227
|
-
| codeLevelVulnerabilityDetails | <a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>
|
|
10228
|
-
| cveIds | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
10229
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10230
|
-
| displayId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10231
|
-
| entryPoints | <a href="#entrypoints">EntryPoints</a>
|
|
10232
|
-
| events | Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>
|
|
10233
|
-
| exposedEntities | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
10234
|
-
| externalVulnerabilityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10235
|
-
| filteredCounts | <a href="#filteredcountsdto">FilteredCountsDto</a>
|
|
10236
|
-
| firstSeenTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10237
|
-
| globalCounts | <a href="#globalcountsdto">GlobalCountsDto</a>
|
|
10238
|
-
| lastOpenedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10239
|
-
| lastResolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10240
|
-
| lastUpdatedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10241
|
-
| managementZones | Array<<a href="#managementzone">ManagementZone</a>>
|
|
10242
|
-
| muteStateChangeInProgress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
10243
|
-
| muted | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
10244
|
-
| packageName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10245
|
-
| reachableDataAssets | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
10246
|
-
| relatedAttacks | <a href="#relatedattackslist">RelatedAttacksList</a>
|
|
10247
|
-
| relatedContainerImages |
|
|
10248
|
-
| relatedEntities | <a href="#relatedentitieslist">RelatedEntitiesList</a>
|
|
10249
|
-
| riskAssessment | <a href="#
|
|
10250
|
-
| securityProblemId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10251
|
-
| status | SecurityProblemDetailsStatus
|
|
10252
|
-
| technology | SecurityProblemDetailsTechnology
|
|
10253
|
-
| title | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10254
|
-
| url | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10255
|
-
| vulnerabilityType | SecurityProblemDetailsVulnerabilityType
|
|
10256
|
-
| vulnerableComponents | Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>
|
|
10257
|
-
|
|
10258
|
-
### SecurityProblemDetailsRelatedContainerImagesItem
|
|
10259
|
-
|
|
10260
|
-
A list of related container images.
|
|
10261
|
-
|
|
10262
|
-
| Name | Type | Description |
|
|
10263
|
-
| --------------- | ----------------------------------------------------------------------- | ----------------------------------- |
|
|
10264
|
-
| containerImages | Array<<a href="#relatedcontainerimage">RelatedContainerImage</a>> | A list of related container images. |
|
|
10593
|
+
| Name | Type | Description |
|
|
10594
|
+
| ----------------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10595
|
+
| affectedEntities | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>A list of affected entities of the security problem.</p> <p>An affected entity is an entity where a vulnerable component runs.</p> |
|
|
10596
|
+
| codeLevelVulnerabilityDetails | <a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a> | |
|
|
10597
|
+
| cveIds | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | A list of CVE IDs of the security problem. |
|
|
10598
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the security problem. |
|
|
10599
|
+
| displayId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display ID of the security problem. |
|
|
10600
|
+
| entryPoints | <a href="#entrypoints">EntryPoints</a> | |
|
|
10601
|
+
| events | Array<<a href="#securityproblemevent">SecurityProblemEvent</a>> | An ordered (newest first) list of events of the security problem. |
|
|
10602
|
+
| exposedEntities | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>A list of exposed entities of the security problem.</p> <p>An exposed entity is an affected entity that is exposed to the internet.</p> |
|
|
10603
|
+
| externalVulnerabilityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external vulnerability ID of the security problem. |
|
|
10604
|
+
| filteredCounts | <a href="#filteredcountsdto">FilteredCountsDto</a> | |
|
|
10605
|
+
| firstSeenTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the first occurrence of the security problem. |
|
|
10606
|
+
| globalCounts | <a href="#globalcountsdto">GlobalCountsDto</a> | |
|
|
10607
|
+
| lastOpenedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when the security problem was last opened. |
|
|
10608
|
+
| lastResolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when the security problem was last resolved. |
|
|
10609
|
+
| lastUpdatedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the most recent security problem change. |
|
|
10610
|
+
| managementZones | Array<<a href="#managementzone">ManagementZone</a>> | A list of management zones which the affected entities belong to. |
|
|
10611
|
+
| muteStateChangeInProgress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code> a change of the mute state is in progress. |
|
|
10612
|
+
| muted | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
10613
|
+
| packageName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The package name of the security problem. |
|
|
10614
|
+
| reachableDataAssets | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>A list of data assets reachable by affected entities of the security problem.</p> <p>A data asset is a service that has database access.</p> |
|
|
10615
|
+
| relatedAttacks | <a href="#relatedattackslist">RelatedAttacksList</a> | |
|
|
10616
|
+
| relatedContainerImages | <a href="#relatedcontainerlist">RelatedContainerList</a> | |
|
|
10617
|
+
| relatedEntities | <a href="#relatedentitieslist">RelatedEntitiesList</a> | |
|
|
10618
|
+
| riskAssessment | <a href="#riskassessmentdetails">RiskAssessmentDetails</a> | |
|
|
10619
|
+
| securityProblemId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the security problem. |
|
|
10620
|
+
| status | SecurityProblemDetailsStatus | |
|
|
10621
|
+
| technology | SecurityProblemDetailsTechnology | |
|
|
10622
|
+
| title | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the security problem. |
|
|
10623
|
+
| url | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The URL to the security problem details page. |
|
|
10624
|
+
| vulnerabilityType | SecurityProblemDetailsVulnerabilityType | |
|
|
10625
|
+
| vulnerableComponents | Array<<a href="#vulnerablecomponent">VulnerableComponent</a>> | <p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
10265
10626
|
|
|
10266
10627
|
### SecurityProblemEvent
|
|
10267
10628
|
|
|
@@ -10551,6 +10912,122 @@ A list of synthetic locations.
|
|
|
10551
10912
|
| ------------------------------ | ------------------------------------------------------------------------------- | ------------------------------ |
|
|
10552
10913
|
| locations<sup>\*required</sup> | Array<<a href="#locationcollectionelement">LocationCollectionElement</a>> | A list of synthetic locations. |
|
|
10553
10914
|
|
|
10915
|
+
### SyntheticMonitorListDto
|
|
10916
|
+
|
|
10917
|
+
List of available synthetic monitors.
|
|
10918
|
+
|
|
10919
|
+
| Name | Type | Description |
|
|
10920
|
+
| -------- | --------------------------------------------------------------------------------- | ----------------- |
|
|
10921
|
+
| monitors | Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>> | List of monitors. |
|
|
10922
|
+
|
|
10923
|
+
### SyntheticMonitorOutageHandlingSettingsDto
|
|
10924
|
+
|
|
10925
|
+
Outage handling configuration.
|
|
10926
|
+
|
|
10927
|
+
| Name | Type | Description |
|
|
10928
|
+
| ------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
10929
|
+
| globalConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures for all locations. |
|
|
10930
|
+
| globalOutages<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
|
|
10931
|
+
| localConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures. |
|
|
10932
|
+
| localLocationOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of failing locations. |
|
|
10933
|
+
| localOutages<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
|
|
10934
|
+
| type<sup>\*required</sup> | MultiProtocol | |
|
|
10935
|
+
|
|
10936
|
+
### SyntheticMonitorSummaryDto
|
|
10937
|
+
|
|
10938
|
+
Basic monitor data.
|
|
10939
|
+
|
|
10940
|
+
| Name | Type | Description |
|
|
10941
|
+
| ----------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
|
10942
|
+
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the monitor is enabled. <i>default:</i> <code>true</code> |
|
|
10943
|
+
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The entity id of the monitor. |
|
|
10944
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
|
|
10945
|
+
| type<sup>\*required</sup> | SyntheticMonitorSummaryDtoType | |
|
|
10946
|
+
|
|
10947
|
+
### SyntheticMultiProtocolMonitorConstraintDto
|
|
10948
|
+
|
|
10949
|
+
The multi-protocol monitor constraint.
|
|
10950
|
+
|
|
10951
|
+
| Name | Type | Description |
|
|
10952
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------- |
|
|
10953
|
+
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorconstraintdtoproperties">SyntheticMultiProtocolMonitorConstraintDtoProperties</a> | |
|
|
10954
|
+
| type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Constraint type. |
|
|
10955
|
+
|
|
10956
|
+
### SyntheticMultiProtocolMonitorConstraintDtoProperties
|
|
10957
|
+
|
|
10958
|
+
The properties of the constraint.
|
|
10959
|
+
|
|
10960
|
+
### SyntheticMultiProtocolMonitorDto
|
|
10961
|
+
|
|
10962
|
+
Multi-protocol monitor.
|
|
10963
|
+
|
|
10964
|
+
| Name | Type | Description |
|
|
10965
|
+
| -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10966
|
+
| active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If false, the monitor is disabled. <i>default:</i> <code>true</code> |
|
|
10967
|
+
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The entity id of the monitor. |
|
|
10968
|
+
| frequencyMin<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
|
|
10969
|
+
| locations<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations to which the monitor is assigned. |
|
|
10970
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
|
|
10971
|
+
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitordtoproperties">SyntheticMultiProtocolMonitorDtoProperties</a> | |
|
|
10972
|
+
| steps<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>> | The steps of the monitor. |
|
|
10973
|
+
| syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
|
|
10974
|
+
| 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> |
|
|
10975
|
+
| type<sup>\*required</sup> | SyntheticMultiProtocolMonitorDtoType | |
|
|
10976
|
+
|
|
10977
|
+
### SyntheticMultiProtocolMonitorDtoProperties
|
|
10978
|
+
|
|
10979
|
+
The properties of the monitor.
|
|
10980
|
+
|
|
10981
|
+
### SyntheticMultiProtocolMonitorStepDto
|
|
10982
|
+
|
|
10983
|
+
The step of a multi-protocol monitor.
|
|
10984
|
+
|
|
10985
|
+
| Name | Type | Description |
|
|
10986
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
10987
|
+
| constraints<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>> | The list of constraints which apply to all requests in the step. |
|
|
10988
|
+
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a> | |
|
|
10989
|
+
| requestConfigurations<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>> | Request configurations. |
|
|
10990
|
+
| requestType<sup>\*required</sup> | SyntheticMultiProtocolMonitorStepDtoRequestType | |
|
|
10991
|
+
| targetFilter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Target filter. |
|
|
10992
|
+
| targetList<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | Target list. |
|
|
10993
|
+
|
|
10994
|
+
### SyntheticMultiProtocolMonitorStepDtoProperties
|
|
10995
|
+
|
|
10996
|
+
The properties which apply to all requests in the step.
|
|
10997
|
+
|
|
10998
|
+
### SyntheticMultiProtocolMonitorUpdateDto
|
|
10999
|
+
|
|
11000
|
+
Multi-protocol monitor.
|
|
11001
|
+
|
|
11002
|
+
| Name | Type | Description |
|
|
11003
|
+
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11004
|
+
| active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If false, the monitor is disabled. <i>default:</i> <code>true</code> |
|
|
11005
|
+
| frequencyMin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
|
|
11006
|
+
| locations<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations to which the monitor is assigned. |
|
|
11007
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
|
|
11008
|
+
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedtoproperties">SyntheticMultiProtocolMonitorUpdateDtoProperties</a> | |
|
|
11009
|
+
| steps<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>> | The steps of the monitor. |
|
|
11010
|
+
| syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
|
|
11011
|
+
| 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> |
|
|
11012
|
+
| type<sup>\*required</sup> | MultiProtocol | |
|
|
11013
|
+
|
|
11014
|
+
### SyntheticMultiProtocolMonitorUpdateDtoProperties
|
|
11015
|
+
|
|
11016
|
+
The properties of the monitor.
|
|
11017
|
+
|
|
11018
|
+
### SyntheticMultiProtocolRequestConfigurationDto
|
|
11019
|
+
|
|
11020
|
+
The configuration of a multi-protocol monitor request.
|
|
11021
|
+
|
|
11022
|
+
| Name | Type | Description |
|
|
11023
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
|
|
11024
|
+
| constraints<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>> | Request constraints. |
|
|
11025
|
+
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolrequestconfigurationdtoproperties">SyntheticMultiProtocolRequestConfigurationDtoProperties</a> | |
|
|
11026
|
+
|
|
11027
|
+
### SyntheticMultiProtocolRequestConfigurationDtoProperties
|
|
11028
|
+
|
|
11029
|
+
Request properties.
|
|
11030
|
+
|
|
10554
11031
|
### SyntheticOnDemandBatchStatus
|
|
10555
11032
|
|
|
10556
11033
|
Contains information about on-demand executions triggered within the batch.
|
|
@@ -10746,6 +11223,17 @@ The status of public synthetic locations.
|
|
|
10746
11223
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
10747
11224
|
| publicLocationsEnabled<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Synthetic monitors can (<code>true</code>) or can't (<code>false</code>) run on public synthetic locations. |
|
|
10748
11225
|
|
|
11226
|
+
### SyntheticTagWithSourceDto
|
|
11227
|
+
|
|
11228
|
+
The tag with source of a monitored entity.
|
|
11229
|
+
|
|
11230
|
+
| Name | Type | Description |
|
|
11231
|
+
| ------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
11232
|
+
| context | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The origin of the tag, such as AWS or Cloud Foundry.</p> <p>Custom tags use the <code>CONTEXTLESS</code> value.</p> |
|
|
11233
|
+
| key<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The key of the tag. |
|
|
11234
|
+
| source | SyntheticTagWithSourceDtoSource | |
|
|
11235
|
+
| value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the tag. |
|
|
11236
|
+
|
|
10749
11237
|
### TableColumn
|
|
10750
11238
|
|
|
10751
11239
|
The definition of a table column to be used in the ui.
|
|
@@ -10792,7 +11280,7 @@ A credentials set of the `TOKEN` type.
|
|
|
10792
11280
|
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the credentials set. |
|
|
10793
11281
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
10794
11282
|
| ownerAccessOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
10795
|
-
| scope
|
|
11283
|
+
| scope | CredentialsScope | |
|
|
10796
11284
|
| scopes<sup>\*required</sup> | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
|
|
10797
11285
|
| token | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token in the string format. |
|
|
10798
11286
|
| type | CredentialsType | |
|
|
@@ -11026,7 +11514,7 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
11026
11514
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
11027
11515
|
| ownerAccessOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
11028
11516
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The password of the credential. |
|
|
11029
|
-
| scope
|
|
11517
|
+
| scope | CredentialsScope | |
|
|
11030
11518
|
| scopes<sup>\*required</sup> | Array<CredentialsScopesItem> | The set of scopes of the credentials set. |
|
|
11031
11519
|
| type | CredentialsType | |
|
|
11032
11520
|
| user | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The username of the credentials set. |
|
|
@@ -11271,7 +11759,7 @@ The OS architecture that the ActiveGate is running on.
|
|
|
11271
11759
|
|
|
11272
11760
|
<div class="padding-left--md">
|
|
11273
11761
|
|
|
11274
|
-
`S390` | `X86`
|
|
11762
|
+
`Arm` | `S390` | `X86`
|
|
11275
11763
|
|
|
11276
11764
|
</div>
|
|
11277
11765
|
|
|
@@ -11381,7 +11869,7 @@ The type of the ActiveGate.
|
|
|
11381
11869
|
|
|
11382
11870
|
<div class="padding-left--md">
|
|
11383
11871
|
|
|
11384
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UserSessionAnonymization` | `WriteConfig`
|
|
11872
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11385
11873
|
|
|
11386
11874
|
</div>
|
|
11387
11875
|
|
|
@@ -11395,7 +11883,7 @@ The type of the ActiveGate.
|
|
|
11395
11883
|
|
|
11396
11884
|
<div class="padding-left--md">
|
|
11397
11885
|
|
|
11398
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
11886
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
11399
11887
|
|
|
11400
11888
|
</div>
|
|
11401
11889
|
|
|
@@ -11409,7 +11897,7 @@ The type of the ActiveGate.
|
|
|
11409
11897
|
|
|
11410
11898
|
<div class="padding-left--md">
|
|
11411
11899
|
|
|
11412
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UserSessionAnonymization` | `WriteConfig`
|
|
11900
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11413
11901
|
|
|
11414
11902
|
</div>
|
|
11415
11903
|
|
|
@@ -11425,7 +11913,7 @@ The type of the asset.
|
|
|
11425
11913
|
|
|
11426
11914
|
<div class="padding-left--md">
|
|
11427
11915
|
|
|
11428
|
-
`Alert` | `Dashboard` | `DeclarativeProcesses` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
11916
|
+
`Alert` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
11429
11917
|
|
|
11430
11918
|
</div>
|
|
11431
11919
|
|
|
@@ -12045,7 +12533,7 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
12045
12533
|
|
|
12046
12534
|
<div class="padding-left--md">
|
|
12047
12535
|
|
|
12048
|
-
`S390` | `X86`
|
|
12536
|
+
`Arm` | `S390` | `X86`
|
|
12049
12537
|
|
|
12050
12538
|
</div>
|
|
12051
12539
|
|
|
@@ -13050,6 +13538,120 @@ The reachability of related data assets by affected entities.
|
|
|
13050
13538
|
|
|
13051
13539
|
</div>
|
|
13052
13540
|
|
|
13541
|
+
### RiskAssessmentDetailsAssessmentAccuracy
|
|
13542
|
+
|
|
13543
|
+
<div class="padding-left--md">
|
|
13544
|
+
|
|
13545
|
+
The level of available information on which this assessment has been done.
|
|
13546
|
+
|
|
13547
|
+
#### Enum keys
|
|
13548
|
+
|
|
13549
|
+
<div class="padding-left--md">
|
|
13550
|
+
|
|
13551
|
+
`Full` | `NotAvailable` | `Reduced`
|
|
13552
|
+
|
|
13553
|
+
</div>
|
|
13554
|
+
|
|
13555
|
+
</div>
|
|
13556
|
+
|
|
13557
|
+
### RiskAssessmentDetailsBaseRiskLevel
|
|
13558
|
+
|
|
13559
|
+
<div class="padding-left--md">
|
|
13560
|
+
|
|
13561
|
+
The risk level from the CVSS score.
|
|
13562
|
+
|
|
13563
|
+
#### Enum keys
|
|
13564
|
+
|
|
13565
|
+
<div class="padding-left--md">
|
|
13566
|
+
|
|
13567
|
+
`Critical` | `High` | `Low` | `Medium` | `None`
|
|
13568
|
+
|
|
13569
|
+
</div>
|
|
13570
|
+
|
|
13571
|
+
</div>
|
|
13572
|
+
|
|
13573
|
+
### RiskAssessmentDetailsDataAssets
|
|
13574
|
+
|
|
13575
|
+
<div class="padding-left--md">
|
|
13576
|
+
|
|
13577
|
+
The reachability of related data assets by affected entities.
|
|
13578
|
+
|
|
13579
|
+
#### Enum keys
|
|
13580
|
+
|
|
13581
|
+
<div class="padding-left--md">
|
|
13582
|
+
|
|
13583
|
+
`NotAvailable` | `NotDetected` | `Reachable`
|
|
13584
|
+
|
|
13585
|
+
</div>
|
|
13586
|
+
|
|
13587
|
+
</div>
|
|
13588
|
+
|
|
13589
|
+
### RiskAssessmentDetailsExposure
|
|
13590
|
+
|
|
13591
|
+
<div class="padding-left--md">
|
|
13592
|
+
|
|
13593
|
+
The level of exposure of affected entities.
|
|
13594
|
+
|
|
13595
|
+
#### Enum keys
|
|
13596
|
+
|
|
13597
|
+
<div class="padding-left--md">
|
|
13598
|
+
|
|
13599
|
+
`NotAvailable` | `NotDetected` | `PublicNetwork`
|
|
13600
|
+
|
|
13601
|
+
</div>
|
|
13602
|
+
|
|
13603
|
+
</div>
|
|
13604
|
+
|
|
13605
|
+
### RiskAssessmentDetailsPublicExploit
|
|
13606
|
+
|
|
13607
|
+
<div class="padding-left--md">
|
|
13608
|
+
|
|
13609
|
+
The availability status of public exploits.
|
|
13610
|
+
|
|
13611
|
+
#### Enum keys
|
|
13612
|
+
|
|
13613
|
+
<div class="padding-left--md">
|
|
13614
|
+
|
|
13615
|
+
`Available` | `NotAvailable`
|
|
13616
|
+
|
|
13617
|
+
</div>
|
|
13618
|
+
|
|
13619
|
+
</div>
|
|
13620
|
+
|
|
13621
|
+
### RiskAssessmentDetailsRiskLevel
|
|
13622
|
+
|
|
13623
|
+
<div class="padding-left--md">
|
|
13624
|
+
|
|
13625
|
+
The Davis risk level.
|
|
13626
|
+
|
|
13627
|
+
It is calculated by Dynatrace on the basis of CVSS score.
|
|
13628
|
+
|
|
13629
|
+
#### Enum keys
|
|
13630
|
+
|
|
13631
|
+
<div class="padding-left--md">
|
|
13632
|
+
|
|
13633
|
+
`Critical` | `High` | `Low` | `Medium` | `None`
|
|
13634
|
+
|
|
13635
|
+
</div>
|
|
13636
|
+
|
|
13637
|
+
</div>
|
|
13638
|
+
|
|
13639
|
+
### RiskAssessmentDetailsVulnerableFunctionUsage
|
|
13640
|
+
|
|
13641
|
+
<div class="padding-left--md">
|
|
13642
|
+
|
|
13643
|
+
The state of vulnerable code execution.
|
|
13644
|
+
|
|
13645
|
+
#### Enum keys
|
|
13646
|
+
|
|
13647
|
+
<div class="padding-left--md">
|
|
13648
|
+
|
|
13649
|
+
`InUse` | `NotAvailable` | `NotInUse`
|
|
13650
|
+
|
|
13651
|
+
</div>
|
|
13652
|
+
|
|
13653
|
+
</div>
|
|
13654
|
+
|
|
13053
13655
|
### RiskAssessmentExposure
|
|
13054
13656
|
|
|
13055
13657
|
<div class="padding-left--md">
|
|
@@ -13545,6 +14147,84 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
13545
14147
|
|
|
13546
14148
|
</div>
|
|
13547
14149
|
|
|
14150
|
+
### SyntheticMonitorOutageHandlingSettingsDtoType
|
|
14151
|
+
|
|
14152
|
+
<div class="padding-left--md">
|
|
14153
|
+
|
|
14154
|
+
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
14155
|
+
|
|
14156
|
+
- `MULTI_PROTOCOL` -> SyntheticMultiProtocolMonitorUpdateDto
|
|
14157
|
+
|
|
14158
|
+
#### Enum keys
|
|
14159
|
+
|
|
14160
|
+
<div class="padding-left--md">
|
|
14161
|
+
|
|
14162
|
+
`MultiProtocol`
|
|
14163
|
+
|
|
14164
|
+
</div>
|
|
14165
|
+
|
|
14166
|
+
</div>
|
|
14167
|
+
|
|
14168
|
+
### SyntheticMonitorSummaryDtoType
|
|
14169
|
+
|
|
14170
|
+
<div class="padding-left--md">
|
|
14171
|
+
|
|
14172
|
+
#### Enum keys
|
|
14173
|
+
|
|
14174
|
+
<div class="padding-left--md">
|
|
14175
|
+
|
|
14176
|
+
`Browser` | `Http` | `MultiProtocol` | `ThirdParty`
|
|
14177
|
+
|
|
14178
|
+
</div>
|
|
14179
|
+
|
|
14180
|
+
</div>
|
|
14181
|
+
|
|
14182
|
+
### SyntheticMultiProtocolMonitorDtoType
|
|
14183
|
+
|
|
14184
|
+
<div class="padding-left--md">
|
|
14185
|
+
|
|
14186
|
+
#### Enum keys
|
|
14187
|
+
|
|
14188
|
+
<div class="padding-left--md">
|
|
14189
|
+
|
|
14190
|
+
`Browser` | `Http` | `MultiProtocol` | `ThirdParty`
|
|
14191
|
+
|
|
14192
|
+
</div>
|
|
14193
|
+
|
|
14194
|
+
</div>
|
|
14195
|
+
|
|
14196
|
+
### SyntheticMultiProtocolMonitorStepDtoRequestType
|
|
14197
|
+
|
|
14198
|
+
<div class="padding-left--md">
|
|
14199
|
+
|
|
14200
|
+
Request type.
|
|
14201
|
+
|
|
14202
|
+
#### Enum keys
|
|
14203
|
+
|
|
14204
|
+
<div class="padding-left--md">
|
|
14205
|
+
|
|
14206
|
+
`Dns` | `Icmp` | `Tcp`
|
|
14207
|
+
|
|
14208
|
+
</div>
|
|
14209
|
+
|
|
14210
|
+
</div>
|
|
14211
|
+
|
|
14212
|
+
### SyntheticMultiProtocolMonitorUpdateDtoType
|
|
14213
|
+
|
|
14214
|
+
<div class="padding-left--md">
|
|
14215
|
+
|
|
14216
|
+
Monitor type.
|
|
14217
|
+
|
|
14218
|
+
#### Enum keys
|
|
14219
|
+
|
|
14220
|
+
<div class="padding-left--md">
|
|
14221
|
+
|
|
14222
|
+
`MultiProtocol`
|
|
14223
|
+
|
|
14224
|
+
</div>
|
|
14225
|
+
|
|
14226
|
+
</div>
|
|
14227
|
+
|
|
13548
14228
|
### SyntheticOnDemandBatchStatusBatchStatus
|
|
13549
14229
|
|
|
13550
14230
|
<div class="padding-left--md">
|
|
@@ -13657,6 +14337,22 @@ Execution stage.
|
|
|
13657
14337
|
|
|
13658
14338
|
</div>
|
|
13659
14339
|
|
|
14340
|
+
### SyntheticTagWithSourceDtoSource
|
|
14341
|
+
|
|
14342
|
+
<div class="padding-left--md">
|
|
14343
|
+
|
|
14344
|
+
The source of the tag, such as USER, RULE_BASED or AUTO.
|
|
14345
|
+
|
|
14346
|
+
#### Enum keys
|
|
14347
|
+
|
|
14348
|
+
<div class="padding-left--md">
|
|
14349
|
+
|
|
14350
|
+
`Auto` | `RuleBased` | `User`
|
|
14351
|
+
|
|
14352
|
+
</div>
|
|
14353
|
+
|
|
14354
|
+
</div>
|
|
14355
|
+
|
|
13660
14356
|
### UpdateJobAgType
|
|
13661
14357
|
|
|
13662
14358
|
<div class="padding-left--md">
|