@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/package.json
CHANGED
|
@@ -12,7 +12,7 @@ export declare class BusinessEventsClient {
|
|
|
12
12
|
/**
|
|
13
13
|
* Ingests a business event
|
|
14
14
|
*
|
|
15
|
-
* **Required scope:** storage:events:write<br/>**Required permission:** storage:events:write<br/><br/>The ingestion of business events
|
|
15
|
+
* **Required scope:** storage:events:write<br/>**Required permission:** storage:events:write<br/><br/>The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
16
16
|
*
|
|
17
17
|
* @returns The provided business events are all accepted and will be processed.
|
|
18
18
|
*
|
|
@@ -6,7 +6,7 @@ import { CredentialsList } from '../models/credentials-list';
|
|
|
6
6
|
import { CredentialsResponseElement } from '../models/credentials-response-element';
|
|
7
7
|
import { ListCredentialsQueryType } from '../models/list-credentials-query-type';
|
|
8
8
|
/**
|
|
9
|
-
* Manage credentials
|
|
9
|
+
* Manage credentials
|
|
10
10
|
*/
|
|
11
11
|
export declare class CredentialVaultClient {
|
|
12
12
|
private httpClient;
|
|
@@ -17,7 +17,7 @@ export declare class CredentialVaultClient {
|
|
|
17
17
|
*/
|
|
18
18
|
constructor(httpClientImplementation: HttpClient);
|
|
19
19
|
/**
|
|
20
|
-
* Lists all sets of credentials
|
|
20
|
+
* Lists all sets of credentials in your environment.
|
|
21
21
|
*
|
|
22
22
|
* **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
|
|
23
23
|
*
|
|
@@ -241,7 +241,7 @@ export declare class EventsClient {
|
|
|
241
241
|
* + environment:roles:viewer
|
|
242
242
|
* + storage:events:write
|
|
243
243
|
*
|
|
244
|
-
* <br/><br/>The ingestion of custom events
|
|
244
|
+
* <br/><br/>The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
245
245
|
*
|
|
246
246
|
* @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
|
|
247
247
|
*
|
|
@@ -32,7 +32,9 @@ export declare class Extensions_2_0Client {
|
|
|
32
32
|
/**
|
|
33
33
|
* Lists all the extensions 2.0 available in your environment
|
|
34
34
|
*
|
|
35
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
35
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
36
|
+
* + environment:roles:manage-settings
|
|
37
|
+
* + extensions:definitions:read
|
|
36
38
|
*
|
|
37
39
|
* @returns Success
|
|
38
40
|
*
|
|
@@ -62,7 +64,9 @@ export declare class Extensions_2_0Client {
|
|
|
62
64
|
/**
|
|
63
65
|
* Uploads or verifies a new extension 2.0
|
|
64
66
|
*
|
|
65
|
-
* **Required scope:** environment-api:extensions:write<br/>**
|
|
67
|
+
* **Required scope:** environment-api:extensions:write<br/>**One of the following permissions is required:**
|
|
68
|
+
* + environment:roles:manage-settings
|
|
69
|
+
* + extensions:definitions:write
|
|
66
70
|
*
|
|
67
71
|
* @returns The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
68
72
|
*
|
|
@@ -83,7 +87,9 @@ export declare class Extensions_2_0Client {
|
|
|
83
87
|
/**
|
|
84
88
|
* Lists all the extension 2.0 schemas versions available in your environment
|
|
85
89
|
*
|
|
86
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
90
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
91
|
+
* + environment:roles:manage-settings
|
|
92
|
+
* + extensions:definitions:read
|
|
87
93
|
*
|
|
88
94
|
* @returns Success
|
|
89
95
|
*
|
|
@@ -96,7 +102,9 @@ export declare class Extensions_2_0Client {
|
|
|
96
102
|
/**
|
|
97
103
|
* Lists all the files available for the specified extension 2.0 schema version
|
|
98
104
|
*
|
|
99
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
105
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
106
|
+
* + environment:roles:manage-settings
|
|
107
|
+
* + extensions:definitions:read
|
|
100
108
|
*
|
|
101
109
|
* @returns Success
|
|
102
110
|
*
|
|
@@ -116,7 +124,9 @@ export declare class Extensions_2_0Client {
|
|
|
116
124
|
/**
|
|
117
125
|
* Gets the extension 2.0 schema file in the specified version
|
|
118
126
|
*
|
|
119
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
127
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
128
|
+
* + environment:roles:manage-settings
|
|
129
|
+
* + extensions:definitions:read
|
|
120
130
|
*
|
|
121
131
|
* @returns Success
|
|
122
132
|
*
|
|
@@ -136,7 +146,9 @@ export declare class Extensions_2_0Client {
|
|
|
136
146
|
/**
|
|
137
147
|
* Lists all versions of the extension 2.0
|
|
138
148
|
*
|
|
139
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
149
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
150
|
+
* + environment:roles:manage-settings
|
|
151
|
+
* + extensions:definitions:read
|
|
140
152
|
*
|
|
141
153
|
* @returns Success
|
|
142
154
|
*
|
|
@@ -169,7 +181,9 @@ export declare class Extensions_2_0Client {
|
|
|
169
181
|
/**
|
|
170
182
|
* Gets the active environment configuration version of the specified extension 2.0
|
|
171
183
|
*
|
|
172
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
184
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
185
|
+
* + environment:roles:manage-settings
|
|
186
|
+
* + extensions:definitions:read
|
|
173
187
|
*
|
|
174
188
|
* @returns Success
|
|
175
189
|
*
|
|
@@ -188,7 +202,9 @@ export declare class Extensions_2_0Client {
|
|
|
188
202
|
/**
|
|
189
203
|
* Updates the active environment configuration version of the extension 2.0
|
|
190
204
|
*
|
|
191
|
-
* **Required scope:** environment-api:extensions:write<br/>**
|
|
205
|
+
* **Required scope:** environment-api:extensions:write<br/>**One of the following permissions is required:**
|
|
206
|
+
* + environment:roles:manage-settings
|
|
207
|
+
* + extensions:definitions:write
|
|
192
208
|
*
|
|
193
209
|
* @returns Success. Environment configuration updated.
|
|
194
210
|
*
|
|
@@ -208,7 +224,9 @@ export declare class Extensions_2_0Client {
|
|
|
208
224
|
/**
|
|
209
225
|
* Activates the environment configuration from the specified version of the extension 2.0
|
|
210
226
|
*
|
|
211
|
-
* **Required scope:** environment-api:extensions:write<br/>**
|
|
227
|
+
* **Required scope:** environment-api:extensions:write<br/>**One of the following permissions is required:**
|
|
228
|
+
* + environment:roles:manage-settings
|
|
229
|
+
* + extensions:definitions:write
|
|
212
230
|
*
|
|
213
231
|
* @returns Success. Environment configuration created.
|
|
214
232
|
*
|
|
@@ -228,7 +246,9 @@ export declare class Extensions_2_0Client {
|
|
|
228
246
|
/**
|
|
229
247
|
* Deactivates the environment configuration of the specified extension 2.0
|
|
230
248
|
*
|
|
231
|
-
* **Required scope:** environment-api:extensions:write<br/>**
|
|
249
|
+
* **Required scope:** environment-api:extensions:write<br/>**One of the following permissions is required:**
|
|
250
|
+
* + environment:roles:manage-settings
|
|
251
|
+
* + extensions:definitions:write
|
|
232
252
|
*
|
|
233
253
|
* @returns Success. Environment configuration deactivated.
|
|
234
254
|
*
|
|
@@ -247,7 +267,9 @@ export declare class Extensions_2_0Client {
|
|
|
247
267
|
/**
|
|
248
268
|
* Gets the information about assets in an active extension 2.0
|
|
249
269
|
*
|
|
250
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
270
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
271
|
+
* + environment:roles:manage-settings
|
|
272
|
+
* + extensions:definitions:read
|
|
251
273
|
*
|
|
252
274
|
* @returns Success
|
|
253
275
|
*
|
|
@@ -266,7 +288,11 @@ export declare class Extensions_2_0Client {
|
|
|
266
288
|
/**
|
|
267
289
|
* List of the latest extension environment configuration events
|
|
268
290
|
*
|
|
269
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
291
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
292
|
+
* + environment:roles:manage-settings
|
|
293
|
+
* + extensions:definitions:read
|
|
294
|
+
*
|
|
295
|
+
*
|
|
270
296
|
*
|
|
271
297
|
* @deprecated
|
|
272
298
|
*
|
|
@@ -325,7 +351,9 @@ export declare class Extensions_2_0Client {
|
|
|
325
351
|
/**
|
|
326
352
|
* Lists all the monitoring configurations of the specified extension 2.0
|
|
327
353
|
*
|
|
328
|
-
* **Required scope:** environment-api:extension-configurations:read<br/>**
|
|
354
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**One of the following permissions is required:**
|
|
355
|
+
* + environment:roles:manage-settings
|
|
356
|
+
* + extensions:configurations:read
|
|
329
357
|
*
|
|
330
358
|
* @returns Success
|
|
331
359
|
*
|
|
@@ -360,7 +388,9 @@ export declare class Extensions_2_0Client {
|
|
|
360
388
|
/**
|
|
361
389
|
* Creates new monitoring configuration for the specified extension 2.0
|
|
362
390
|
*
|
|
363
|
-
* **Required scope:** environment-api:extension-configurations:write<br/>**
|
|
391
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**One of the following permissions is required:**
|
|
392
|
+
* + environment:roles:manage-settings
|
|
393
|
+
* + extensions:configurations:write
|
|
364
394
|
*
|
|
365
395
|
* @returns Success | Multi-Status, if not all requests resulted in the same status
|
|
366
396
|
*
|
|
@@ -386,7 +416,9 @@ export declare class Extensions_2_0Client {
|
|
|
386
416
|
/**
|
|
387
417
|
* Gets the details of the specified monitoring configuration
|
|
388
418
|
*
|
|
389
|
-
* **Required scope:** environment-api:extension-configurations:read<br/>**
|
|
419
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**One of the following permissions is required:**
|
|
420
|
+
* + environment:roles:manage-settings
|
|
421
|
+
* + extensions:configurations:read
|
|
390
422
|
*
|
|
391
423
|
* @returns Success
|
|
392
424
|
*
|
|
@@ -406,7 +438,9 @@ export declare class Extensions_2_0Client {
|
|
|
406
438
|
/**
|
|
407
439
|
* Updates the specified monitoring configuration
|
|
408
440
|
*
|
|
409
|
-
* **Required scope:** environment-api:extension-configurations:write<br/>**
|
|
441
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**One of the following permissions is required:**
|
|
442
|
+
* + environment:roles:manage-settings
|
|
443
|
+
* + extensions:configurations:write
|
|
410
444
|
*
|
|
411
445
|
* @returns Success
|
|
412
446
|
*
|
|
@@ -429,7 +463,9 @@ export declare class Extensions_2_0Client {
|
|
|
429
463
|
/**
|
|
430
464
|
* Deletes the specified monitoring configuration
|
|
431
465
|
*
|
|
432
|
-
* **Required scope:** environment-api:extension-configurations:write<br/>**
|
|
466
|
+
* **Required scope:** environment-api:extension-configurations:write<br/>**One of the following permissions is required:**
|
|
467
|
+
* + environment:roles:manage-settings
|
|
468
|
+
* + extensions:configurations:write
|
|
433
469
|
*
|
|
434
470
|
* @example <caption>Code example</caption>
|
|
435
471
|
* import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
@@ -448,7 +484,11 @@ export declare class Extensions_2_0Client {
|
|
|
448
484
|
/**
|
|
449
485
|
* Gets the list of the events linked to specific monitoring configuration
|
|
450
486
|
*
|
|
451
|
-
* **Required scope:** environment-api:extension-configurations:read<br/>**
|
|
487
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**One of the following permissions is required:**
|
|
488
|
+
* + environment:roles:manage-settings
|
|
489
|
+
* + extensions:configurations:read
|
|
490
|
+
*
|
|
491
|
+
*
|
|
452
492
|
*
|
|
453
493
|
* @deprecated
|
|
454
494
|
*
|
|
@@ -523,7 +563,9 @@ export declare class Extensions_2_0Client {
|
|
|
523
563
|
/**
|
|
524
564
|
* Gets the most recent status of the execution of given monitoring configuration
|
|
525
565
|
*
|
|
526
|
-
* **Required scope:** environment-api:extension-configurations:read<br/>**
|
|
566
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**One of the following permissions is required:**
|
|
567
|
+
* + environment:roles:manage-settings
|
|
568
|
+
* + extensions:configurations:read
|
|
527
569
|
*
|
|
528
570
|
* @returns Success
|
|
529
571
|
*
|
|
@@ -543,7 +585,9 @@ export declare class Extensions_2_0Client {
|
|
|
543
585
|
/**
|
|
544
586
|
* Gets details of the specified version of the extension 2.0
|
|
545
587
|
*
|
|
546
|
-
* **Required scope:** environment-api:extensions:read<br/>**
|
|
588
|
+
* **Required scope:** environment-api:extensions:read<br/>**One of the following permissions is required:**
|
|
589
|
+
* + environment:roles:manage-settings
|
|
590
|
+
* + extensions:definitions:read
|
|
547
591
|
*
|
|
548
592
|
* @returns Success
|
|
549
593
|
*
|
|
@@ -565,7 +609,9 @@ export declare class Extensions_2_0Client {
|
|
|
565
609
|
/**
|
|
566
610
|
* Deletes the specified version of the extension 2.0
|
|
567
611
|
*
|
|
568
|
-
* **Required scope:** environment-api:extensions:write<br/>**
|
|
612
|
+
* **Required scope:** environment-api:extensions:write<br/>**One of the following permissions is required:**
|
|
613
|
+
* + environment:roles:manage-settings
|
|
614
|
+
* + extensions:definitions:write
|
|
569
615
|
*
|
|
570
616
|
* @returns Success. The extension 2.0 version has been deleted.
|
|
571
617
|
*
|
|
@@ -585,7 +631,9 @@ export declare class Extensions_2_0Client {
|
|
|
585
631
|
/**
|
|
586
632
|
* Gets the configuration schema of the specified version of the extension 2.0
|
|
587
633
|
*
|
|
588
|
-
* **Required scope:** environment-api:extension-configurations:read<br/>**
|
|
634
|
+
* **Required scope:** environment-api:extension-configurations:read<br/>**One of the following permissions is required:**
|
|
635
|
+
* + environment:roles:manage-settings
|
|
636
|
+
* + extensions:definitions:read
|
|
589
637
|
*
|
|
590
638
|
* @returns Success
|
|
591
639
|
*
|
|
@@ -23,7 +23,7 @@ export declare class LogsClient {
|
|
|
23
23
|
*
|
|
24
24
|
* 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.
|
|
25
25
|
*
|
|
26
|
-
* If *Log Management and Analytics, powered by Grail* is enabled, then
|
|
26
|
+
* 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.
|
|
27
27
|
*
|
|
28
28
|
* @returns Success
|
|
29
29
|
*
|
|
@@ -271,7 +271,7 @@ export declare class LogsClient {
|
|
|
271
271
|
*
|
|
272
272
|
* Results can be distributed unevenly between slices and some slices might be empty.
|
|
273
273
|
*
|
|
274
|
-
* If *Log Management and Analytics, powered by Grail* is enabled, then
|
|
274
|
+
* 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.
|
|
275
275
|
*
|
|
276
276
|
* @returns Success
|
|
277
277
|
*
|
|
@@ -22,11 +22,23 @@ export declare class MonitoredEntitiesMonitoringStateClient {
|
|
|
22
22
|
* import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
23
23
|
*
|
|
24
24
|
* const data =
|
|
25
|
-
* await monitoredEntitiesMonitoringStateClient.getStates(
|
|
26
|
-
* entitySelector: "...",
|
|
27
|
-
* });
|
|
25
|
+
* await monitoredEntitiesMonitoringStateClient.getStates();
|
|
28
26
|
*/
|
|
29
|
-
getStates(config
|
|
27
|
+
getStates(config?: {
|
|
28
|
+
/**
|
|
29
|
+
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
30
|
+
*
|
|
31
|
+
* The first page is always returned if you don't specify the **nextPageKey** query parameter.
|
|
32
|
+
*
|
|
33
|
+
* When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
|
|
34
|
+
*/ nextPageKey?: string;
|
|
35
|
+
/**
|
|
36
|
+
* The amount of monitoring states in a single response payload.
|
|
37
|
+
*
|
|
38
|
+
* The maximal allowed page size is 500.
|
|
39
|
+
*
|
|
40
|
+
* If not set, 500 is used.
|
|
41
|
+
*/ pageSize?: number;
|
|
30
42
|
/**
|
|
31
43
|
* Specifies the process group instances where you're querying the state. Use the `PROCESS_GROUP_INSTANCE` entity type.
|
|
32
44
|
*
|
|
@@ -61,7 +73,7 @@ export declare class MonitoredEntitiesMonitoringStateClient {
|
|
|
61
73
|
* To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in the response.
|
|
62
74
|
*
|
|
63
75
|
* The maximum string length is 2,000 characters.
|
|
64
|
-
*/ entitySelector
|
|
76
|
+
*/ entitySelector?: string;
|
|
65
77
|
abortSignal?: AbortSignal;
|
|
66
78
|
}): Promise<MonitoredStates>;
|
|
67
79
|
}
|
package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ import { RemediationItemsBulkMute } from '../models/remediation-items-bulk-mute'
|
|
|
6
6
|
import { RemediationItemsBulkMuteResponse } from '../models/remediation-items-bulk-mute-response';
|
|
7
7
|
import { RemediationItemsBulkUnmute } from '../models/remediation-items-bulk-unmute';
|
|
8
8
|
import { RemediationItemsBulkUnmuteResponse } from '../models/remediation-items-bulk-unmute-response';
|
|
9
|
+
import { RemediationItemsBulkUpdateDeleteDto } from '../models/remediation-items-bulk-update-delete-dto';
|
|
9
10
|
import { RemediationProgressEntityList } from '../models/remediation-progress-entity-list';
|
|
10
11
|
import { SecurityProblemDetails } from '../models/security-problem-details';
|
|
11
12
|
import { SecurityProblemEventsList } from '../models/security-problem-events-list';
|
|
@@ -123,9 +124,11 @@ export declare class SecurityProblemsClient {
|
|
|
123
124
|
* * `securityProblemId`: The auto-generated ID of the security problem (`+` lower number first or `-` higher number first)
|
|
124
125
|
* * `externalVulnerabilityId`: The ID of the external vulnerability (`+` lower number first or `-` higher number first)
|
|
125
126
|
* * `displayId`: The display ID (`+` lower number first or `-` higher number first)
|
|
126
|
-
* * `riskAssessment.riskScore`:
|
|
127
|
-
* * `riskAssessment.riskLevel`:
|
|
127
|
+
* * `riskAssessment.riskScore`: Davis Security Score (`+` lower score first or `-` higher score first)
|
|
128
|
+
* * `riskAssessment.riskLevel`: Davis Security Score level (`+` lower level first or `-` higher level first)
|
|
128
129
|
* * `riskAssessment.exposure`: Whether the problem is exposed to the internet
|
|
130
|
+
* * `riskAssessment.baseRiskScore`: The CVSS score (`+` lower score first or `-` higher score first)
|
|
131
|
+
* * `riskAssessment.baseRiskLevel`: The CVSS level (`+` lower level first or `-` higher level first)
|
|
129
132
|
* * `riskAssessment.dataAssets`: Whether data assets are affected
|
|
130
133
|
* * `riskAssessment.vulnerableFunctionUsage`: Whether vulnerable functions are used
|
|
131
134
|
* * `riskAssessment.assessmentAccuracy`: The assessments accuracy (`+` less accuracy first or `-` more accuracy first)
|
|
@@ -252,7 +255,7 @@ export declare class SecurityProblemsClient {
|
|
|
252
255
|
* });
|
|
253
256
|
*/
|
|
254
257
|
getSecurityProblem(config: {
|
|
255
|
-
/** The ID of the
|
|
258
|
+
/** The ID of the requested security problem. */ id: string;
|
|
256
259
|
/**
|
|
257
260
|
* A list of additional security problem properties you can add to the response.
|
|
258
261
|
*
|
|
@@ -315,7 +318,7 @@ export declare class SecurityProblemsClient {
|
|
|
315
318
|
* });
|
|
316
319
|
*/
|
|
317
320
|
getEventsForSecurityProblem(config: {
|
|
318
|
-
/** The ID of the
|
|
321
|
+
/** The ID of the requested security problem. */ id: string;
|
|
319
322
|
/**
|
|
320
323
|
* The start of the requested timeframe.
|
|
321
324
|
*
|
|
@@ -370,7 +373,7 @@ export declare class SecurityProblemsClient {
|
|
|
370
373
|
*/
|
|
371
374
|
muteSecurityProblem(config: {
|
|
372
375
|
body: SecurityProblemMute;
|
|
373
|
-
/** The ID of the
|
|
376
|
+
/** The ID of the requested security problem. */ id: string;
|
|
374
377
|
abortSignal?: AbortSignal;
|
|
375
378
|
}): Promise<void>;
|
|
376
379
|
/**
|
|
@@ -391,7 +394,7 @@ export declare class SecurityProblemsClient {
|
|
|
391
394
|
* });
|
|
392
395
|
*/
|
|
393
396
|
getRemediationItems(config: {
|
|
394
|
-
/** The ID of the
|
|
397
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
395
398
|
/**
|
|
396
399
|
* Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.
|
|
397
400
|
*
|
|
@@ -405,6 +408,7 @@ export declare class SecurityProblemsClient {
|
|
|
405
408
|
* * Vulnerable function in use contains: `assessment.vulnerableFunctionInUseContains("value")`. Possible values are `class::function`, `class::` and `function`. The `CONTAINS` operator is used. Only vulnerable functions in use are considered.
|
|
406
409
|
* * Assessment accuracy: `assessment.accuracy("value")` Possible values are `FULL` and `REDUCED`.
|
|
407
410
|
* * Entity name contains: `entityNameContains("value-1")`. The `CONTAINS` operator is used.
|
|
411
|
+
* * Tracking link display name: `trackingLink.displayNameContains("value")`. The `CONTAINS` operator is used.
|
|
408
412
|
*
|
|
409
413
|
* To set several criteria, separate them with a comma (`,`). Only results matching **all** criteria are included in the response.
|
|
410
414
|
*
|
|
@@ -432,9 +436,27 @@ export declare class SecurityProblemsClient {
|
|
|
432
436
|
*/
|
|
433
437
|
bulkMuteRemediationItems(config: {
|
|
434
438
|
body: RemediationItemsBulkMute;
|
|
435
|
-
/** The ID of the
|
|
439
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
436
440
|
abortSignal?: AbortSignal;
|
|
437
441
|
}): Promise<RemediationItemsBulkMuteResponse>;
|
|
442
|
+
/**
|
|
443
|
+
* Updates the external tracking links of the remediation items. | maturity=EARLY_ADOPTER
|
|
444
|
+
*
|
|
445
|
+
* **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
|
|
446
|
+
*
|
|
447
|
+
* @example <caption>Code example</caption>
|
|
448
|
+
* import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
449
|
+
*
|
|
450
|
+
* const data =
|
|
451
|
+
* await securityProblemsClient.trackingLinkBulkUpdateAndDelete(
|
|
452
|
+
* { id: "...", body: {} },
|
|
453
|
+
* );
|
|
454
|
+
*/
|
|
455
|
+
trackingLinkBulkUpdateAndDelete(config: {
|
|
456
|
+
body: RemediationItemsBulkUpdateDeleteDto;
|
|
457
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
458
|
+
abortSignal?: AbortSignal;
|
|
459
|
+
}): Promise<void>;
|
|
438
460
|
/**
|
|
439
461
|
* Un-mutes several remediation items
|
|
440
462
|
*
|
|
@@ -453,7 +475,7 @@ export declare class SecurityProblemsClient {
|
|
|
453
475
|
*/
|
|
454
476
|
bulkUnmuteRemediationItems(config: {
|
|
455
477
|
body: RemediationItemsBulkUnmute;
|
|
456
|
-
/** The ID of the
|
|
478
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
457
479
|
abortSignal?: AbortSignal;
|
|
458
480
|
}): Promise<RemediationItemsBulkUnmuteResponse>;
|
|
459
481
|
/**
|
|
@@ -475,7 +497,7 @@ export declare class SecurityProblemsClient {
|
|
|
475
497
|
* });
|
|
476
498
|
*/
|
|
477
499
|
getRemediationItem(config: {
|
|
478
|
-
/** The ID of the
|
|
500
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
479
501
|
/** The ID of the remediation item. */ remediationItemId: string;
|
|
480
502
|
abortSignal?: AbortSignal;
|
|
481
503
|
}): Promise<RemediationDetailsItem>;
|
|
@@ -496,7 +518,7 @@ export declare class SecurityProblemsClient {
|
|
|
496
518
|
*/
|
|
497
519
|
setRemediationItemMuteState(config: {
|
|
498
520
|
body: RemediationItemMuteStateChange;
|
|
499
|
-
/** The ID of the
|
|
521
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
500
522
|
/** The ID of the remediation item. */ remediationItemId: string;
|
|
501
523
|
abortSignal?: AbortSignal;
|
|
502
524
|
}): Promise<void>;
|
|
@@ -518,7 +540,7 @@ export declare class SecurityProblemsClient {
|
|
|
518
540
|
* );
|
|
519
541
|
*/
|
|
520
542
|
getRemediationProgressEntities(config: {
|
|
521
|
-
/** The ID of the
|
|
543
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
522
544
|
/** The ID of the remediation item. */ remediationItemId: string;
|
|
523
545
|
/**
|
|
524
546
|
* Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.
|
|
@@ -554,7 +576,7 @@ export declare class SecurityProblemsClient {
|
|
|
554
576
|
*/
|
|
555
577
|
unmuteSecurityProblem(config: {
|
|
556
578
|
body: SecurityProblemUnmute;
|
|
557
|
-
/** The ID of the
|
|
579
|
+
/** The ID of the requested security problem. */ id: string;
|
|
558
580
|
abortSignal?: AbortSignal;
|
|
559
581
|
}): Promise<void>;
|
|
560
582
|
/**
|
|
@@ -575,7 +597,7 @@ export declare class SecurityProblemsClient {
|
|
|
575
597
|
* });
|
|
576
598
|
*/
|
|
577
599
|
getVulnerableFunctions(config: {
|
|
578
|
-
/** The ID of the
|
|
600
|
+
/** The ID of the requested third-party security problem. */ id: string;
|
|
579
601
|
/**
|
|
580
602
|
* Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.
|
|
581
603
|
*
|
package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts
CHANGED
|
@@ -99,8 +99,8 @@ export declare class ServiceLevelObjectivesClient {
|
|
|
99
99
|
* * Health state: `healthState("HEALTHY")` or `healthState("UNHEALTHY")`. Filters for SLOs that have no related open problems (`HEALTHY`) or SLOs that have related open problems (`UNHEALTHY`). You can specify only one health state.
|
|
100
100
|
* * Text: `text("value")`. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.
|
|
101
101
|
* * Problem: `problemDisplayName("value")`. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).
|
|
102
|
-
* * Management zone name: `managementZone("MZ-A")`. Filters for all SLOs that are related to the given management zone name.
|
|
103
|
-
* * Management zone ID: `managementZoneID("123")`. Filters for all SLOs that are related to the given management zone ID.
|
|
102
|
+
* * Management zone name: `managementZone("MZ-A")`. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.
|
|
103
|
+
* * Management zone ID: `managementZoneID("123")`. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.
|
|
104
104
|
*
|
|
105
105
|
* To set several criteria, separate them with comma (`,`). Only SLOs matching all criteria are included in the response. Examples:
|
|
106
106
|
* * .../api/v2/slo?sloSelector=name("Service Availability")
|
|
@@ -125,6 +125,34 @@ export declare class SettingsObjectsClient {
|
|
|
125
125
|
*
|
|
126
126
|
* Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo`, `schemaId`, `schemaVersion`, `value`, `externalId`.
|
|
127
127
|
*/ fields?: string;
|
|
128
|
+
/**
|
|
129
|
+
* The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering).
|
|
130
|
+
*
|
|
131
|
+
* Filtering is supported on the following fields:
|
|
132
|
+
* * `created`
|
|
133
|
+
* * `modified`
|
|
134
|
+
* * `createdBy`
|
|
135
|
+
* * `modifiedBy`
|
|
136
|
+
* * `author`
|
|
137
|
+
* * `value` with properties and sub-properties separated by dot (for example, `value.owningApp = 'Notebooks'`)
|
|
138
|
+
*
|
|
139
|
+
* 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.
|
|
140
|
+
*
|
|
141
|
+
* Note that only fields included to the response via `fields` can be used for filtering.
|
|
142
|
+
*/ filter?: string;
|
|
143
|
+
/**
|
|
144
|
+
* The sort parameter, as explained [here](https://dt-url.net/platform-services-filtering).
|
|
145
|
+
*
|
|
146
|
+
* Sorting is supported on the following fields:
|
|
147
|
+
* * `created`
|
|
148
|
+
* * `modified`
|
|
149
|
+
* * `createdBy`
|
|
150
|
+
* * `modifiedBy`
|
|
151
|
+
* * `author`
|
|
152
|
+
* * `value` with properties and sub-properties separated by dot (for example, `value.owningApp`)
|
|
153
|
+
*
|
|
154
|
+
* Note that only fields included to the response via `fields` can be used for sorting.
|
|
155
|
+
*/ sort?: string;
|
|
128
156
|
/**
|
|
129
157
|
* The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
|
|
130
158
|
*
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
import { AbstractCredentialsResponseElementScope } from './abstract-credentials-response-element-scope';
|
|
2
|
-
import { AbstractCredentialsResponseElementScopesItem } from './abstract-credentials-response-element-scopes-item';
|
|
3
2
|
import { AbstractCredentialsResponseElementType } from './abstract-credentials-response-element-type';
|
|
4
|
-
import { CredentialAccessData } from './credential-access-data';
|
|
5
3
|
import { CredentialUsageHandler } from './credential-usage-handler';
|
|
6
4
|
import { ExternalVaultConfig } from './external-vault-config';
|
|
7
5
|
/**
|
|
@@ -9,26 +7,17 @@ import { ExternalVaultConfig } from './external-vault-config';
|
|
|
9
7
|
*/
|
|
10
8
|
export interface AbstractCredentialsResponseElement {
|
|
11
9
|
/**
|
|
12
|
-
* The
|
|
13
|
-
*/
|
|
14
|
-
allowedEntities?: CredentialAccessData[];
|
|
15
|
-
/**
|
|
16
|
-
* The list contains summary data related to the use of credentials.
|
|
17
|
-
*/
|
|
18
|
-
credentialUsageSummary: CredentialUsageHandler[];
|
|
19
|
-
/**
|
|
20
|
-
* A short description of the credentials set.
|
|
10
|
+
* The name of the credentials set.
|
|
21
11
|
*/
|
|
22
|
-
|
|
23
|
-
externalVault?: ExternalVaultConfig;
|
|
12
|
+
name: string;
|
|
24
13
|
/**
|
|
25
14
|
* The ID of the credentials set.
|
|
26
15
|
*/
|
|
27
16
|
id?: string;
|
|
28
17
|
/**
|
|
29
|
-
*
|
|
18
|
+
* A short description of the credentials set.
|
|
30
19
|
*/
|
|
31
|
-
|
|
20
|
+
description: string;
|
|
32
21
|
/**
|
|
33
22
|
* The owner of the credential (user for which used API token was created).
|
|
34
23
|
*/
|
|
@@ -38,9 +27,10 @@ export interface AbstractCredentialsResponseElement {
|
|
|
38
27
|
*/
|
|
39
28
|
ownerAccessOnly: boolean;
|
|
40
29
|
scope?: AbstractCredentialsResponseElementScope;
|
|
30
|
+
externalVault?: ExternalVaultConfig;
|
|
41
31
|
/**
|
|
42
|
-
* The
|
|
32
|
+
* The list contains summary data related to the use of credentials.
|
|
43
33
|
*/
|
|
44
|
-
|
|
34
|
+
credentialUsageSummary: CredentialUsageHandler[];
|
|
45
35
|
type: AbstractCredentialsResponseElementType;
|
|
46
36
|
}
|
|
@@ -1,27 +1,23 @@
|
|
|
1
1
|
import { AbstractCredentialsResponseElement } from './abstract-credentials-response-element';
|
|
2
2
|
import * as _AbstractCredentialsResponseElementScopeTransformation from './abstract-credentials-response-element-scope.transformation';
|
|
3
|
-
import * as _AbstractCredentialsResponseElementScopesItemTransformation from './abstract-credentials-response-element-scopes-item.transformation';
|
|
4
3
|
import * as _AbstractCredentialsResponseElementTypeTransformation from './abstract-credentials-response-element-type.transformation';
|
|
5
|
-
import * as _CredentialAccessDataTransformation from './credential-access-data.transformation';
|
|
6
4
|
import * as _CredentialUsageHandlerTransformation from './credential-usage-handler.transformation';
|
|
7
5
|
import { CredentialsDetailsCertificateResponseElement } from './credentials-details-certificate-response-element';
|
|
8
6
|
import { CredentialsDetailsTokenResponseElement } from './credentials-details-token-response-element';
|
|
9
7
|
import { CredentialsDetailsUsernamePasswordResponseElement } from './credentials-details-username-password-response-element';
|
|
10
8
|
import * as _ExternalVaultConfigTransformation from './external-vault-config.transformation';
|
|
9
|
+
export declare function isCredentialsDetailsUsernamePasswordResponseElement($model: AbstractCredentialsResponseElement): $model is CredentialsDetailsUsernamePasswordResponseElement;
|
|
11
10
|
export declare function isCredentialsDetailsCertificateResponseElement($model: AbstractCredentialsResponseElement): $model is CredentialsDetailsCertificateResponseElement;
|
|
12
11
|
export declare function isCredentialsDetailsTokenResponseElement($model: AbstractCredentialsResponseElement): $model is CredentialsDetailsTokenResponseElement;
|
|
13
|
-
export declare function isCredentialsDetailsUsernamePasswordResponseElement($model: AbstractCredentialsResponseElement): $model is CredentialsDetailsUsernamePasswordResponseElement;
|
|
14
12
|
export interface AsJson {
|
|
15
|
-
allowedEntities?: _CredentialAccessDataTransformation.AsJson[];
|
|
16
|
-
credentialUsageSummary: _CredentialUsageHandlerTransformation.AsJson[];
|
|
17
|
-
description: string;
|
|
18
|
-
externalVault?: _ExternalVaultConfigTransformation.AsJson;
|
|
19
|
-
id?: string;
|
|
20
13
|
name: string;
|
|
14
|
+
id?: string;
|
|
15
|
+
description: string;
|
|
21
16
|
owner: string;
|
|
22
17
|
ownerAccessOnly: boolean;
|
|
23
18
|
scope?: _AbstractCredentialsResponseElementScopeTransformation.AsJson;
|
|
24
|
-
|
|
19
|
+
externalVault?: _ExternalVaultConfigTransformation.AsJson;
|
|
20
|
+
credentialUsageSummary: _CredentialUsageHandlerTransformation.AsJson[];
|
|
25
21
|
type: _AbstractCredentialsResponseElementTypeTransformation.AsJson;
|
|
26
22
|
}
|
|
27
23
|
export declare function fromJson($model: AsJson, includeChildProps?: boolean): AbstractCredentialsResponseElement;
|