@dynatrace-sdk/client-classic-environment-v2 3.7.1 → 3.7.3
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 +13 -0
- package/README.md +66 -107
- package/cjs/index.js +3520 -3758
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +1935 -1976
- package/package.json +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +2 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-agent-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +5 -27
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +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 +3 -9
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +2 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +8 -13
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +4 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +2 -5
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +3 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +1 -1
- package/types/packages/{client/classic-environment-v2/src/lib/apis → shared-client-utils/src}/api-client-options.d.ts +1 -1
- package/types/packages/shared-client-utils/src/api-gateway-errors-handler.d.ts +9 -0
- package/types/packages/shared-client-utils/src/encoding.d.ts +17 -0
- package/types/packages/shared-client-utils/src/get-error-message.d.ts +8 -0
- package/types/packages/shared-client-utils/src/index.d.ts +6 -0
- package/types/packages/shared-client-utils/src/transformations.d.ts +64 -0
- package/types/packages/shared-client-utils/src/url-helpers.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/get-error-message.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts +0 -10
- package/types/packages/client/classic-environment-v2/src/lib/utils/transformations.d.ts +0 -7
- package/types/packages/client/classic-environment-v2/src/lib/utils/url-helpers.d.ts +0 -6
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.7.3)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -104,8 +104,7 @@ import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classi
|
|
|
104
104
|
const data =
|
|
105
105
|
await accessTokensActiveGateTokensClient.createToken({
|
|
106
106
|
body: {
|
|
107
|
-
activeGateType:
|
|
108
|
-
ActiveGateTokenCreateActiveGateType.Environment,
|
|
107
|
+
activeGateType: "ENVIRONMENT",
|
|
109
108
|
name: "myToken",
|
|
110
109
|
},
|
|
111
110
|
});
|
|
@@ -1163,13 +1162,7 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1163
1162
|
|
|
1164
1163
|
const data =
|
|
1165
1164
|
await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
|
|
1166
|
-
{
|
|
1167
|
-
agId: "...",
|
|
1168
|
-
body: {
|
|
1169
|
-
setting:
|
|
1170
|
-
ActiveGateAutoUpdateConfigSetting.Inherited,
|
|
1171
|
-
},
|
|
1172
|
-
},
|
|
1165
|
+
{ agId: "...", body: { setting: "INHERITED" } },
|
|
1173
1166
|
);
|
|
1174
1167
|
```
|
|
1175
1168
|
|
|
@@ -1231,12 +1224,7 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1231
1224
|
|
|
1232
1225
|
const data =
|
|
1233
1226
|
await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
|
|
1234
|
-
{
|
|
1235
|
-
body: {
|
|
1236
|
-
globalSetting:
|
|
1237
|
-
ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
|
|
1238
|
-
},
|
|
1239
|
-
},
|
|
1227
|
+
{ body: { globalSetting: "ENABLED" } },
|
|
1240
1228
|
);
|
|
1241
1229
|
```
|
|
1242
1230
|
|
|
@@ -1299,13 +1287,7 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1299
1287
|
|
|
1300
1288
|
const data =
|
|
1301
1289
|
await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
|
|
1302
|
-
{
|
|
1303
|
-
agId: "...",
|
|
1304
|
-
body: {
|
|
1305
|
-
setting:
|
|
1306
|
-
ActiveGateAutoUpdateConfigSetting.Inherited,
|
|
1307
|
-
},
|
|
1308
|
-
},
|
|
1290
|
+
{ agId: "...", body: { setting: "INHERITED" } },
|
|
1309
1291
|
);
|
|
1310
1292
|
```
|
|
1311
1293
|
|
|
@@ -1367,12 +1349,7 @@ import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-
|
|
|
1367
1349
|
|
|
1368
1350
|
const data =
|
|
1369
1351
|
await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
|
|
1370
|
-
{
|
|
1371
|
-
body: {
|
|
1372
|
-
globalSetting:
|
|
1373
|
-
ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
|
|
1374
|
-
},
|
|
1375
|
-
},
|
|
1352
|
+
{ body: { globalSetting: "ENABLED" } },
|
|
1376
1353
|
);
|
|
1377
1354
|
```
|
|
1378
1355
|
|
|
@@ -2350,10 +2327,7 @@ Code example
|
|
|
2350
2327
|
import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2351
2328
|
|
|
2352
2329
|
const data = await credentialVaultClient.createCredentials({
|
|
2353
|
-
body: {
|
|
2354
|
-
name: "...",
|
|
2355
|
-
scopes: [CredentialsScopesItem.AppEngine],
|
|
2356
|
-
},
|
|
2330
|
+
body: { name: "...", scopes: ["APP_ENGINE"] },
|
|
2357
2331
|
});
|
|
2358
2332
|
```
|
|
2359
2333
|
|
|
@@ -2674,10 +2648,7 @@ import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
2674
2648
|
|
|
2675
2649
|
const data = await credentialVaultClient.updateCredentials({
|
|
2676
2650
|
id: "...",
|
|
2677
|
-
body: {
|
|
2678
|
-
name: "...",
|
|
2679
|
-
scopes: [CredentialsScopesItem.AppEngine],
|
|
2680
|
-
},
|
|
2651
|
+
body: { name: "...", scopes: ["APP_ENGINE"] },
|
|
2681
2652
|
});
|
|
2682
2653
|
```
|
|
2683
2654
|
|
|
@@ -2828,10 +2799,7 @@ Code example
|
|
|
2828
2799
|
import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2829
2800
|
|
|
2830
2801
|
const data = await eventsClient.createEvent({
|
|
2831
|
-
body: {
|
|
2832
|
-
eventType: EventIngestEventType.AvailabilityEvent,
|
|
2833
|
-
title: "...",
|
|
2834
|
-
},
|
|
2802
|
+
body: { eventType: "AVAILABILITY_EVENT", title: "..." },
|
|
2835
2803
|
});
|
|
2836
2804
|
```
|
|
2837
2805
|
|
|
@@ -3167,7 +3135,7 @@ Lists events within the specified timeframe
|
|
|
3167
3135
|
|
|
3168
3136
|
| Name | Type | Description |
|
|
3169
3137
|
| --- | --- | --- |
|
|
3170
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. 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
|
|
3138
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. 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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The number of entities that can be selected is limited to 10000.</p> |
|
|
3171
3139
|
|config.eventSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only events matching the specified criteria are included in the response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Event ID: <code>eventId("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w" target="_blank" rel="noopener noreferrer" >GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code>. Only properties with the <strong>filterable</strong> property set to <code>true</code> can be used. You can check event properties via the <a href="https://dt-url.net/es03nwo" target="_blank" rel="noopener noreferrer" >GET event properties</a> call.</li> </ul> <p>To set several criteria, separate them with commas (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
3172
3140
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 hours is used (<code>now-2h</code>).</p> |
|
|
3173
3141
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
@@ -3541,7 +3509,7 @@ Gets the configuration schema of the specified version of the extension 2.0
|
|
|
3541
3509
|
| Name | Type | Description |
|
|
3542
3510
|
| --- | --- | --- |
|
|
3543
3511
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3544
|
-
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0
|
|
3512
|
+
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
3545
3513
|
|
|
3546
3514
|
|
|
3547
3515
|
|
|
@@ -3608,7 +3576,7 @@ Gets details of the specified version of the extension 2.0
|
|
|
3608
3576
|
| --- | --- | --- |
|
|
3609
3577
|
|config.acceptType<sup>*required</sup>|"application/json; charset=utf-8"| |
|
|
3610
3578
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3611
|
-
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0
|
|
3579
|
+
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
3612
3580
|
|
|
3613
3581
|
|
|
3614
3582
|
|
|
@@ -3666,7 +3634,7 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
3666
3634
|
| --- | --- | --- |
|
|
3667
3635
|
|config.acceptType<sup>*required</sup>|"application/octet-stream"| |
|
|
3668
3636
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3669
|
-
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0
|
|
3637
|
+
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
3670
3638
|
|
|
3671
3639
|
|
|
3672
3640
|
|
|
@@ -3841,7 +3809,7 @@ List all activeGate groups available for extension
|
|
|
3841
3809
|
| Name | Type | Description |
|
|
3842
3810
|
| --- | --- | --- |
|
|
3843
3811
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
3844
|
-
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0
|
|
3812
|
+
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
3845
3813
|
|
|
3846
3814
|
|
|
3847
3815
|
|
|
@@ -3947,7 +3915,9 @@ const data =
|
|
|
3947
3915
|
|
|
3948
3916
|
|
|
3949
3917
|
<a name="getenvironmentconfigurationevents"></a>
|
|
3950
|
-
### getEnvironmentConfigurationEvents
|
|
3918
|
+
### ~~getEnvironmentConfigurationEvents~~
|
|
3919
|
+
|
|
3920
|
+
> ⚠️ **Deprecated**
|
|
3951
3921
|
|
|
3952
3922
|
<div class="padding-bottom--md">
|
|
3953
3923
|
<strong>extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<<a href="#extensioneventslist">ExtensionEventsList</a>></strong>
|
|
@@ -4015,7 +3985,9 @@ const data =
|
|
|
4015
3985
|
|
|
4016
3986
|
|
|
4017
3987
|
<a name="getextensionmonitoringconfigurationevents"></a>
|
|
4018
|
-
### getExtensionMonitoringConfigurationEvents
|
|
3988
|
+
### ~~getExtensionMonitoringConfigurationEvents~~
|
|
3989
|
+
|
|
3990
|
+
> ⚠️ **Deprecated**
|
|
4019
3991
|
|
|
4020
3992
|
<div class="padding-bottom--md">
|
|
4021
3993
|
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<<a href="#extensioneventslist" target="_blank" rel="noopener noreferrer">ExtensionEventsList</a>></strong>
|
|
@@ -4176,7 +4148,7 @@ Gets the extension 2.0 schema file in the specified version
|
|
|
4176
4148
|
| Name | Type | Description |
|
|
4177
4149
|
| --- | --- | --- |
|
|
4178
4150
|
|config.fileName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema file. |
|
|
4179
|
-
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema.
|
|
4151
|
+
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
4180
4152
|
|
|
4181
4153
|
|
|
4182
4154
|
|
|
@@ -4498,7 +4470,7 @@ Lists all the files available for the specified extension 2.0 schema version
|
|
|
4498
4470
|
| Name | Type | Description |
|
|
4499
4471
|
| --- | --- | --- |
|
|
4500
4472
|
|config.acceptType<sup>*required</sup>|"application/json; charset=utf-8"| |
|
|
4501
|
-
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema.
|
|
4473
|
+
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
4502
4474
|
|
|
4503
4475
|
|
|
4504
4476
|
|
|
@@ -4554,7 +4526,7 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
4554
4526
|
| Name | Type | Description |
|
|
4555
4527
|
| --- | --- | --- |
|
|
4556
4528
|
|config.acceptType<sup>*required</sup>|"application/octet-stream"| |
|
|
4557
|
-
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema.
|
|
4529
|
+
|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
4558
4530
|
|
|
4559
4531
|
|
|
4560
4532
|
|
|
@@ -4715,7 +4687,7 @@ Deletes the specified version of the extension 2.0
|
|
|
4715
4687
|
| Name | Type | Description |
|
|
4716
4688
|
| --- | --- | --- |
|
|
4717
4689
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4718
|
-
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0
|
|
4690
|
+
|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested extension 2.0 <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
4719
4691
|
|
|
4720
4692
|
|
|
4721
4693
|
|
|
@@ -5064,7 +5036,7 @@ Please note that export works **only** for *Logs Classic*.
|
|
|
5064
5036
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
5065
5037
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of results per result page. |
|
|
5066
5038
|
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p> |
|
|
5067
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
5039
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> <br/>Pattern: <code>^\[+-]?\[a-z]+$</code>|
|
|
5068
5040
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
5069
5041
|
|
|
5070
5042
|
|
|
@@ -5238,7 +5210,7 @@ It is **not** recommended to run Grail queries using Logs v2 API, please use Gra
|
|
|
5238
5210
|
|config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p> |
|
|
5239
5211
|
|config.nextSliceKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next slice of results. You can find it in the <strong>nextSliceKey</strong> field of the previous response.</p> <p>The first slice is always returned if you don't specify this parameter.</p> <p>If this parameter is set, all other query parameters are ignored.</p> <p>Unsupported on <em>Log Management and Analytics, powered by Grail</em>.</p> |
|
|
5240
5212
|
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p> |
|
|
5241
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
5213
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> <br/>Pattern: <code>^\[+-]?\[a-z]+$</code>|
|
|
5242
5214
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
5243
5215
|
|
|
5244
5216
|
|
|
@@ -5694,7 +5666,7 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
|
|
|
5694
5666
|
| Name | Type | Description |
|
|
5695
5667
|
| --- | --- | --- |
|
|
5696
5668
|
|config.acceptType<sup>*required</sup>|"application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8"| |
|
|
5697
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entity scope of the query. Only data points delivered by matched entities are included in response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code
|
|
5669
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entity scope of the query. Only data points delivered by matched entities are included in response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>Use the <a href="https://dt-url.net/6z23ifk" target="_blank" rel="noopener noreferrer" ><code>GET /metrics/\\{metricId}</code></a> call to fetch the list of possible entity types for your metric.</p> <p>To set a universal scope matching all entities, omit this parameter.</p> |
|
|
5698
5670
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 hours is used (<code>now-2h</code>).</p> |
|
|
5699
5671
|
|config.metricSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Selects metrics for the query by their keys. You can select up to 10 metrics for one query.</p> <p>You can specify multiple metric keys separated by commas (for example, <code>metrickey1,metrickey2</code>). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the <code>builtin:host.cpu.idle</code> and <code>builtin:host.cpu.user</code> metric, write: <code>builtin:host.cpu.(idle,user)</code>.</p> <p>If the metric key contains any symbols you must quote (<code>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>~</code>):</p> <ul> <li>Quotes (<code>"</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type "APACHE"</strong> you must specify this selector:</p> <p><code>"ext:selfmonitoring.jmx.Agents: Type ~"APACHE~""</code></p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector" target="_blank" rel="noopener noreferrer" >Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> |
|
|
5700
5672
|
|config.mzSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The management zone scope of the query. Only metrics data relating to the specified management zones are included to the response.</p> <p>You can set one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li><code>mzId(123,456)</code></li> <li><code>mzName("name-1","name-2")</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName("name-1","name-2"),mzId(1234)</code>. Only results matching <strong>all</strong> of the criteria are included in the response.For example, to list metrics that have the id <strong>123</strong> OR <strong>234</strong> AND the name <strong>name-1</strong> OR <strong>name-2</strong>, use this <strong>mzSelector</strong>: `mzId(123,234),mzName("name-1","name-2").</li> </ul> |
|
|
@@ -5968,7 +5940,7 @@ Automatic management zone rules will apply again to entities without a security
|
|
|
5968
5940
|
|
|
5969
5941
|
| Name | Type | Description |
|
|
5970
5942
|
| --- | --- | --- |
|
|
5971
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</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
|
|
5943
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
5972
5944
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
5973
5945
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
5974
5946
|
|
|
@@ -6044,7 +6016,7 @@ You can limit the output by using pagination:
|
|
|
6044
6016
|
|
|
6045
6017
|
| Name | Type | Description |
|
|
6046
6018
|
| --- | --- | --- |
|
|
6047
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code
|
|
6019
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The field is <strong>required</strong> when you're querying the first page of results.</p> |
|
|
6048
6020
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
|
|
6049
6021
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
6050
6022
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
@@ -6370,7 +6342,7 @@ Automatic management zone rules will not apply to entities with a set security c
|
|
|
6370
6342
|
| Name | Type | Description |
|
|
6371
6343
|
| --- | --- | --- |
|
|
6372
6344
|
|config.body<sup>*required</sup>|<a href="#securitycontextdtoimpl" target="_blank" rel="noopener noreferrer">SecurityContextDtoImpl</a>| |
|
|
6373
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</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
|
|
6345
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6374
6346
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
6375
6347
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
6376
6348
|
|
|
@@ -6442,7 +6414,7 @@ Deletes the specified tag from the specified entities
|
|
|
6442
6414
|
| Name | Type | Description |
|
|
6443
6415
|
| --- | --- | --- |
|
|
6444
6416
|
|config.deleteAllWithKey|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<ul> <li>If <code>true</code>, all tags with the specified key are deleted, regardless of the value.</li> <li>If <code>false</code>, only tags with exact match of key <strong>and</strong> value are deleted.</li> </ul> <p>If not set, <code>false</code> is used.</p> |
|
|
6445
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to delete tags.</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
|
|
6417
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to delete tags.</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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6446
6418
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 24 hours is used (<code>now-24h</code>).</p> |
|
|
6447
6419
|
|config.key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The key of the tag to be deleted.</p> <p>If <strong>deleteAllWithKey</strong> is <code>true</code>, then all tags with this key are deleted. Otherwise, only tags with exact match of key <strong>and</strong> value are deleted.</p> <p>For value-only tags, specify the value here.</p> |
|
|
6448
6420
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
@@ -6511,7 +6483,7 @@ Automatically applied tags and imported tags are not included.
|
|
|
6511
6483
|
|
|
6512
6484
|
| Name | Type | Description |
|
|
6513
6485
|
| --- | --- | --- |
|
|
6514
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to read tags.</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
|
|
6486
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to read tags.</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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6515
6487
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 24 hours is used (<code>now-24h</code>).</p> |
|
|
6516
6488
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
6517
6489
|
|
|
@@ -6578,7 +6550,7 @@ All existing tags remain unaffected.
|
|
|
6578
6550
|
| Name | Type | Description |
|
|
6579
6551
|
| --- | --- | --- |
|
|
6580
6552
|
|config.body<sup>*required</sup>|<a href="#addentitytags" target="_blank" rel="noopener noreferrer">AddEntityTags</a>| |
|
|
6581
|
-
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to update tags.</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
|
|
6553
|
+
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to update tags.</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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6582
6554
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 24 hours is used (<code>now-24h</code>).</p> |
|
|
6583
6555
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
6584
6556
|
|
|
@@ -6651,7 +6623,7 @@ Only process group instances are supported.
|
|
|
6651
6623
|
|
|
6652
6624
|
| Name | Type | Description |
|
|
6653
6625
|
| --- | --- | --- |
|
|
6654
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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
|
|
6626
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
6655
6627
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 24 hours is used (<code>now-24h</code>).</p> |
|
|
6656
6628
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
6657
6629
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<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> |
|
|
@@ -7527,12 +7499,12 @@ Lists problems observed within the specified timeframe
|
|
|
7527
7499
|
|
|
7528
7500
|
| Name | Type | Description |
|
|
7529
7501
|
| --- | --- | --- |
|
|
7530
|
-
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. 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
|
|
7502
|
+
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. 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(&quot;value&quot;)</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(&quot;value&quot;))</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(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(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>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</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" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The maximum number of entities that may be selected is limited to 10000.</p> |
|
|
7531
7503
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of additional 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>evidenceDetails</code>: The details of the root cause.</li> <li><code>impactAnalysis</code>: The impact analysis of the problem on other entities/users.</li> <li><code>recentComments</code>: A list of the most recent comments to the problem.</li> </ul> <p>To add properties, specify them as a comma-separated list (for example, <code>evidenceDetails,impactAnalysis</code>).</p> <p>The field is valid only for the current page of results. You must set it for each page you're requesting.</p> |
|
|
7532
7504
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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 hours is used (<code>now-2h</code>).</p> |
|
|
7533
7505
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
|
|
7534
7506
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 50 is used.</p> |
|
|
7535
|
-
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("
|
|
7507
|
+
|config.problemSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("\[context]key:value","key:value")</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Under maintenance: <code>underMaintenance(true|false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text(&quot;value&quot;)</code>. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the <code>relevance</code> sort option should be used to get the most relevant problems first. The special characters <code>\\~</code> and <code>&quot;</code> need to be escaped using a <code>\\~</code> (e.g. double quote search <code>text(&quot;\\~&quot;&quot;)</code>). The search value is limited to 30 characters.</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> |
|
|
7536
7508
|
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies a set of comma-separated (<code>,</code>) fields for sorting in the problem list.</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: problem status (<code>+</code> open problems first or <code>-</code> closed problems first)</li> <li><code>startTime</code>: problem start time (<code>+</code> old problems first or <code>-</code> new problems first)</li> <li><code>relevance</code>: problem relevance (<code>+</code> least relevant problems first or <code>-</code> most relevant problems first) - can be used only in combination with text search</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> <p>You can specify several levels of sorting. For example, <code>+status,-startTime</code> sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.</p> |
|
|
7537
7509
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
7538
7510
|
|
|
@@ -7767,8 +7739,7 @@ const data =
|
|
|
7767
7739
|
await securityProblemsClient.bulkMuteRemediationItems({
|
|
7768
7740
|
id: "...",
|
|
7769
7741
|
body: {
|
|
7770
|
-
reason:
|
|
7771
|
-
RemediationItemsBulkMuteReason.ConfigurationNotAffected,
|
|
7742
|
+
reason: "CONFIGURATION_NOT_AFFECTED",
|
|
7772
7743
|
remediationItemIds: ["..."],
|
|
7773
7744
|
},
|
|
7774
7745
|
});
|
|
@@ -7833,8 +7804,7 @@ import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environmen
|
|
|
7833
7804
|
const data =
|
|
7834
7805
|
await securityProblemsClient.bulkMuteSecurityProblems({
|
|
7835
7806
|
body: {
|
|
7836
|
-
reason:
|
|
7837
|
-
SecurityProblemsBulkMuteReason.ConfigurationNotAffected,
|
|
7807
|
+
reason: "CONFIGURATION_NOT_AFFECTED",
|
|
7838
7808
|
securityProblemIds: ["..."],
|
|
7839
7809
|
},
|
|
7840
7810
|
});
|
|
@@ -7901,7 +7871,7 @@ const data =
|
|
|
7901
7871
|
await securityProblemsClient.bulkUnmuteRemediationItems({
|
|
7902
7872
|
id: "...",
|
|
7903
7873
|
body: {
|
|
7904
|
-
reason:
|
|
7874
|
+
reason: "AFFECTED",
|
|
7905
7875
|
remediationItemIds: ["..."],
|
|
7906
7876
|
},
|
|
7907
7877
|
});
|
|
@@ -7966,7 +7936,7 @@ import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environmen
|
|
|
7966
7936
|
const data =
|
|
7967
7937
|
await securityProblemsClient.bulkUnmuteSecurityProblems({
|
|
7968
7938
|
body: {
|
|
7969
|
-
reason:
|
|
7939
|
+
reason: "AFFECTED",
|
|
7970
7940
|
securityProblemIds: ["..."],
|
|
7971
7941
|
},
|
|
7972
7942
|
});
|
|
@@ -8497,10 +8467,7 @@ import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environmen
|
|
|
8497
8467
|
const data =
|
|
8498
8468
|
await securityProblemsClient.muteSecurityProblem({
|
|
8499
8469
|
id: "...",
|
|
8500
|
-
body: {
|
|
8501
|
-
reason:
|
|
8502
|
-
SecurityProblemMuteReason.ConfigurationNotAffected,
|
|
8503
|
-
},
|
|
8470
|
+
body: { reason: "CONFIGURATION_NOT_AFFECTED" },
|
|
8504
8471
|
});
|
|
8505
8472
|
```
|
|
8506
8473
|
|
|
@@ -8570,7 +8537,7 @@ const data =
|
|
|
8570
8537
|
body: {
|
|
8571
8538
|
comment: "...",
|
|
8572
8539
|
muted: false,
|
|
8573
|
-
reason:
|
|
8540
|
+
reason: "IGNORE",
|
|
8574
8541
|
},
|
|
8575
8542
|
});
|
|
8576
8543
|
```
|
|
@@ -8699,7 +8666,7 @@ import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environmen
|
|
|
8699
8666
|
const data =
|
|
8700
8667
|
await securityProblemsClient.unmuteSecurityProblem({
|
|
8701
8668
|
id: "...",
|
|
8702
|
-
body: { reason:
|
|
8669
|
+
body: { reason: "AFFECTED" },
|
|
8703
8670
|
});
|
|
8704
8671
|
```
|
|
8705
8672
|
|
|
@@ -8777,7 +8744,7 @@ const data = await serviceLevelObjectivesClient.createAlert(
|
|
|
8777
8744
|
body: {
|
|
8778
8745
|
alertName: "...",
|
|
8779
8746
|
alertThreshold: 10,
|
|
8780
|
-
alertType:
|
|
8747
|
+
alertType: "BURN_RATE",
|
|
8781
8748
|
},
|
|
8782
8749
|
},
|
|
8783
8750
|
);
|
|
@@ -8843,8 +8810,7 @@ import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-envi
|
|
|
8843
8810
|
|
|
8844
8811
|
const data = await serviceLevelObjectivesClient.createSlo({
|
|
8845
8812
|
body: {
|
|
8846
|
-
evaluationType:
|
|
8847
|
-
SloConfigItemDtoImplEvaluationType.Aggregate,
|
|
8813
|
+
evaluationType: "AGGREGATE",
|
|
8848
8814
|
name: "Payment service availability",
|
|
8849
8815
|
target: 95,
|
|
8850
8816
|
timeframe: "-1d",
|
|
@@ -9127,8 +9093,7 @@ const data =
|
|
|
9127
9093
|
await serviceLevelObjectivesClient.updateSloById({
|
|
9128
9094
|
id: "...",
|
|
9129
9095
|
body: {
|
|
9130
|
-
evaluationType:
|
|
9131
|
-
SloConfigItemDtoImplEvaluationType.Aggregate,
|
|
9096
|
+
evaluationType: "AGGREGATE",
|
|
9132
9097
|
name: "Payment service availability",
|
|
9133
9098
|
target: 95,
|
|
9134
9099
|
timeframe: "-1d",
|
|
@@ -9279,7 +9244,7 @@ import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
9279
9244
|
|
|
9280
9245
|
const data = await settingsObjectsClient.addPermission({
|
|
9281
9246
|
objectId: "...",
|
|
9282
|
-
body: { accessor: { type:
|
|
9247
|
+
body: { accessor: { type: "user" } },
|
|
9283
9248
|
});
|
|
9284
9249
|
```
|
|
9285
9250
|
|
|
@@ -9488,7 +9453,7 @@ import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
9488
9453
|
|
|
9489
9454
|
const data = await settingsObjectsClient.getPermission({
|
|
9490
9455
|
objectId: "...",
|
|
9491
|
-
accessorType:
|
|
9456
|
+
accessorType: "group",
|
|
9492
9457
|
accessorId: "...",
|
|
9493
9458
|
});
|
|
9494
9459
|
```
|
|
@@ -10051,7 +10016,7 @@ import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
10051
10016
|
|
|
10052
10017
|
const data = await settingsObjectsClient.removePermission({
|
|
10053
10018
|
objectId: "...",
|
|
10054
|
-
accessorType:
|
|
10019
|
+
accessorType: "group",
|
|
10055
10020
|
accessorId: "...",
|
|
10056
10021
|
});
|
|
10057
10022
|
```
|
|
@@ -10262,7 +10227,7 @@ import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
10262
10227
|
|
|
10263
10228
|
const data = await settingsObjectsClient.transferOwnership({
|
|
10264
10229
|
objectId: "...",
|
|
10265
|
-
body: { newOwner: { type:
|
|
10230
|
+
body: { newOwner: { type: "user" } },
|
|
10266
10231
|
});
|
|
10267
10232
|
```
|
|
10268
10233
|
|
|
@@ -10330,7 +10295,7 @@ import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
10330
10295
|
|
|
10331
10296
|
const data = await settingsObjectsClient.updatePermission({
|
|
10332
10297
|
objectId: "...",
|
|
10333
|
-
accessorType:
|
|
10298
|
+
accessorType: "group",
|
|
10334
10299
|
accessorId: "...",
|
|
10335
10300
|
body: {},
|
|
10336
10301
|
});
|
|
@@ -10602,10 +10567,7 @@ import { syntheticHttpMonitorExecutionsClient } from "@dynatrace-sdk/client-clas
|
|
|
10602
10567
|
|
|
10603
10568
|
const data =
|
|
10604
10569
|
await syntheticHttpMonitorExecutionsClient.getExecutionResult(
|
|
10605
|
-
{
|
|
10606
|
-
monitorId: "...",
|
|
10607
|
-
resultType: GetExecutionResultPathResultType.Success,
|
|
10608
|
-
},
|
|
10570
|
+
{ monitorId: "...", resultType: "SUCCESS" },
|
|
10609
10571
|
);
|
|
10610
10572
|
```
|
|
10611
10573
|
|
|
@@ -10679,7 +10641,7 @@ const data =
|
|
|
10679
10641
|
longitude: 10,
|
|
10680
10642
|
name: "...",
|
|
10681
10643
|
nodes: ["..."],
|
|
10682
|
-
type:
|
|
10644
|
+
type: "CLUSTER",
|
|
10683
10645
|
},
|
|
10684
10646
|
},
|
|
10685
10647
|
);
|
|
@@ -11416,10 +11378,7 @@ import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/cl
|
|
|
11416
11378
|
|
|
11417
11379
|
const data =
|
|
11418
11380
|
await syntheticLocationsNodesAndConfigurationClient.updateLocation(
|
|
11419
|
-
{
|
|
11420
|
-
locationId: "...",
|
|
11421
|
-
body: { type: SyntheticLocationUpdateType.Private },
|
|
11422
|
-
},
|
|
11381
|
+
{ locationId: "...", body: { type: "PRIVATE" } },
|
|
11423
11382
|
);
|
|
11424
11383
|
```
|
|
11425
11384
|
|
|
@@ -11706,7 +11665,7 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
|
|
|
11706
11665
|
|
|
11707
11666
|
| Name | Type | Description |
|
|
11708
11667
|
| --- | --- | --- |
|
|
11709
|
-
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code
|
|
11668
|
+
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag(\[context]key:value,key:value,key)</code>. Tags in <code>\[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor enablement: <code>enabled(true)</code>.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
11710
11669
|
|
|
11711
11670
|
|
|
11712
11671
|
|
|
@@ -13296,8 +13255,8 @@ Synchronization credentials with CyberArk Vault using allowed machines (location
|
|
|
13296
13255
|
| --- | --- | --- |
|
|
13297
13256
|
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
13298
13257
|
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
13299
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)
|
|
13300
|
-
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)
|
|
13258
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
13259
|
+
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
13301
13260
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
13302
13261
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
13303
13262
|
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
@@ -13314,8 +13273,8 @@ Synchronization credentials with CyberArk Vault using username password authenti
|
|
|
13314
13273
|
| --- | --- | --- |
|
|
13315
13274
|
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
13316
13275
|
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
13317
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)
|
|
13318
|
-
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)
|
|
13276
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
13277
|
+
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
13319
13278
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
13320
13279
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
13321
13280
|
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
@@ -13908,7 +13867,7 @@ A list of exported log records.
|
|
|
13908
13867
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
13909
13868
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
13910
13869
|
|variables<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Custom variables used in extension configuration |
|
|
13911
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version
|
|
13870
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
13912
13871
|
|
|
13913
13872
|
### ExtensionAssetsDto
|
|
13914
13873
|
|
|
@@ -13919,13 +13878,13 @@ List of assets imported with the active extension environment configuration.
|
|
|
13919
13878
|
|assets<sup>*required</sup>|Array<<a href="#assetinfodto" target="_blank" rel="noopener noreferrer">AssetInfoDto</a>>|The list of the imported assets. |
|
|
13920
13879
|
|errors<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of errors during asset import |
|
|
13921
13880
|
|status<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The status of the assets list. |
|
|
13922
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Version of the active extension environment configuration.
|
|
13881
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Version of the active extension environment configuration. <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
13923
13882
|
|
|
13924
13883
|
### ExtensionEnvironmentConfigurationVersion
|
|
13925
13884
|
|
|
13926
13885
|
| Name | Type | Description |
|
|
13927
13886
|
| --- | --- | --- |
|
|
13928
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version
|
|
13887
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
13929
13888
|
|
|
13930
13889
|
### ExtensionEventDto
|
|
13931
13890
|
|
|
@@ -13959,10 +13918,10 @@ A list of extensions with additional metadata.
|
|
|
13959
13918
|
|
|
13960
13919
|
| Name | Type | Description |
|
|
13961
13920
|
| --- | --- | --- |
|
|
13962
|
-
|activeVersion|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active version in the environment (null if none is active)
|
|
13921
|
+
|activeVersion|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active version in the environment (null if none is active) <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
13963
13922
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
13964
13923
|
|keywords<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Extension keywords for the highest version |
|
|
13965
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Highest installed version
|
|
13924
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Highest installed version <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
13966
13925
|
|
|
13967
13926
|
### ExtensionInfoList
|
|
13968
13927
|
|
|
@@ -14020,7 +13979,7 @@ A list of extensions with additional metadata.
|
|
|
14020
13979
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
14021
13980
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
14022
13981
|
|variables<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Custom variables used in extension configuration |
|
|
14023
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version
|
|
13982
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
14024
13983
|
|
|
14025
13984
|
### ExtensionUploadResponseDtoFeatureSetsDetails
|
|
14026
13985
|
|
|
@@ -14618,7 +14577,7 @@ A list of extensions.
|
|
|
14618
14577
|
| Name | Type | Description |
|
|
14619
14578
|
| --- | --- | --- |
|
|
14620
14579
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
14621
|
-
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version
|
|
14580
|
+
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension version <br/>Pattern: <code>^(0|\[1-9]\\d\*)(\\.(0|\[1-9]\\d\*))?(\\.(0|\[1-9]\\d\*))?</code>|
|
|
14622
14581
|
|
|
14623
14582
|
### MobileImpact
|
|
14624
14583
|
|