@dynatrace-sdk/client-classic-environment-v2 1.3.0 → 1.4.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 +6 -0
- package/README.md +1 -1
- package/cjs/index.js +2913 -2784
- package/docs/DOCS.md +259 -122
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +2913 -2784
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +70 -22
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +17 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +35 -13
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.d.ts +7 -17
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.transformation.d.ts +5 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-architecture.d.ts +1 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-certificate-response-element.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-certificate-response-element.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-username-password-response-element.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-username-password-response-element.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +10 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto-updates.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto-updates.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link-update.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link-update.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link.transformation.d.ts +9 -0
- package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-scopes-item.d.ts +0 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-scopes-item.transformation.d.ts +0 -4
package/docs/DOCS.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: Classic Environment V2
|
|
2
|
+
title: "Classic Environment V2"
|
|
3
3
|
description: Client for the Dynatrace Environment API v2
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -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.4.0">v1.4.0</a>
|
|
28
28
|
</div>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
@@ -1364,7 +1364,7 @@ Ingests a business event
|
|
|
1364
1364
|
**Required scope:** storage:events:write
|
|
1365
1365
|
**Required permission:** storage:events:write
|
|
1366
1366
|
|
|
1367
|
-
The ingestion of business events
|
|
1367
|
+
The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
1368
1368
|
|
|
1369
1369
|
</div>
|
|
1370
1370
|
|
|
@@ -1555,7 +1555,7 @@ const data = await credentialVaultClient.getCredentialsDetails({
|
|
|
1555
1555
|
|
|
1556
1556
|
<div class="padding-left--md">
|
|
1557
1557
|
|
|
1558
|
-
Lists all sets of credentials
|
|
1558
|
+
Lists all sets of credentials in your environment.
|
|
1559
1559
|
|
|
1560
1560
|
**Required scope:** environment-api:credentials:read
|
|
1561
1561
|
**Required permission:** environment:roles:viewer
|
|
@@ -1764,7 +1764,7 @@ Ingests a custom event
|
|
|
1764
1764
|
- environment:roles:viewer
|
|
1765
1765
|
- storage:events:write
|
|
1766
1766
|
|
|
1767
|
-
The ingestion of custom events
|
|
1767
|
+
The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
1768
1768
|
|
|
1769
1769
|
</div>
|
|
1770
1770
|
|
|
@@ -2065,7 +2065,10 @@ import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-
|
|
|
2065
2065
|
Activates the environment configuration from the specified version of the extension 2.0
|
|
2066
2066
|
|
|
2067
2067
|
**Required scope:** environment-api:extensions:write
|
|
2068
|
-
**
|
|
2068
|
+
**One of the following permissions is required:**
|
|
2069
|
+
|
|
2070
|
+
- environment:roles:manage-settings
|
|
2071
|
+
- extensions:definitions:write
|
|
2069
2072
|
|
|
2070
2073
|
</div>
|
|
2071
2074
|
|
|
@@ -2110,7 +2113,10 @@ const data =
|
|
|
2110
2113
|
Creates new monitoring configuration for the specified extension 2.0
|
|
2111
2114
|
|
|
2112
2115
|
**Required scope:** environment-api:extension-configurations:write
|
|
2113
|
-
**
|
|
2116
|
+
**One of the following permissions is required:**
|
|
2117
|
+
|
|
2118
|
+
- environment:roles:manage-settings
|
|
2119
|
+
- extensions:configurations:write
|
|
2114
2120
|
|
|
2115
2121
|
</div>
|
|
2116
2122
|
|
|
@@ -2172,7 +2178,10 @@ const data = await extensions_2_0Client.createMonitoringConfiguration({
|
|
|
2172
2178
|
Deactivates the environment configuration of the specified extension 2.0
|
|
2173
2179
|
|
|
2174
2180
|
**Required scope:** environment-api:extensions:write
|
|
2175
|
-
**
|
|
2181
|
+
**One of the following permissions is required:**
|
|
2182
|
+
|
|
2183
|
+
- environment:roles:manage-settings
|
|
2184
|
+
- extensions:definitions:write
|
|
2176
2185
|
|
|
2177
2186
|
</div>
|
|
2178
2187
|
|
|
@@ -2214,7 +2223,10 @@ const data = await extensions_2_0Client.deleteEnvironmentConfiguration({
|
|
|
2214
2223
|
Gets the configuration schema of the specified version of the extension 2.0
|
|
2215
2224
|
|
|
2216
2225
|
**Required scope:** environment-api:extension-configurations:read
|
|
2217
|
-
**
|
|
2226
|
+
**One of the following permissions is required:**
|
|
2227
|
+
|
|
2228
|
+
- environment:roles:manage-settings
|
|
2229
|
+
- extensions:definitions:read
|
|
2218
2230
|
|
|
2219
2231
|
</div>
|
|
2220
2232
|
|
|
@@ -2258,7 +2270,10 @@ const data = await extensions_2_0Client.extensionConfigurationSchema({
|
|
|
2258
2270
|
Gets details of the specified version of the extension 2.0
|
|
2259
2271
|
|
|
2260
2272
|
**Required scope:** environment-api:extensions:read
|
|
2261
|
-
**
|
|
2273
|
+
**One of the following permissions is required:**
|
|
2274
|
+
|
|
2275
|
+
- environment:roles:manage-settings
|
|
2276
|
+
- extensions:definitions:read
|
|
2262
2277
|
|
|
2263
2278
|
</div>
|
|
2264
2279
|
|
|
@@ -2304,7 +2319,10 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
2304
2319
|
Lists all the monitoring configurations of the specified extension 2.0
|
|
2305
2320
|
|
|
2306
2321
|
**Required scope:** environment-api:extension-configurations:read
|
|
2307
|
-
**
|
|
2322
|
+
**One of the following permissions is required:**
|
|
2323
|
+
|
|
2324
|
+
- environment:roles:manage-settings
|
|
2325
|
+
- extensions:configurations:read
|
|
2308
2326
|
|
|
2309
2327
|
</div>
|
|
2310
2328
|
|
|
@@ -2350,7 +2368,10 @@ const data = await extensions_2_0Client.extensionMonitoringConfigurations({
|
|
|
2350
2368
|
Gets the active environment configuration version of the specified extension 2.0
|
|
2351
2369
|
|
|
2352
2370
|
**Required scope:** environment-api:extensions:read
|
|
2353
|
-
**
|
|
2371
|
+
**One of the following permissions is required:**
|
|
2372
|
+
|
|
2373
|
+
- environment:roles:manage-settings
|
|
2374
|
+
- extensions:definitions:read
|
|
2354
2375
|
|
|
2355
2376
|
</div>
|
|
2356
2377
|
|
|
@@ -2392,7 +2413,10 @@ const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
|
|
|
2392
2413
|
Gets the information about assets in an active extension 2.0
|
|
2393
2414
|
|
|
2394
2415
|
**Required scope:** environment-api:extensions:read
|
|
2395
|
-
**
|
|
2416
|
+
**One of the following permissions is required:**
|
|
2417
|
+
|
|
2418
|
+
- environment:roles:manage-settings
|
|
2419
|
+
- extensions:definitions:read
|
|
2396
2420
|
|
|
2397
2421
|
</div>
|
|
2398
2422
|
|
|
@@ -2434,7 +2458,10 @@ const data = await extensions_2_0Client.getEnvironmentConfigurationAssetsInfo({
|
|
|
2434
2458
|
List of the latest extension environment configuration events
|
|
2435
2459
|
|
|
2436
2460
|
**Required scope:** environment-api:extensions:read
|
|
2437
|
-
**
|
|
2461
|
+
**One of the following permissions is required:**
|
|
2462
|
+
|
|
2463
|
+
- environment:roles:manage-settings
|
|
2464
|
+
- extensions:definitions:read
|
|
2438
2465
|
|
|
2439
2466
|
</div>
|
|
2440
2467
|
|
|
@@ -2480,7 +2507,10 @@ const data = await extensions_2_0Client.getEnvironmentConfigurationEvents({
|
|
|
2480
2507
|
Gets the list of the events linked to specific monitoring configuration
|
|
2481
2508
|
|
|
2482
2509
|
**Required scope:** environment-api:extension-configurations:read
|
|
2483
|
-
**
|
|
2510
|
+
**One of the following permissions is required:**
|
|
2511
|
+
|
|
2512
|
+
- environment:roles:manage-settings
|
|
2513
|
+
- extensions:configurations:read
|
|
2484
2514
|
|
|
2485
2515
|
</div>
|
|
2486
2516
|
|
|
@@ -2532,7 +2562,10 @@ const data =
|
|
|
2532
2562
|
Gets the most recent status of the execution of given monitoring configuration
|
|
2533
2563
|
|
|
2534
2564
|
**Required scope:** environment-api:extension-configurations:read
|
|
2535
|
-
**
|
|
2565
|
+
**One of the following permissions is required:**
|
|
2566
|
+
|
|
2567
|
+
- environment:roles:manage-settings
|
|
2568
|
+
- extensions:configurations:read
|
|
2536
2569
|
|
|
2537
2570
|
</div>
|
|
2538
2571
|
|
|
@@ -2577,7 +2610,10 @@ const data =
|
|
|
2577
2610
|
Gets the extension 2.0 schema file in the specified version
|
|
2578
2611
|
|
|
2579
2612
|
**Required scope:** environment-api:extensions:read
|
|
2580
|
-
**
|
|
2613
|
+
**One of the following permissions is required:**
|
|
2614
|
+
|
|
2615
|
+
- environment:roles:manage-settings
|
|
2616
|
+
- extensions:definitions:read
|
|
2581
2617
|
|
|
2582
2618
|
</div>
|
|
2583
2619
|
|
|
@@ -2621,7 +2657,10 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
2621
2657
|
Lists all versions of the extension 2.0
|
|
2622
2658
|
|
|
2623
2659
|
**Required scope:** environment-api:extensions:read
|
|
2624
|
-
**
|
|
2660
|
+
**One of the following permissions is required:**
|
|
2661
|
+
|
|
2662
|
+
- environment:roles:manage-settings
|
|
2663
|
+
- extensions:definitions:read
|
|
2625
2664
|
|
|
2626
2665
|
</div>
|
|
2627
2666
|
|
|
@@ -2665,7 +2704,10 @@ const data = await extensions_2_0Client.listExtensionVersions({
|
|
|
2665
2704
|
Lists all the extensions 2.0 available in your environment
|
|
2666
2705
|
|
|
2667
2706
|
**Required scope:** environment-api:extensions:read
|
|
2668
|
-
**
|
|
2707
|
+
**One of the following permissions is required:**
|
|
2708
|
+
|
|
2709
|
+
- environment:roles:manage-settings
|
|
2710
|
+
- extensions:definitions:read
|
|
2669
2711
|
|
|
2670
2712
|
</div>
|
|
2671
2713
|
|
|
@@ -2707,7 +2749,10 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
2707
2749
|
Lists all the files available for the specified extension 2.0 schema version
|
|
2708
2750
|
|
|
2709
2751
|
**Required scope:** environment-api:extensions:read
|
|
2710
|
-
**
|
|
2752
|
+
**One of the following permissions is required:**
|
|
2753
|
+
|
|
2754
|
+
- environment:roles:manage-settings
|
|
2755
|
+
- extensions:definitions:read
|
|
2711
2756
|
|
|
2712
2757
|
</div>
|
|
2713
2758
|
|
|
@@ -2751,7 +2796,10 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
2751
2796
|
Lists all the extension 2.0 schemas versions available in your environment
|
|
2752
2797
|
|
|
2753
2798
|
**Required scope:** environment-api:extensions:read
|
|
2754
|
-
**
|
|
2799
|
+
**One of the following permissions is required:**
|
|
2800
|
+
|
|
2801
|
+
- environment:roles:manage-settings
|
|
2802
|
+
- extensions:definitions:read
|
|
2755
2803
|
|
|
2756
2804
|
</div>
|
|
2757
2805
|
|
|
@@ -2787,7 +2835,10 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
2787
2835
|
Gets the details of the specified monitoring configuration
|
|
2788
2836
|
|
|
2789
2837
|
**Required scope:** environment-api:extension-configurations:read
|
|
2790
|
-
**
|
|
2838
|
+
**One of the following permissions is required:**
|
|
2839
|
+
|
|
2840
|
+
- environment:roles:manage-settings
|
|
2841
|
+
- extensions:configurations:read
|
|
2791
2842
|
|
|
2792
2843
|
</div>
|
|
2793
2844
|
|
|
@@ -2831,7 +2882,10 @@ const data = await extensions_2_0Client.monitoringConfigurationDetails({
|
|
|
2831
2882
|
Deletes the specified version of the extension 2.0
|
|
2832
2883
|
|
|
2833
2884
|
**Required scope:** environment-api:extensions:write
|
|
2834
|
-
**
|
|
2885
|
+
**One of the following permissions is required:**
|
|
2886
|
+
|
|
2887
|
+
- environment:roles:manage-settings
|
|
2888
|
+
- extensions:definitions:write
|
|
2835
2889
|
|
|
2836
2890
|
</div>
|
|
2837
2891
|
|
|
@@ -2875,7 +2929,10 @@ const data = await extensions_2_0Client.removeExtension({
|
|
|
2875
2929
|
Deletes the specified monitoring configuration
|
|
2876
2930
|
|
|
2877
2931
|
**Required scope:** environment-api:extension-configurations:write
|
|
2878
|
-
**
|
|
2932
|
+
**One of the following permissions is required:**
|
|
2933
|
+
|
|
2934
|
+
- environment:roles:manage-settings
|
|
2935
|
+
- extensions:configurations:write
|
|
2879
2936
|
|
|
2880
2937
|
</div>
|
|
2881
2938
|
|
|
@@ -2917,7 +2974,10 @@ const data = await extensions_2_0Client.removeMonitoringConfiguration({
|
|
|
2917
2974
|
Updates the active environment configuration version of the extension 2.0
|
|
2918
2975
|
|
|
2919
2976
|
**Required scope:** environment-api:extensions:write
|
|
2920
|
-
**
|
|
2977
|
+
**One of the following permissions is required:**
|
|
2978
|
+
|
|
2979
|
+
- environment:roles:manage-settings
|
|
2980
|
+
- extensions:definitions:write
|
|
2921
2981
|
|
|
2922
2982
|
</div>
|
|
2923
2983
|
|
|
@@ -2960,7 +3020,10 @@ const data = await extensions_2_0Client.updateExtensionEnvironmentConfiguration(
|
|
|
2960
3020
|
Updates the specified monitoring configuration
|
|
2961
3021
|
|
|
2962
3022
|
**Required scope:** environment-api:extension-configurations:write
|
|
2963
|
-
**
|
|
3023
|
+
**One of the following permissions is required:**
|
|
3024
|
+
|
|
3025
|
+
- environment:roles:manage-settings
|
|
3026
|
+
- extensions:configurations:write
|
|
2964
3027
|
|
|
2965
3028
|
</div>
|
|
2966
3029
|
|
|
@@ -3006,7 +3069,10 @@ const data = await extensions_2_0Client.updateMonitoringConfiguration({
|
|
|
3006
3069
|
Uploads or verifies a new extension 2.0
|
|
3007
3070
|
|
|
3008
3071
|
**Required scope:** environment-api:extensions:write
|
|
3009
|
-
**
|
|
3072
|
+
**One of the following permissions is required:**
|
|
3073
|
+
|
|
3074
|
+
- environment:roles:manage-settings
|
|
3075
|
+
- extensions:definitions:write
|
|
3010
3076
|
|
|
3011
3077
|
</div>
|
|
3012
3078
|
|
|
@@ -3116,7 +3182,7 @@ Returns the aggregated number of occurrences of log values divided into time slo
|
|
|
3116
3182
|
|
|
3117
3183
|
It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
|
|
3118
3184
|
|
|
3119
|
-
If _Log Management and Analytics, powered by Grail_ is enabled, then
|
|
3185
|
+
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.
|
|
3120
3186
|
|
|
3121
3187
|
</div>
|
|
3122
3188
|
|
|
@@ -3169,7 +3235,7 @@ If the query is too large to be processed in a single request, it is divided int
|
|
|
3169
3235
|
|
|
3170
3236
|
Results can be distributed unevenly between slices and some slices might be empty.
|
|
3171
3237
|
|
|
3172
|
-
If _Log Management and Analytics, powered by Grail_ is enabled, then
|
|
3238
|
+
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.
|
|
3173
3239
|
|
|
3174
3240
|
</div>
|
|
3175
3241
|
|
|
@@ -4099,9 +4165,11 @@ Only process group instances are supported.
|
|
|
4099
4165
|
|
|
4100
4166
|
#### Parameters
|
|
4101
4167
|
|
|
4102
|
-
| Name
|
|
4103
|
-
|
|
|
4104
|
-
| config.entitySelector
|
|
4168
|
+
| Name | Type | Description |
|
|
4169
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
4170
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</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> |
|
|
4171
|
+
| 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> |
|
|
4172
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
|
|
4105
4173
|
|
|
4106
4174
|
#### Returns
|
|
4107
4175
|
|
|
@@ -4116,9 +4184,7 @@ Code example
|
|
|
4116
4184
|
```ts
|
|
4117
4185
|
import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
4118
4186
|
|
|
4119
|
-
const data = await monitoredEntitiesMonitoringStateClient.getStates(
|
|
4120
|
-
entitySelector: "...",
|
|
4121
|
-
});
|
|
4187
|
+
const data = await monitoredEntitiesMonitoringStateClient.getStates();
|
|
4122
4188
|
```
|
|
4123
4189
|
|
|
4124
4190
|
</details>
|
|
@@ -4850,10 +4916,10 @@ Mutes several remediation items
|
|
|
4850
4916
|
|
|
4851
4917
|
#### Parameters
|
|
4852
4918
|
|
|
4853
|
-
| Name | Type | Description
|
|
4854
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
4855
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a> |
|
|
4856
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
4919
|
+
| Name | Type | Description |
|
|
4920
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
4921
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a> | |
|
|
4922
|
+
| 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. |
|
|
4857
4923
|
|
|
4858
4924
|
#### Returns
|
|
4859
4925
|
|
|
@@ -4936,10 +5002,10 @@ Un-mutes several remediation items
|
|
|
4936
5002
|
|
|
4937
5003
|
#### Parameters
|
|
4938
5004
|
|
|
4939
|
-
| Name | Type | Description
|
|
4940
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
4941
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a> |
|
|
4942
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5005
|
+
| Name | Type | Description |
|
|
5006
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5007
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a> | |
|
|
5008
|
+
| 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. |
|
|
4943
5009
|
|
|
4944
5010
|
#### Returns
|
|
4945
5011
|
|
|
@@ -5028,7 +5094,7 @@ Lists all events of a security problem
|
|
|
5028
5094
|
| Name | Type | Description |
|
|
5029
5095
|
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5030
5096
|
| 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 thirty days is used (<code>now-30d</code>).</p> |
|
|
5031
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5097
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5032
5098
|
| 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> |
|
|
5033
5099
|
|
|
5034
5100
|
#### Returns
|
|
@@ -5072,10 +5138,10 @@ Gets parameters of a remediation item of a security problem
|
|
|
5072
5138
|
|
|
5073
5139
|
#### Parameters
|
|
5074
5140
|
|
|
5075
|
-
| Name | Type | Description
|
|
5076
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5077
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5078
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5141
|
+
| Name | Type | Description |
|
|
5142
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5143
|
+
| 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. |
|
|
5144
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5079
5145
|
|
|
5080
5146
|
#### Returns
|
|
5081
5147
|
|
|
@@ -5119,10 +5185,10 @@ Lists remediation items of a third-party security problem
|
|
|
5119
5185
|
|
|
5120
5186
|
#### Parameters
|
|
5121
5187
|
|
|
5122
|
-
| Name | Type | Description
|
|
5123
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5124
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5125
|
-
| 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> </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> |
|
|
5188
|
+
| Name | Type | Description |
|
|
5189
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5190
|
+
| 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. |
|
|
5191
|
+
| 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> |
|
|
5126
5192
|
|
|
5127
5193
|
#### Returns
|
|
5128
5194
|
|
|
@@ -5167,7 +5233,7 @@ Lists remediation progress entities
|
|
|
5167
5233
|
|
|
5168
5234
|
| Name | Type | Description |
|
|
5169
5235
|
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5170
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5236
|
+
| 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. |
|
|
5171
5237
|
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5172
5238
|
| 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> |
|
|
5173
5239
|
|
|
@@ -5217,7 +5283,7 @@ Gets parameters of a security problem
|
|
|
5217
5283
|
| ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5218
5284
|
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> <li><code>filteredCounts</code>: Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.</li> <li><code>description</code>: The description of the vulnerability.</li> <li><code>events</code>: The security problem's last 10 events within the last 365 days, sorted from newest to oldest.</li> <li><code>vulnerableComponents</code>: A list of vulnerable components of the security problem within the provided filter range.</li> <li><code>affectedEntities</code>: A list of affected entities of the security problem within the provided filter range.</li> <li><code>exposedEntities</code>: A list of exposed entities of the security problem within the provided filter range.</li> <li><code>reachableDataAssets</code>: A list of data assets reachable by affected entities of the security problem within the provided filter range.</li> <li><code>relatedEntities</code>: A list of related entities of the security problem within the provided filter range.</li> <li><code>relatedContainerImages</code>: A list of related container images of the security problem within the provided filter range.</li> <li><code>relatedAttacks</code>: A list of attacks detected on the exposed security problem.</li> <li><code>entryPoints</code>: A list of entry points and a flag which indicates whether this list was truncated or not.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
|
|
5219
5285
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Based on the timeframe start the affected-, related- and vulnerable entities are being calculated. 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 default timeframe start of 24 hours in the past is used (<code>now-24h</code>).</p> <p>The timeframe start must not be older than 365 days.</p> |
|
|
5220
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5286
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5221
5287
|
|
|
5222
5288
|
#### Returns
|
|
5223
5289
|
|
|
@@ -5267,7 +5333,7 @@ Lists all security problems
|
|
|
5267
5333
|
| 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> |
|
|
5268
5334
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of security problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
5269
5335
|
| config.securityProblemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only security problems 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>Status: <code>status("value")</code>. Find the possible values in the description of the <strong>status</strong> field of the response. If not set, all security problems are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Risk level: <code>riskLevel("value")</code>. The Davis risk level. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum risk score: <code>minRiskScore("5.5")</code>. The Davis minimum risk score. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum risk score: <code>maxRiskScore("5.5")</code>. The Davis maximum risk score. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Base risk level: <code>baseRiskLevel("value")</code>. The Base risk level from the CVSS. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum base risk score: <code>minBaseRiskScore("5.5")</code>. The minimum base risk score from the CVSS. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum base risk score: <code>maxBaseRiskScore("5.5")</code>. The maximum base risk score from the CVSS. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>External vulnerability ID contains: <code>externalVulnerabilityIdContains("id-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>External vulnerability ID: <code>externalVulnerabilityId("id-1", "id-2")</code>.</li> <li>CVE ID: <code>cveId("id")</code>.</li> <li>Risk assessment <code>riskAssessment("value-1", "value-2")</code> Possible values are <code>EXPOSED</code>, <code>SENSITIVE</code>, <code>EXPLOIT</code>, <code>VULNERABLE_FUNCTION_IN_USE</code> and <code>ACCURACY_REDUCED</code>.</li> <li>Related host ID: <code>relatedHostIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related host name: <code>relatedHostNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related host name contains: <code>relatedHostNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes cluster ID: <code>relatedKubernetesClusterIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes cluster name: <code>relatedKubernetesClusterNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes cluster name contains: <code>relatedKubernetesClusterNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes workload ID: <code>relatedKubernetesWorkloadIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes workload name: <code>relatedKubernetesWorkloadNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes workload name contains: <code>relatedKubernetesWorkloadNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Management zone ID: <code>managementZoneIds("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group instance ID: <code>affectedPgiIds("pgiId-1", "pgiId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group ID: <code>affectedPgIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group name: <code>affectedPgNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group name contains: <code>affectedPgNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerable component ID: <code>vulnerableComponentIds("componentId-1", "componentId-2")</code>. Specify component IDs here.</li> <li>Vulnerable component name: <code>vulnerableComponentNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Vulnerable component name contains: <code>vulnerableComponentNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Host tags: <code>hostTags("hostTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group tags: <code>pgTags("pgTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group instance tags: <code>pgiTags("pgiTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Tags: <code>tags("tag-1")</code>. The <code>CONTAINS</code> operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.</li> <li>Display ID: <code>displayIds("S-1234", "S-5678")</code>. The <code>EQUALS</code> operator is used.</li> <li>Security problem ID: <code>securityProblemIds("12544152654387159360", "5904857564184044850")</code>. The <code>EQUALS</code> operator is used.</li> <li>Technology: <code>technology("technology-1", "technology-2")</code>. Find the possible values in the description of the <strong>technology</strong> field of the response. The <code>EQUALS</code> operator is used.</li> <li>Vulnerability type: <code>vulnerabilityType("type-1", "type-2")</code>. Possible values are <code>THIRD_PARTY</code>, <code>CODE_LEVEL</code>, <code>RUNTIME</code>.</li> </ul> <p>Risk score and risk category are mutually exclusive (cannot be used at the same time).</p> <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> |
|
|
5270
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+status,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: The security problem status (<code>+</code> open first or <code>-</code> resolved first)</li> <li><code>muted</code>: The security problem mute state (<code>+</code> unmuted first or <code>-</code> muted first)</li> <li><code>technology</code>: The security problem technology</li> <li><code>firstSeenTimestamp</code>: The timestamp of the first occurrence of the security problem (<code>+</code> new problems first or <code>-</code> old problems first)</li> <li><code>lastUpdatedTimestamp</code>: The timestamp of the last update of the security problem (<code>+</code> recently updated problems first or <code>-</code> earlier updated problems first)</li> <li><code>securityProblemId</code>: The auto-generated ID of the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>externalVulnerabilityId</code>: The ID of the external vulnerability (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>displayId</code>: The display ID (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>riskAssessment.riskScore</code>:
|
|
5336
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+status,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: The security problem status (<code>+</code> open first or <code>-</code> resolved first)</li> <li><code>muted</code>: The security problem mute state (<code>+</code> unmuted first or <code>-</code> muted first)</li> <li><code>technology</code>: The security problem technology</li> <li><code>firstSeenTimestamp</code>: The timestamp of the first occurrence of the security problem (<code>+</code> new problems first or <code>-</code> old problems first)</li> <li><code>lastUpdatedTimestamp</code>: The timestamp of the last update of the security problem (<code>+</code> recently updated problems first or <code>-</code> earlier updated problems first)</li> <li><code>securityProblemId</code>: The auto-generated ID of the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>externalVulnerabilityId</code>: The ID of the external vulnerability (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>displayId</code>: The display ID (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>riskAssessment.riskScore</code>: Davis Security Score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.riskLevel</code>: Davis Security Score level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.exposure</code>: Whether the problem is exposed to the internet</li> <li><code>riskAssessment.baseRiskScore</code>: The CVSS score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.baseRiskLevel</code>: The CVSS level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.dataAssets</code>: Whether data assets are affected</li> <li><code>riskAssessment.vulnerableFunctionUsage</code>: Whether vulnerable functions are used</li> <li><code>riskAssessment.assessmentAccuracy</code>: The assessments accuracy (<code>+</code> less accuracy first or <code>-</code> more accuracy first)</li> <li><code>globalCounts.affectedNodes</code>: Number of affected nodes (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroupInstances</code>: Number of affected process group instances (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroups</code>: Number of affected process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.exposedProcessGroups</code>: Number of exposed process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.reachableDataAssets</code>: Number of reachable data assets (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedApplications</code>: Number of related applications (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedAttacks</code>: Number of attacks on the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedHosts</code>: Number of related hosts (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesClusters</code>: Number of related Kubernetes cluster (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesWorkloads</code>: Number of related Kubernetes workloads (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedServices</code>: Number of related services (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.vulnerableComponents</code>: Number of vulnerable components (<code>+</code> lower number first or <code>-</code> higher number first)</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> |
|
|
5271
5337
|
| 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> <p>The end of the timeframe must not be older than 365 days.</p> |
|
|
5272
5338
|
|
|
5273
5339
|
#### Returns
|
|
@@ -5312,7 +5378,7 @@ Lists all vulnerable functions and their usage for a third-party security proble
|
|
|
5312
5378
|
| Name | Type | Description |
|
|
5313
5379
|
| ---------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5314
5380
|
| config.groupBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines additional grouping types in which vulnerable functions should be displayed.</p> <p>You can add one of the following grouping types.</p> <ul> <li>Process group: <code>PROCESS_GROUP</code></li> </ul> |
|
|
5315
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5381
|
+
| 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. |
|
|
5316
5382
|
| config.vulnerableFunctionsSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.</p> <p>You can add the following criteria. Values are <em>not</em> case sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Management zone ID: <code>managementZoneIds("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group ID: <code>processGroupIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Process group name: <code>processGroupNames("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group name contains: <code>processGroupNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <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> |
|
|
5317
5383
|
|
|
5318
5384
|
#### Returns
|
|
@@ -5353,10 +5419,10 @@ Mutes a security problem
|
|
|
5353
5419
|
|
|
5354
5420
|
#### Parameters
|
|
5355
5421
|
|
|
5356
|
-
| Name | Type | Description
|
|
5357
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
5358
|
-
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> |
|
|
5359
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5422
|
+
| Name | Type | Description |
|
|
5423
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
5424
|
+
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> | |
|
|
5425
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5360
5426
|
|
|
5361
5427
|
<!-- no returns -->
|
|
5362
5428
|
|
|
@@ -5395,11 +5461,11 @@ Sets the mute state of a remediation item
|
|
|
5395
5461
|
|
|
5396
5462
|
#### Parameters
|
|
5397
5463
|
|
|
5398
|
-
| Name | Type | Description
|
|
5399
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5400
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a> |
|
|
5401
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5402
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5464
|
+
| Name | Type | Description |
|
|
5465
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5466
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a> | |
|
|
5467
|
+
| 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. |
|
|
5468
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5403
5469
|
|
|
5404
5470
|
<!-- no returns -->
|
|
5405
5471
|
|
|
@@ -5423,6 +5489,48 @@ const data = await securityProblemsClient.setRemediationItemMuteState({
|
|
|
5423
5489
|
|
|
5424
5490
|
</div>
|
|
5425
5491
|
|
|
5492
|
+
### trackingLinkBulkUpdateAndDelete
|
|
5493
|
+
|
|
5494
|
+
<div class="padding-bottom--md">
|
|
5495
|
+
<strong>securityProblemsClient.trackingLinkBulkUpdateAndDelete(config): Promise<void></strong>
|
|
5496
|
+
|
|
5497
|
+
<div class="padding-left--md">
|
|
5498
|
+
|
|
5499
|
+
Updates the external tracking links of the remediation items. | maturity=EARLY_ADOPTER
|
|
5500
|
+
|
|
5501
|
+
**Required scope:** environment-api:security-problems:write
|
|
5502
|
+
**Required permission:** environment:roles:manage-security-problems
|
|
5503
|
+
|
|
5504
|
+
</div>
|
|
5505
|
+
|
|
5506
|
+
#### Parameters
|
|
5507
|
+
|
|
5508
|
+
| Name | Type | Description |
|
|
5509
|
+
| -------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5510
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a> | |
|
|
5511
|
+
| 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. |
|
|
5512
|
+
|
|
5513
|
+
<!-- no returns -->
|
|
5514
|
+
|
|
5515
|
+
<details>
|
|
5516
|
+
<summary>
|
|
5517
|
+
Code example
|
|
5518
|
+
|
|
5519
|
+
</summary>
|
|
5520
|
+
|
|
5521
|
+
```ts
|
|
5522
|
+
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
5523
|
+
|
|
5524
|
+
const data = await securityProblemsClient.trackingLinkBulkUpdateAndDelete({
|
|
5525
|
+
id: "...",
|
|
5526
|
+
body: {},
|
|
5527
|
+
});
|
|
5528
|
+
```
|
|
5529
|
+
|
|
5530
|
+
</details>
|
|
5531
|
+
|
|
5532
|
+
</div>
|
|
5533
|
+
|
|
5426
5534
|
### unmuteSecurityProblem
|
|
5427
5535
|
|
|
5428
5536
|
<div class="padding-bottom--md">
|
|
@@ -5439,10 +5547,10 @@ Un-mutes a security problem
|
|
|
5439
5547
|
|
|
5440
5548
|
#### Parameters
|
|
5441
5549
|
|
|
5442
|
-
| Name | Type | Description
|
|
5443
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
5444
|
-
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> |
|
|
5445
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5550
|
+
| Name | Type | Description |
|
|
5551
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
5552
|
+
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> | |
|
|
5553
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5446
5554
|
|
|
5447
5555
|
<!-- no returns -->
|
|
5448
5556
|
|
|
@@ -5636,19 +5744,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
|
|
|
5636
5744
|
|
|
5637
5745
|
#### Parameters
|
|
5638
5746
|
|
|
5639
|
-
| Name | Type | Description
|
|
5640
|
-
| --------------------- | ------------------------------------------------------------------------------- |
|
|
5641
|
-
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>).
|
|
5642
|
-
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>).
|
|
5643
|
-
| config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25.
|
|
5644
|
-
| 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 two weeks is used (<code>now-2w</code>).</p>
|
|
5645
|
-
| 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>
|
|
5646
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p>
|
|
5647
|
-
| config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>).
|
|
5648
|
-
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> |
|
|
5649
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p>
|
|
5650
|
-
| config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
5651
|
-
| 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>
|
|
5747
|
+
| Name | Type | Description |
|
|
5748
|
+
| --------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5749
|
+
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). |
|
|
5750
|
+
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). |
|
|
5751
|
+
| config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. |
|
|
5752
|
+
| 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 two weeks is used (<code>now-2w</code>).</p> |
|
|
5753
|
+
| 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> |
|
|
5754
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
|
|
5755
|
+
| config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). |
|
|
5756
|
+
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> |
|
|
5757
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> |
|
|
5758
|
+
| config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> |
|
|
5759
|
+
| 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> |
|
|
5652
5760
|
|
|
5653
5761
|
#### Returns
|
|
5654
5762
|
|
|
@@ -5943,14 +6051,16 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
5943
6051
|
|
|
5944
6052
|
#### Parameters
|
|
5945
6053
|
|
|
5946
|
-
| Name | Type | Description
|
|
5947
|
-
| ------------------ | ----------------------------------------------------------------------------- |
|
|
5948
|
-
| config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p>
|
|
5949
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p>
|
|
5950
|
-
| config.
|
|
5951
|
-
| config.
|
|
5952
|
-
| config.
|
|
5953
|
-
| config.
|
|
6054
|
+
| Name | Type | Description |
|
|
6055
|
+
| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6056
|
+
| config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
6057
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
6058
|
+
| config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 512.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
|
|
6059
|
+
| 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> |
|
|
6060
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
6061
|
+
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>scopes</strong> is required.</p> <p>To load all objects belonging to the given schema IDs leave the <strong>scopes</strong> parameter empty.</p> |
|
|
6062
|
+
| config.scopes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated scopes, that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scopes. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>schemaIds</strong> is required.</p> <p>To load all objects belonging to the given scopes leave the <strong>schemaIds</strong> parameter empty.</p> |
|
|
6063
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Sorting is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp</code>)</li> </ul> <p>Note that only fields included to the response via <code>fields</code> can be used for sorting.</p> |
|
|
5954
6064
|
|
|
5955
6065
|
#### Returns
|
|
5956
6066
|
|
|
@@ -6698,7 +6808,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
6698
6808
|
|
|
6699
6809
|
#### Returns
|
|
6700
6810
|
|
|
6701
|
-
Success. The set of synthetic related parameters has been updated. Response doesn
|
|
6811
|
+
Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
|
|
6702
6812
|
|
|
6703
6813
|
<details>
|
|
6704
6814
|
<summary>
|
|
@@ -6831,7 +6941,7 @@ Triggers on-demand executions for synthetic monitors
|
|
|
6831
6941
|
|
|
6832
6942
|
#### Returns
|
|
6833
6943
|
|
|
6834
|
-
Success. The monitor
|
|
6944
|
+
Success. The monitor's execution response details
|
|
6835
6945
|
|
|
6836
6946
|
<details>
|
|
6837
6947
|
<summary>
|
|
@@ -7037,7 +7147,6 @@ Credentials set.
|
|
|
7037
7147
|
|
|
7038
7148
|
| Name | Type | Description |
|
|
7039
7149
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7040
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7041
7150
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7042
7151
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7043
7152
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7046,7 +7155,6 @@ Credentials set.
|
|
|
7046
7155
|
| owner<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the credential (user for which used API token was created). |
|
|
7047
7156
|
| ownerAccessOnly<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Flag indicating that this credential is visible only to the owner. |
|
|
7048
7157
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7049
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7050
7158
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7051
7159
|
|
|
7052
7160
|
### AbstractSloAlertDto
|
|
@@ -7690,7 +7798,6 @@ Details of certificate credentials set.
|
|
|
7690
7798
|
|
|
7691
7799
|
| Name | Type | Description |
|
|
7692
7800
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7693
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7694
7801
|
| certificate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Base64 encoded certificate bytes |
|
|
7695
7802
|
| certificateType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Certificate type: PEM, PKCS12 or UNKNOWN |
|
|
7696
7803
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
@@ -7702,7 +7809,6 @@ Details of certificate credentials set.
|
|
|
7702
7809
|
| ownerAccessOnly<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Flag indicating that this credential is visible only to the owner. |
|
|
7703
7810
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Base64 encoded password |
|
|
7704
7811
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7705
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7706
7812
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7707
7813
|
|
|
7708
7814
|
### CredentialsDetailsTokenResponseElement
|
|
@@ -7711,7 +7817,6 @@ Details of the token credentials set.
|
|
|
7711
7817
|
|
|
7712
7818
|
| Name | Type | Description |
|
|
7713
7819
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7714
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7715
7820
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7716
7821
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7717
7822
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7720,7 +7825,6 @@ Details of the token credentials set.
|
|
|
7720
7825
|
| owner<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the credential (user for which used API token was created). |
|
|
7721
7826
|
| ownerAccessOnly<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Flag indicating that this credential is visible only to the owner. |
|
|
7722
7827
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7723
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7724
7828
|
| token | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text token value |
|
|
7725
7829
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7726
7830
|
|
|
@@ -7730,7 +7834,6 @@ Details of username and password credentials set.
|
|
|
7730
7834
|
|
|
7731
7835
|
| Name | Type | Description |
|
|
7732
7836
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7733
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7734
7837
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7735
7838
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7736
7839
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7740,7 +7843,6 @@ Details of username and password credentials set.
|
|
|
7740
7843
|
| ownerAccessOnly<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Flag indicating that this credential is visible only to the owner. |
|
|
7741
7844
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text password value |
|
|
7742
7845
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7743
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7744
7846
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7745
7847
|
| username | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text username value |
|
|
7746
7848
|
|
|
@@ -8826,6 +8928,15 @@ The tag of a monitored entity.
|
|
|
8826
8928
|
| stringRepresentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The string representation of the tag. |
|
|
8827
8929
|
| value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the tag. |
|
|
8828
8930
|
|
|
8931
|
+
### MainEvent
|
|
8932
|
+
|
|
8933
|
+
The main event of a problem, determined by matching root cause entity id or first event.
|
|
8934
|
+
|
|
8935
|
+
| Name | Type | Description |
|
|
8936
|
+
| ----------- | ----------------------------------------------------------------------------- | ----------------------------- |
|
|
8937
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the event. |
|
|
8938
|
+
| title | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the event. |
|
|
8939
|
+
|
|
8829
8940
|
### MaintenanceWindowEvidence
|
|
8830
8941
|
|
|
8831
8942
|
The maintenance window evidence of the problem.
|
|
@@ -9135,10 +9246,12 @@ Monitoring state of the process group instance.
|
|
|
9135
9246
|
|
|
9136
9247
|
A list of entities and their monitoring states.
|
|
9137
9248
|
|
|
9138
|
-
| Name | Type | Description
|
|
9139
|
-
| ---------------- | ----------------------------------------------------------------------------- |
|
|
9140
|
-
| monitoringStates | Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>> | A list of process group instances and their monitoring states.
|
|
9141
|
-
|
|
|
9249
|
+
| Name | Type | Description |
|
|
9250
|
+
| ---------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9251
|
+
| monitoringStates | Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>> | A list of process group instances and their monitoring states. |
|
|
9252
|
+
| 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> |
|
|
9253
|
+
| pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of entries per page. |
|
|
9254
|
+
| totalCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of entities in the response. |
|
|
9142
9255
|
|
|
9143
9256
|
### MonitoringConfigurationDto
|
|
9144
9257
|
|
|
@@ -9331,6 +9444,7 @@ The properties of a problem.
|
|
|
9331
9444
|
| impactLevel<sup>\*required</sup> | ProblemImpactLevel | |
|
|
9332
9445
|
| impactedEntities<sup>\*required</sup> | Array<<a href="#entitystub">EntityStub</a>> | A list of all entities that are impacted by the problem. |
|
|
9333
9446
|
| linkedProblemInfo | <a href="#linkedproblem">LinkedProblem</a> | |
|
|
9447
|
+
| mainEvent | <a href="#mainevent">MainEvent</a> | |
|
|
9334
9448
|
| managementZones<sup>\*required</sup> | Array<<a href="#managementzone">ManagementZone</a>> | A list of all management zones that the problem belongs to. |
|
|
9335
9449
|
| problemFilters<sup>\*required</sup> | Array<<a href="#alertingprofilestub">AlertingProfileStub</a>> | A list of alerting profiles that match the problem. |
|
|
9336
9450
|
| problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the problem. |
|
|
@@ -9598,6 +9712,7 @@ Detailed information of a remediation item for a security problem.
|
|
|
9598
9712
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
9599
9713
|
| remediationProgress | <a href="#remediationprogress">RemediationProgress</a> | |
|
|
9600
9714
|
| resolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | |
|
|
9715
|
+
| trackingLink | <a href="#trackinglink">TrackingLink</a> | |
|
|
9601
9716
|
| vulnerabilityState | RemediationDetailsItemVulnerabilityState | |
|
|
9602
9717
|
| vulnerableComponents | Array<<a href="#remediationitemdetailsvulnerablecomponent">RemediationItemDetailsVulnerableComponent</a>> | <p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
9603
9718
|
|
|
@@ -9615,6 +9730,7 @@ A possible remediation for a security problem.
|
|
|
9615
9730
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
9616
9731
|
| remediationProgress | <a href="#remediationprogress">RemediationProgress</a> | |
|
|
9617
9732
|
| resolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | |
|
|
9733
|
+
| trackingLink | <a href="#trackinglink">TrackingLink</a> | |
|
|
9618
9734
|
| vulnerabilityState | RemediationItemVulnerabilityState | |
|
|
9619
9735
|
| vulnerableComponents | Array<<a href="#vulnerablecomponent">VulnerableComponent</a>> | <p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
9620
9736
|
|
|
@@ -9708,6 +9824,23 @@ Response of un-muting several remediation items.
|
|
|
9708
9824
|
| ---------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
9709
9825
|
| summary<sup>\*required</sup> | Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>> | The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
9710
9826
|
|
|
9827
|
+
### RemediationItemsBulkUpdateDeleteDto
|
|
9828
|
+
|
|
9829
|
+
Contains the external tracking link associations to be applied to the remediation items of the security problem.
|
|
9830
|
+
|
|
9831
|
+
| Name | Type | Description |
|
|
9832
|
+
| ------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9833
|
+
| deletes | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>Tracking links to remove from the security problem.</p> <p>List of remediation item IDs of the security problem for which to remove the tracking links.</p> |
|
|
9834
|
+
| updates | <a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a> | |
|
|
9835
|
+
|
|
9836
|
+
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
9837
|
+
|
|
9838
|
+
Tracking links to set for the security problem.
|
|
9839
|
+
|
|
9840
|
+
Map of remediation item ID to tracking link objects.
|
|
9841
|
+
|
|
9842
|
+
Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.
|
|
9843
|
+
|
|
9711
9844
|
### RemediationProgress
|
|
9712
9845
|
|
|
9713
9846
|
The progress of this remediation item. It contains affected and unaffected entities.
|
|
@@ -10596,6 +10729,26 @@ A credentials set of the `TOKEN` type.
|
|
|
10596
10729
|
| token | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token in the string format. |
|
|
10597
10730
|
| type | CredentialsType | |
|
|
10598
10731
|
|
|
10732
|
+
### TrackingLink
|
|
10733
|
+
|
|
10734
|
+
External tracking link URL associated with the remediable entity of the security problem.
|
|
10735
|
+
|
|
10736
|
+
| Name | Type | Description |
|
|
10737
|
+
| -------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
10738
|
+
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Display name (title) set for the tracking link, e.g. 'ISSUE-123'. |
|
|
10739
|
+
| lastUpdatedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp (UTC milliseconds) of the last update of the tracking link. |
|
|
10740
|
+
| url | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | URL set for the tracking link, e.g. https://example.com/ISSUE-123 |
|
|
10741
|
+
| user | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user who last changed the tracking link. |
|
|
10742
|
+
|
|
10743
|
+
### TrackingLinkUpdate
|
|
10744
|
+
|
|
10745
|
+
External tracking link URL association to be set for the remediable entity of the security problem.
|
|
10746
|
+
|
|
10747
|
+
| Name | Type | Description |
|
|
10748
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10749
|
+
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The desired tracking link display name (title) set for the remediation item, e.g. 'ISSUE-123'. |
|
|
10750
|
+
| url<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The desired tracking link url set for the remediation item, e.g. https://example.com/ISSUE-123</p> <p>Note that only valid URLs with 'http' or 'https' protocols are supported.</p> |
|
|
10751
|
+
|
|
10599
10752
|
### TransactionalEvidence
|
|
10600
10753
|
|
|
10601
10754
|
The transactional evidence of the problem.
|
|
@@ -10914,22 +11067,6 @@ The scope of the credentials set.
|
|
|
10914
11067
|
|
|
10915
11068
|
</div>
|
|
10916
11069
|
|
|
10917
|
-
### AbstractCredentialsResponseElementScopesItem
|
|
10918
|
-
|
|
10919
|
-
<div class="padding-left--md">
|
|
10920
|
-
|
|
10921
|
-
The set of scopes of the credentials set.
|
|
10922
|
-
|
|
10923
|
-
#### Enum keys
|
|
10924
|
-
|
|
10925
|
-
<div class="padding-left--md">
|
|
10926
|
-
|
|
10927
|
-
`All` | `Extension` | `Synthetic` | `Unknown`
|
|
10928
|
-
|
|
10929
|
-
</div>
|
|
10930
|
-
|
|
10931
|
-
</div>
|
|
10932
|
-
|
|
10933
11070
|
### AbstractCredentialsResponseElementType
|
|
10934
11071
|
|
|
10935
11072
|
<div class="padding-left--md">
|
|
@@ -11066,7 +11203,7 @@ The OS architecture that the ActiveGate is running on.
|
|
|
11066
11203
|
|
|
11067
11204
|
<div class="padding-left--md">
|
|
11068
11205
|
|
|
11069
|
-
`
|
|
11206
|
+
`S390` | `X86`
|
|
11070
11207
|
|
|
11071
11208
|
</div>
|
|
11072
11209
|
|
|
@@ -12427,7 +12564,7 @@ The name of the monitoring state.
|
|
|
12427
12564
|
|
|
12428
12565
|
<div class="padding-left--md">
|
|
12429
12566
|
|
|
12430
|
-
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
12567
|
+
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
12431
12568
|
|
|
12432
12569
|
</div>
|
|
12433
12570
|
|