@dynatrace-sdk/client-classic-environment-v2 1.8.2 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +1 -1
  3. package/cjs/index.js +13220 -5134
  4. package/docs/DOCS.md +803 -210
  5. package/dynatrace-metadata.json +1 -1
  6. package/esm/index.js +13225 -5135
  7. package/package.json +1 -1
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +166 -0
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +3 -1
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +14 -3
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +15 -3
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +189 -0
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +3 -3
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +12 -3
  17. package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.d.ts +8 -0
  18. package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.transformation.d.ts +11 -0
  19. package/types/packages/client/classic-environment-v2/src/lib/models/affected-entity.d.ts +13 -0
  20. package/types/packages/client/classic-environment-v2/src/lib/models/affected-entity.transformation.d.ts +7 -0
  21. package/types/packages/client/classic-environment-v2/src/lib/models/attack-attack-type.d.ts +9 -0
  22. package/types/packages/client/classic-environment-v2/src/lib/models/attack-attack-type.transformation.d.ts +4 -0
  23. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.d.ts +12 -0
  24. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.transformation.d.ts +9 -0
  25. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.d.ts +14 -0
  26. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.transformation.d.ts +11 -0
  27. package/types/packages/client/classic-environment-v2/src/lib/models/attack-list.d.ts +24 -0
  28. package/types/packages/client/classic-environment-v2/src/lib/models/attack-list.transformation.d.ts +10 -0
  29. package/types/packages/client/classic-environment-v2/src/lib/models/attack-request-header.d.ts +13 -0
  30. package/types/packages/client/classic-environment-v2/src/lib/models/attack-request-header.transformation.d.ts +7 -0
  31. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-data-assets.d.ts +8 -0
  32. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-data-assets.transformation.d.ts +4 -0
  33. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-exposure.d.ts +8 -0
  34. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-exposure.transformation.d.ts +4 -0
  35. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.d.ts +13 -0
  36. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.transformation.d.ts +10 -0
  37. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.d.ts +11 -0
  38. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.transformation.d.ts +8 -0
  39. package/types/packages/client/classic-environment-v2/src/lib/models/attack-state.d.ts +8 -0
  40. package/types/packages/client/classic-environment-v2/src/lib/models/attack-state.transformation.d.ts +4 -0
  41. package/types/packages/client/classic-environment-v2/src/lib/models/attack-target.d.ts +13 -0
  42. package/types/packages/client/classic-environment-v2/src/lib/models/attack-target.transformation.d.ts +7 -0
  43. package/types/packages/client/classic-environment-v2/src/lib/models/attack-technology.d.ts +9 -0
  44. package/types/packages/client/classic-environment-v2/src/lib/models/attack-technology.transformation.d.ts +4 -0
  45. package/types/packages/client/classic-environment-v2/src/lib/models/attack.d.ts +46 -0
  46. package/types/packages/client/classic-environment-v2/src/lib/models/attack.transformation.d.ts +31 -0
  47. package/types/packages/client/classic-environment-v2/src/lib/models/attacker-location.d.ts +17 -0
  48. package/types/packages/client/classic-environment-v2/src/lib/models/attacker-location.transformation.d.ts +8 -0
  49. package/types/packages/client/classic-environment-v2/src/lib/models/attacker.d.ts +11 -0
  50. package/types/packages/client/classic-environment-v2/src/lib/models/attacker.transformation.d.ts +8 -0
  51. package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details-type.d.ts +2 -1
  52. package/types/packages/client/classic-environment-v2/src/lib/models/code-location.d.ts +35 -0
  53. package/types/packages/client/classic-environment-v2/src/lib/models/code-location.transformation.d.ts +14 -0
  54. package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.d.ts +1 -1
  55. package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.transformation.d.ts +1 -1
  56. package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload-type.d.ts +14 -0
  57. package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload-type.transformation.d.ts +4 -0
  58. package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.d.ts +15 -0
  59. package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.transformation.d.ts +9 -0
  60. package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.d.ts +2 -2
  61. package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.transformation.d.ts +1 -1
  62. package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +1 -1
  63. package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.d.ts +6 -2
  64. package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.transformation.d.ts +1 -0
  65. package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.d.ts +27 -0
  66. package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.transformation.d.ts +12 -0
  67. package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.d.ts +13 -0
  68. package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.transformation.d.ts +10 -0
  69. package/types/packages/client/classic-environment-v2/src/lib/models/http-request-parameter.d.ts +13 -0
  70. package/types/packages/client/classic-environment-v2/src/lib/models/http-request-parameter.transformation.d.ts +7 -0
  71. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +66 -8
  72. package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.d.ts +4 -0
  73. package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.transformation.d.ts +1 -0
  74. package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
  75. package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +7 -0
  76. package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.transformation.d.ts +1 -0
  77. package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.d.ts +7 -0
  78. package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.transformation.d.ts +10 -0
  79. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-assessment-accuracy.d.ts +8 -0
  80. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-assessment-accuracy.transformation.d.ts +4 -0
  81. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +2 -0
  82. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.transformation.d.ts +2 -0
  83. package/types/packages/client/classic-environment-v2/src/lib/models/request-information.d.ts +19 -0
  84. package/types/packages/client/classic-environment-v2/src/lib/models/request-information.transformation.d.ts +10 -0
  85. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-assessment-accuracy.d.ts +1 -1
  86. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-assessment-accuracy.d.ts +1 -1
  87. package/types/packages/client/classic-environment-v2/src/lib/models/security-context-dto-impl.d.ts +6 -0
  88. package/types/packages/client/classic-environment-v2/src/lib/models/security-context-dto-impl.transformation.d.ts +6 -0
  89. package/types/packages/client/classic-environment-v2/src/lib/models/security-context-result-dto.d.ts +13 -0
  90. package/types/packages/client/classic-environment-v2/src/lib/models/security-context-result-dto.transformation.d.ts +7 -0
  91. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +2 -4
  92. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.transformation.d.ts +2 -4
  93. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +0 -2
  94. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +0 -2
  95. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +0 -2
  96. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +0 -2
  97. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +0 -2
  98. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.transformation.d.ts +0 -2
  99. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +7 -0
  100. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.transformation.d.ts +1 -0
  101. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.d.ts +12 -0
  102. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.transformation.d.ts +9 -0
  103. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.d.ts +12 -0
  104. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.transformation.d.ts +9 -0
  105. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.d.ts +11 -0
  106. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.transformation.d.ts +8 -0
  107. package/types/packages/client/classic-environment-v2/src/lib/models/truncation-info.d.ts +9 -0
  108. package/types/packages/client/classic-environment-v2/src/lib/models/truncation-info.transformation.d.ts +6 -0
  109. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.d.ts +19 -0
  110. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.transformation.d.ts +13 -0
  111. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.d.ts +1 -0
  112. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.d.ts +0 -8
  113. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.transformation.d.ts +0 -4
  114. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.d.ts +0 -6
  115. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.transformation.d.ts +0 -6
  116. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.d.ts +0 -6
  117. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.transformation.d.ts +0 -6
  118. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.d.ts +0 -6
  119. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.transformation.d.ts +0 -6
package/docs/DOCS.md CHANGED
@@ -26,8 +26,8 @@ import NpmLogo from "@site/static/img/npm-logo.png";
26
26
  </a>
27
27
  </div>
28
28
  <div class="col" style={{ textAlign: "right" }}>
29
- <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.8.2">
30
- v1.8.2
29
+ <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.10.0">
30
+ v1.10.0
31
31
  </a>
32
32
  </div>
33
33
  </div>
@@ -1254,6 +1254,105 @@ const data = await activeGatesClient.getOneActiveGateById({
1254
1254
 
1255
1255
  </div>
1256
1256
 
1257
+ ## attacksClient
1258
+
1259
+ ```js
1260
+ import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
1261
+ ```
1262
+
1263
+ ### getAttack
1264
+
1265
+ <div class="padding-bottom--md">
1266
+ <strong>attacksClient.getAttack(config): Promise&lt;<a href="#attack">Attack</a>&gt;</strong>
1267
+
1268
+ <div class="padding-left--md">
1269
+
1270
+ Gets the specified attack
1271
+
1272
+ **Required scope:** environment-api:attacks:read
1273
+ **One of the following permissions is required:**
1274
+
1275
+ - environment:roles:manage-security-problems
1276
+ - environment:roles:view-security-problems
1277
+
1278
+ </div>
1279
+
1280
+ #### Parameters
1281
+
1282
+ | Name | Type | Description |
1283
+ | ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1284
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional attack 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>attackTarget</code>: The targeted host/database of an attack.</li> <li><code>request</code>: The request that was sent from the attacker.</li> <li><code>entrypoint</code>: The entry point used by an attacker to start a specific attack.</li> <li><code>vulnerability</code>: The vulnerability utilized by the attack.</li> <li><code>securityProblem</code>: The related security problem.</li> <li><code>attacker</code>: The attacker of an attack.</li> <li><code>managementZones</code>: The related management zones.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+attackTarget,+securityProblem</code>).</p> |
1285
+ | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the attack. |
1286
+
1287
+ #### Returns
1288
+
1289
+ Success
1290
+
1291
+ <details>
1292
+ <summary>
1293
+ Code example
1294
+
1295
+ </summary>
1296
+
1297
+ ```ts
1298
+ import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
1299
+
1300
+ const data = await attacksClient.getAttack({ id: "..." });
1301
+ ```
1302
+
1303
+ </details>
1304
+
1305
+ </div>
1306
+
1307
+ ### getAttacks
1308
+
1309
+ <div class="padding-bottom--md">
1310
+ <strong>attacksClient.getAttacks(config): Promise&lt;<a href="#attacklist">AttackList</a>&gt;</strong>
1311
+
1312
+ <div class="padding-left--md">
1313
+
1314
+ Lists all attacks
1315
+
1316
+ **Required scope:** environment-api:attacks:read
1317
+ **One of the following permissions is required:**
1318
+
1319
+ - environment:roles:manage-security-problems
1320
+ - environment:roles:view-security-problems
1321
+
1322
+ </div>
1323
+
1324
+ #### Parameters
1325
+
1326
+ | Name | Type | Description |
1327
+ | --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1328
+ | config.attackSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only attacks matching the specified criteria are included in the response. You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state(&quot;value&quot;)</code>. The state of the attack. Possible values are <code>EXPLOITED</code>, <code>BLOCKED</code>, and <code>ALLOWLISTED</code>.</li> <li>Attack Type: <code>attackType(&quot;value&quot;)</code>. The type of the attack. Find the possible values in the description of the <strong>attackType</strong> field of the response.</li> <li>Country Code: <code>countryCode(&quot;value&quot;)</code>. The country code of the attacker. Supported values include all ISO-3166-1 alpha-2 country codes (2-letter). Supplying empty filter value <code>countryCode()</code> will return attacks, where location is not available.</li> <li>Request path contains: <code>requestPathContains(&quot;value&quot;)</code>. Filters for a substring in the request path. The <code>CONTAINS</code> operator is used. A maximum of 48 characters are allowed.</li> <li>Process group name contains: <code>processGroupNameContains(&quot;value&quot;)</code>. Filters for a substring in the targeted process group's name. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerability ID: <code>vulnerabilityId(&quot;123456789&quot;)</code>. The exact ID of the vulnerability.</li> <li>Source IPs: <code>sourceIps(&quot;93.184.216.34&quot;, &quot;63.124.6.12&quot;)</code>. The exact IPv4/IPv6 addresses of the attacker.</li> <li>Management zone ID: <code>managementZoneIds(&quot;mzId-1&quot;, &quot;mzId-2&quot;)</code>.</li> <li>Management zone name: <code>managementZones(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case sensitive.</li> <li>Technology: <code>technology(&quot;technology-1&quot;, &quot;technology-2&quot;)</code>. Find the possible values in the description of the <strong>technology</strong> field of the response. The <code>EQUALS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching (<strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>&#126;</code>) inside quotes:</p> <ul> <li>Tilde <code>&#126;</code></li> <li>Quote <code>&quot;</code></li> </ul> |
1329
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional attack 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>attackTarget</code>: The targeted host/database of an attack.</li> <li><code>request</code>: The request that was sent from the attacker.</li> <li><code>entrypoint</code>: The entry point used by an attacker to start a specific attack.</li> <li><code>vulnerability</code>: The vulnerability utilized by the attack.</li> <li><code>securityProblem</code>: The related security problem.</li> <li><code>attacker</code>: The attacker of an attack.</li> <li><code>managementZones</code>: The related management zones.</li> <li><code>affectedEntities</code>: The affected entities of an attack.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+attackTarget,+securityProblem</code>).</p> |
1330
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of thirty days is used (<code>now-30d</code>).</p> |
1331
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
1332
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of attacks in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
1333
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the attack list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+state,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>displayId</code>: The attack's display ID.</li> <li><code>displayName</code>: The attack's display name.</li> <li><code>attackType</code>: The type of the attack (e.g. SQL_INJECTION, JNDI_INJECTION, etc.).</li> <li><code>state</code>: The state of the attack. (<code>+</code> low severity state first <code>-</code> high severity state first)</li> <li><code>sourceIp</code>: The IP address of the attacker. Sorts by the numerical IP value.</li> <li><code>requestPath</code>: The request path where the attack was started.</li> <li><code>timestamp</code>: When the attack was executed. (<code>+</code> old attacks first or <code>-</code> new attacks first) If no prefix is set, <code>+</code> is used.</li> </ul> |
1334
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
1335
+
1336
+ #### Returns
1337
+
1338
+ Success
1339
+
1340
+ <details>
1341
+ <summary>
1342
+ Code example
1343
+
1344
+ </summary>
1345
+
1346
+ ```ts
1347
+ import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
1348
+
1349
+ const data = await attacksClient.getAttacks();
1350
+ ```
1351
+
1352
+ </details>
1353
+
1354
+ </div>
1355
+
1257
1356
  ## auditLogsClient
1258
1357
 
1259
1358
  ```js
@@ -1368,6 +1467,8 @@ Ingests a business event
1368
1467
  **Required scope:** storage:events:write
1369
1468
  **Required permission:** storage:events:write
1370
1469
 
1470
+ The maximum payload size of a single request is **5 MiB**. Requests with a greater payload are rejected, and the API returns a 413 response code.
1471
+
1371
1472
  The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
1372
1473
 
1373
1474
  </div>
@@ -2024,14 +2125,14 @@ Lists events within the specified timeframe
2024
2125
 
2025
2126
  #### Parameters
2026
2127
 
2027
- | Name | Type | Description |
2028
- | --------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2029
- | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
2030
- | config.eventSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>ID of related entity: <code>entityId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Event status: <code>status(&quot;OPEN&quot;)</code> or <code>status(&quot;CLOSED&quot;)</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId(&quot;123&quot;, &quot;321&quot;)</code>.</li> <li>Event type: <code>eventType(&quot;event-type&quot;)</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">GET event types</a> call.</li> <li>Correlation ID: <code>correlationId(&quot;id-1&quot;, &quot;id-2&quot;)</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.&lt;key&gt;(&quot;value-1&quot;, &quot;value-2&quot;)</code>.</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> |
2031
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
2032
- | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
2033
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of events in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
2034
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
2128
+ | Name | Type | Description |
2129
+ | --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2130
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
2131
+ | config.eventSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>ID of related entity: <code>entityId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Event status: <code>status(&quot;OPEN&quot;)</code> or <code>status(&quot;CLOSED&quot;)</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId(&quot;123&quot;, &quot;321&quot;)</code>.</li> <li>Event type: <code>eventType(&quot;event-type&quot;)</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">GET event types</a> call.</li> <li>Correlation ID: <code>correlationId(&quot;id-1&quot;, &quot;id-2&quot;)</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.&lt;key&gt;(&quot;value-1&quot;, &quot;value-2&quot;)</code>.</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> |
2132
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
2133
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
2134
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of events in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
2135
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
2035
2136
 
2036
2137
  #### Returns
2037
2138
 
@@ -2244,7 +2345,7 @@ Executes Data Source action of Active Gate or Host
2244
2345
 
2245
2346
  #### Returns
2246
2347
 
2247
- Accepted. Response doesn&apos;t have a body.
2348
+ Accepted. Response doesn&amp;apos;t have a body.
2248
2349
 
2249
2350
  <details>
2250
2351
  <summary>
@@ -2335,7 +2436,7 @@ Gets details of the specified version of the extension 2.0
2335
2436
 
2336
2437
  | Name | Type | Description |
2337
2438
  | -------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------ |
2338
- | config.acceptType<sup>\*required</sup> | "application/octet-stream" &#124; "application/json; charset=utf-8" | |
2439
+ | config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | |
2339
2440
  | config.extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the requested extension 2.0. |
2340
2441
  | config.extensionVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the requested extension 2.0 |
2341
2442
 
@@ -2363,6 +2464,25 @@ const data = await extensions_2_0Client.extensionDetails({
2363
2464
 
2364
2465
  </div>
2365
2466
 
2467
+ <div class="padding-bottom--md">
2468
+ <strong>extensions_2_0Client.extensionDetails(config): Promise&lt;Binary&gt;</strong>
2469
+
2470
+ <div class="padding-left--md">
2471
+
2472
+ </div>
2473
+
2474
+ #### Parameters
2475
+
2476
+ | Name | Type | Description |
2477
+ | -------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------ |
2478
+ | config.acceptType<sup>\*required</sup> | "application/octet-stream" | |
2479
+ | config.extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the requested extension 2.0. |
2480
+ | config.extensionVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the requested extension 2.0 |
2481
+
2482
+ {/* no returns */}
2483
+
2484
+ </div>
2485
+
2366
2486
  ### extensionMonitoringConfigurations
2367
2487
 
2368
2488
  <div class="padding-bottom--md">
@@ -2952,7 +3072,7 @@ Lists all the files available for the specified extension 2.0 schema version
2952
3072
 
2953
3073
  | Name | Type | Description |
2954
3074
  | ----------------------------------------- | ----------------------------------------------------------------------------- | -------------------------- |
2955
- | config.acceptType<sup>\*required</sup> | "application/octet-stream" &#124; "application/json; charset=utf-8" | |
3075
+ | config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | |
2956
3076
  | config.schemaVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema. |
2957
3077
 
2958
3078
  #### Returns
@@ -2978,6 +3098,24 @@ const data = await extensions_2_0Client.listSchemaFiles({
2978
3098
 
2979
3099
  </div>
2980
3100
 
3101
+ <div class="padding-bottom--md">
3102
+ <strong>extensions_2_0Client.listSchemaFiles(config): Promise&lt;Binary&gt;</strong>
3103
+
3104
+ <div class="padding-left--md">
3105
+
3106
+ </div>
3107
+
3108
+ #### Parameters
3109
+
3110
+ | Name | Type | Description |
3111
+ | ----------------------------------------- | ----------------------------------------------------------------------------- | -------------------------- |
3112
+ | config.acceptType<sup>\*required</sup> | "application/octet-stream" | |
3113
+ | config.schemaVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema. |
3114
+
3115
+ {/* no returns */}
3116
+
3117
+ </div>
3118
+
2981
3119
  ### listSchemas
2982
3120
 
2983
3121
  <div class="padding-bottom--md">
@@ -3315,7 +3453,10 @@ import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
3315
3453
  Exports log records | maturity=EARLY_ADOPTER
3316
3454
 
3317
3455
  **Required scope:** storage:logs:read
3318
- **Required permission:** environment:roles:logviewer
3456
+ **One of the following permissions is required:**
3457
+
3458
+ - environment:roles:logviewer
3459
+ - storage:logs:read
3319
3460
 
3320
3461
  Returns the first _X_ records (specified in the **pageSize** query parameter).
3321
3462
 
@@ -3368,7 +3509,10 @@ const data = await logsClient.exportLogRecords();
3368
3509
  Gets aggregated log records | maturity=EARLY_ADOPTER
3369
3510
 
3370
3511
  **Required scope:** storage:logs:read
3371
- **Required permission:** environment:roles:logviewer
3512
+ **One of the following permissions is required:**
3513
+
3514
+ - environment:roles:logviewer
3515
+ - storage:logs:read
3372
3516
 
3373
3517
  Returns the aggregated number of occurrences of log values divided into time slots.
3374
3518
 
@@ -3421,7 +3565,10 @@ const data = await logsClient.getLogHistogramData();
3421
3565
  Reads log records | maturity=EARLY_ADOPTER
3422
3566
 
3423
3567
  **Required scope:** storage:logs:read
3424
- **Required permission:** environment:roles:logviewer
3568
+ **One of the following permissions is required:**
3569
+
3570
+ - environment:roles:logviewer
3571
+ - storage:logs:read
3425
3572
 
3426
3573
  Returns the first _X_ records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
3427
3574
 
@@ -3512,7 +3659,7 @@ Refresh cluster limit using Cluster Management Console (CMC)
3512
3659
 
3513
3660
  **High-cardinality attributes:**
3514
3661
 
3515
- Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
3662
+ Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren&apos;t listed in log viewer facets. You can still use them in a log viewer advanced search query.
3516
3663
 
3517
3664
  </div>
3518
3665
 
@@ -3636,7 +3783,7 @@ Deletes the specified metric
3636
3783
  **Required scope:** environment-api:metrics:write
3637
3784
  **Required permission:** environment:roles:manage-settings
3638
3785
 
3639
- Deletion cannot be undone! You can't delete a metric if it has data points ingested within the last two hours.
3786
+ Deletion cannot be undone! You can&apos;t delete a metric if it has data points ingested within the last two hours.
3640
3787
 
3641
3788
  </div>
3642
3789
 
@@ -3778,15 +3925,15 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
3778
3925
 
3779
3926
  #### Parameters
3780
3927
 
3781
- | Name | Type | Description |
3782
- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3783
- | config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" &#124; "text/csv; header=absent; charset=utf-8" &#124; "text/csv; header=present; charset=utf-8" | |
3784
- | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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"><code>GET /metrics/&#123;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> |
3785
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
3786
- | config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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>&quot;</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>&#126;</code>):</p> <ul> <li>Quotes (<code>&quot;</code>)</li> <li>Tildes (<code>&#126;</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type &quot;APACHE&quot;</strong> you must specify this selector:</p> <p><code>&quot;ext:selfmonitoring.jmx.Agents: Type &#126;&quot;APACHE&#126;&quot;&quot;</code></p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector">Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> |
3787
- | config.mzSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;name-1&quot;,&quot;name-2&quot;)</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName(&quot;name-1&quot;,&quot;name-2&quot;),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(&quot;name-1&quot;,&quot;name-2&quot;).</li> </ul> |
3788
- | config.resolution | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The desired resolution of data points.</p> <p>You can use one of the following options:</p> <ul> <li>The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points.</li> <li>The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan.</li> </ul> <p>Valid units for the timespan are:</p> <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>q</code>: quarters</li> <li><code>y</code>: years</li> </ul> <p>If not set, the default is <strong>120 data points</strong>.</p> <p>For example:</p> <ul> <li>Get data points which are 10 minutes apart: <code>resolution=10m</code></li> <li>Get data points which are 3 weeks apart: <code>resolution=3w</code></li> </ul> |
3789
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
3928
+ | Name | Type | Description |
3929
+ | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3930
+ | config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" &#124; "text/csv; header=absent; charset=utf-8" &#124; "text/csv; header=present; charset=utf-8" | |
3931
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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"><code>GET /metrics/\\&#123;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> |
3932
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
3933
+ | config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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>&quot;</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>&#126;</code>):</p> <ul> <li>Quotes (<code>&quot;</code>)</li> <li>Tildes (<code>&#126;</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type &quot;APACHE&quot;</strong> you must specify this selector:</p> <p><code>&quot;ext:selfmonitoring.jmx.Agents: Type &#126;&quot;APACHE&#126;&quot;&quot;</code></p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector">Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> |
3934
+ | config.mzSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;name-1&quot;,&quot;name-2&quot;)</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName(&quot;name-1&quot;,&quot;name-2&quot;),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(&quot;name-1&quot;,&quot;name-2&quot;).</li> </ul> |
3935
+ | config.resolution | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The desired resolution of data points.</p> <p>You can use one of the following options:</p> <ul> <li>The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points.</li> <li>The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan.</li> </ul> <p>Valid units for the timespan are:</p> <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>q</code>: quarters</li> <li><code>y</code>: years</li> </ul> <p>If not set, the default is <strong>120 data points</strong>.</p> <p>For example:</p> <ul> <li>Get data points which are 10 minutes apart: <code>resolution=10m</code></li> <li>Get data points which are 3 weeks apart: <code>resolution=3w</code></li> </ul> |
3936
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
3790
3937
 
3791
3938
  #### Returns
3792
3939
 
@@ -3955,6 +4102,53 @@ const data = await metricsUnitsClient.unit({
3955
4102
  import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
3956
4103
  ```
3957
4104
 
4105
+ ### deleteSecurityContext
4106
+
4107
+ <div class="padding-bottom--md">
4108
+ <strong>monitoredEntitiesClient.deleteSecurityContext(config): Promise&lt;<a href="#securitycontextresultdto">SecurityContextResultDto</a>&gt;</strong>
4109
+
4110
+ <div class="padding-left--md">
4111
+
4112
+ Deletes the security context for all entities matching the entity selector.
4113
+
4114
+ **Required scope:** settings:objects:write
4115
+ **One of the following permissions is required:**
4116
+
4117
+ - environment:roles:manage-settings
4118
+ - settings:objects:write
4119
+
4120
+ Automatic management zone rules will apply again to entities without a security context.
4121
+
4122
+ </div>
4123
+
4124
+ #### Parameters
4125
+
4126
+ | Name | Type | Description |
4127
+ | --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4128
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4129
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
4130
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4131
+
4132
+ #### Returns
4133
+
4134
+ Success
4135
+
4136
+ <details>
4137
+ <summary>
4138
+ Code example
4139
+
4140
+ </summary>
4141
+
4142
+ ```ts
4143
+ import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
4144
+
4145
+ const data = await monitoredEntitiesClient.deleteSecurityContext();
4146
+ ```
4147
+
4148
+ </details>
4149
+
4150
+ </div>
4151
+
3958
4152
  ### getEntities
3959
4153
 
3960
4154
  <div class="padding-bottom--md">
@@ -3984,15 +4178,15 @@ You can limit the output by using pagination:
3984
4178
 
3985
4179
  #### Parameters
3986
4180
 
3987
- | Name | Type | Description |
3988
- | --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3989
- | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
3990
- | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
3991
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
3992
- | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
3993
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of entities.</p> <p>If not set, 50 is used.</p> |
3994
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the entities returned.</p> <p>This field is <strong>optional</strong>, each field has a sign prefix (+/-), which corresponds to sorting order ( + for ascending and - for descending). If no sign prefix is set, then default ascending sorting order will be applied.</p> <p>Currently ordering is only available for the display name (for example <code>sort=name or sort =+name for ascending, sort=-name for descending</code>)</p> |
3995
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4181
+ | Name | Type | Description |
4182
+ | --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4183
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4184
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
4185
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
4186
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
4187
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of entities.</p> <p>If not set, 50 is used.</p> |
4188
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the entities returned.</p> <p>This field is <strong>optional</strong>, each field has a sign prefix (+/-), which corresponds to sorting order ( + for ascending and - for descending). If no sign prefix is set, then default ascending sorting order will be applied.</p> <p>Currently ordering is only available for the display name (for example <code>sort=name or sort =+name for ascending, sort=-name for descending</code>)</p> |
4189
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
3996
4190
 
3997
4191
  #### Returns
3998
4192
 
@@ -4189,6 +4383,58 @@ const data = await monitoredEntitiesClient.pushCustomDevice({
4189
4383
 
4190
4384
  </div>
4191
4385
 
4386
+ ### setSecurityContext
4387
+
4388
+ <div class="padding-bottom--md">
4389
+ <strong>monitoredEntitiesClient.setSecurityContext(config): Promise&lt;<a href="#securitycontextresultdto">SecurityContextResultDto</a>&gt;</strong>
4390
+
4391
+ <div class="padding-left--md">
4392
+
4393
+ Sets the given security context for all entities matching the entity selector.
4394
+
4395
+ **Required scope:** settings:objects:write
4396
+ **One of the following permissions is required:**
4397
+
4398
+ - environment:roles:manage-settings
4399
+ - settings:objects:write
4400
+
4401
+ Matching entities will have a management zone assigned, if the given security context matches the name of an already existing management zone.
4402
+ This endpoint does not create a new management zone, if there is no management zone with the provided name.
4403
+ Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.
4404
+
4405
+ </div>
4406
+
4407
+ #### Parameters
4408
+
4409
+ | Name | Type | Description |
4410
+ | -------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4411
+ | config.body<sup>\*required</sup> | <a href="#securitycontextdtoimpl">SecurityContextDtoImpl</a> | |
4412
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4413
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
4414
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4415
+
4416
+ #### Returns
4417
+
4418
+ Success
4419
+
4420
+ <details>
4421
+ <summary>
4422
+ Code example
4423
+
4424
+ </summary>
4425
+
4426
+ ```ts
4427
+ import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
4428
+
4429
+ const data = await monitoredEntitiesClient.setSecurityContext({
4430
+ body: {},
4431
+ });
4432
+ ```
4433
+
4434
+ </details>
4435
+
4436
+ </div>
4437
+
4192
4438
  ## monitoredEntitiesCustomTagsClient
4193
4439
 
4194
4440
  ```js
@@ -4211,14 +4457,14 @@ Deletes the specified tag from the specified entities
4211
4457
 
4212
4458
  #### Parameters
4213
4459
 
4214
- | Name | Type | Description |
4215
- | ------------------------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4216
- | config.deleteAllWithKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <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> |
4217
- | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
4218
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4219
- | config.key<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
4220
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4221
- | config.value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The value of the tag to be deleted. The value is ignored if <strong>deleteAllWithKey</strong> is <code>true</code>.</p> <p>For value-only tags, specify the value in the <strong>key</strong> parameter.</p> |
4460
+ | Name | Type | Description |
4461
+ | ------------------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4462
+ | config.deleteAllWithKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <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> |
4463
+ | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4464
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4465
+ | config.key<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
4466
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4467
+ | config.value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The value of the tag to be deleted. The value is ignored if <strong>deleteAllWithKey</strong> is <code>true</code>.</p> <p>For value-only tags, specify the value in the <strong>key</strong> parameter.</p> |
4222
4468
 
4223
4469
  #### Returns
4224
4470
 
@@ -4261,11 +4507,11 @@ Automatically applied tags and imported tags are not included.
4261
4507
 
4262
4508
  #### Parameters
4263
4509
 
4264
- | Name | Type | Description |
4265
- | ------------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4266
- | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
4267
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4268
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4510
+ | Name | Type | Description |
4511
+ | ------------------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4512
+ | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4513
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4514
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4269
4515
 
4270
4516
  #### Returns
4271
4517
 
@@ -4307,12 +4553,12 @@ All existing tags remain unaffected.
4307
4553
 
4308
4554
  #### Parameters
4309
4555
 
4310
- | Name | Type | Description |
4311
- | ------------------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4312
- | config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> | |
4313
- | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
4314
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4315
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4556
+ | Name | Type | Description |
4557
+ | ------------------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4558
+ | config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> | |
4559
+ | config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4560
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
4561
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4316
4562
 
4317
4563
  #### Returns
4318
4564
 
@@ -4361,11 +4607,11 @@ Only process group instances are supported.
4361
4607
 
4362
4608
  #### Parameters
4363
4609
 
4364
- | Name | Type | Description |
4365
- | --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4366
- | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
4367
- | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
4368
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
4610
+ | Name | Type | Description |
4611
+ | --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4612
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
4613
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
4614
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
4369
4615
 
4370
4616
  #### Returns
4371
4617
 
@@ -4698,7 +4944,7 @@ import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
4698
4944
  Closes the specified problem and adds a closing comment on it
4699
4945
 
4700
4946
  **Required scope:** environment-api:problems:write
4701
- **Required permission:** environment:roles:manage-settings
4947
+ **Required permission:** environment:roles:viewer
4702
4948
 
4703
4949
  </div>
4704
4950
 
@@ -4963,16 +5209,16 @@ Lists problems observed within the specified timeframe
4963
5209
 
4964
5210
  #### Parameters
4965
5211
 
4966
- | Name | Type | Description |
4967
- | ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4968
- | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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">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">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">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> |
4969
- | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
4970
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
4971
- | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
4972
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <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> |
4973
- | config.problemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;open&quot;)</code> or <code>status(&quot;closed&quot;)</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel(&quot;level-1&quot;,&quot;level-2&quot;)</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel(&quot;level-11&quot;,&quot;level-2&quot;)</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Management zone ID: <code>managementZoneIds(&quot;mZId-1&quot;, &quot;mzId-2&quot;)</code>.</li> <li>Management zone name: <code>managementZones(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Impacted entities: <code>impactedEntities(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Affected entities: <code>affectedEntities(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Problem ID: <code>problemId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Alerting profile ID: <code>problemFilterIds(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Entity tags: <code>entityTags(&quot;[context]key:value&quot;,&quot;key:value&quot;)</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&#124;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>&#126;</code> and <code>&quot;</code> need to be escaped using a <code>&#126;</code> (e.g. double quote search <code>text(&quot;&#126;&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> |
4974
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
4975
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
5212
+ | Name | Type | Description |
5213
+ | ---------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5214
+ | config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type(&quot;TYPE&quot;)</code></li> <li>Dynatrace entity ID: <code>entityId(&quot;id&quot;)</code>. You can specify several IDs, separated by a comma (<code>entityId(&quot;id-1&quot;,&quot;id-2&quot;)</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(&quot;value&quot;)</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(&amp;quot;value&amp;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(&amp;quot;value&amp;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(&amp;quot;HEALTHY&amp;quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&amp;lt;operator&amp;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>&amp;lt;attribute&amp;gt;(&amp;quot;value1&amp;quot;,&amp;quot;value2&amp;quot;)</code> and <code>&amp;lt;attribute&amp;gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&amp;lt;relationshipName&amp;gt;()</code> and <code>toRelationships.&amp;lt;relationshipName&amp;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">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&amp;lt;criterion&amp;gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&amp;quot;HOST&amp;quot;),healthState(&amp;quot;HEALTHY&amp;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> |
5215
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
5216
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
5217
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
5218
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <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> |
5219
+ | config.problemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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(&quot;open&quot;)</code> or <code>status(&quot;closed&quot;)</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel(&quot;level-1&quot;,&quot;level-2&quot;)</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel(&quot;level-11&quot;,&quot;level-2&quot;)</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Management zone ID: <code>managementZoneIds(&quot;mZId-1&quot;, &quot;mzId-2&quot;)</code>.</li> <li>Management zone name: <code>managementZones(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Impacted entities: <code>impactedEntities(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Affected entities: <code>affectedEntities(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Problem ID: <code>problemId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Alerting profile ID: <code>problemFilterIds(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals(&quot;value-1&quot;,&quot;value-2&quot;)</code>.</li> <li>Entity tags: <code>entityTags(&quot;[context]key:value&quot;,&quot;key:value&quot;)</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(&amp;quot;id-1&amp;quot;, &amp;quot;id-2&amp;quot;)</code>.</li> <li>Under maintenance: <code>underMaintenance(true&#124;false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text(&amp;quot;value&amp;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>\\&#126;</code> and <code>&amp;quot;</code> need to be escaped using a <code>\\&#126;</code> (e.g. double quote search <code>text(&amp;quot;\\&#126;&amp;quot;&amp;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> |
5220
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> |
5221
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
4976
5222
 
4977
5223
  #### Returns
4978
5224
 
@@ -5931,7 +6177,7 @@ Lists all available SLOs along with calculated values
5931
6177
  - environment:roles:viewer
5932
6178
  - settings:objects:read
5933
6179
 
5934
- By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
6180
+ By default the values are calculated for the SLO&apos;s own timeframe. You can use a custom timeframe:
5935
6181
 
5936
6182
  1. Set the **timeFrame** parameter to `GTF`.
5937
6183
  2. Provide the timeframe in **from** and **to** parameters.
@@ -5989,7 +6235,7 @@ Gets parameters and calculated values of a specific SLO
5989
6235
  - environment:roles:viewer
5990
6236
  - settings:objects:read
5991
6237
 
5992
- If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
6238
+ If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO&apos;s own timeframe is used.
5993
6239
 
5994
6240
  </div>
5995
6241
 
@@ -6247,16 +6493,16 @@ To query the effective values (including schema defaults) please see /settings/e
6247
6493
 
6248
6494
  #### Parameters
6249
6495
 
6250
- | Name | Type | Description |
6251
- | ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6252
- | config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
6253
- | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"objectId,value"</code> |
6254
- | config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 512.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
6255
- | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
6256
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
6257
- | config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>scopes</strong> is required.</p> <p>To load all objects belonging to the given schema IDs leave the <strong>scopes</strong> parameter empty.</p> |
6258
- | config.scopes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated scopes, that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scopes. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>schemaIds</strong> is required.</p> <p>To load all objects belonging to the given scopes leave the <strong>schemaIds</strong> parameter empty.</p> |
6259
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Sorting is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp</code>)</li> </ul> <p>Note that only fields included to the response via <code>fields</code> can be used for sorting.</p> |
6496
+ | Name | Type | Description |
6497
+ | ------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6498
+ | config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
6499
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"objectId,value"</code> |
6500
+ | config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code> (deprecated, will not work for future schemas)</li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1000 characters.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
6501
+ | config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
6502
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
6503
+ | config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>scopes</strong> is required.</p> <p>To load all objects belonging to the given schema IDs leave the <strong>scopes</strong> parameter empty.</p> |
6504
+ | config.scopes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated scopes, that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scopes. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>schemaIds</strong> is required.</p> <p>To load all objects belonging to the given scopes leave the <strong>schemaIds</strong> parameter empty.</p> |
6505
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Sorting is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code> (deprecated, will not work for future schemas)</li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp</code>)</li> </ul> <p>Note that only fields included to the response via <code>fields</code> can be used for sorting.</p> |
6260
6506
 
6261
6507
  #### Returns
6262
6508
 
@@ -6348,7 +6594,7 @@ Updates an existing settings object
6348
6594
 
6349
6595
  To update a property of the `secret` type you need to pass the new value unmasked. To keep the current value, send the current masked secret. You can obtain it via [GET an object](https://dt-url.net/kj036oj) endpoint.
6350
6596
 
6351
- Some schemas don't allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.
6597
+ Some schemas don&apos;t allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.
6352
6598
 
6353
6599
  </div>
6354
6600
 
@@ -7004,7 +7250,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
7004
7250
 
7005
7251
  #### Returns
7006
7252
 
7007
- Success. The set of synthetic related parameters has been updated. Response doesn&apos;t have a body.
7253
+ Success. The set of synthetic related parameters has been updated. Response doesn&amp;apos;t have a body.
7008
7254
 
7009
7255
  <details>
7010
7256
  <summary>
@@ -7253,9 +7499,9 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
7253
7499
 
7254
7500
  #### Parameters
7255
7501
 
7256
- | Name | Type | Description |
7257
- | --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
7258
- | config.managementZone | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>Filters the resulting set of monitors to those which are part of the specified management zone.</p> <p>Specify the ID of the management zone here.</p> |
7502
+ | Name | Type | Description |
7503
+ | ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
7504
+ | config.monitorSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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 activity: <code>active(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> |
7259
7505
 
7260
7506
  #### Returns
7261
7507
 
@@ -7346,7 +7592,7 @@ Triggers on-demand executions for synthetic monitors
7346
7592
 
7347
7593
  #### Returns
7348
7594
 
7349
- Success. The monitor&apos;s execution response details
7595
+ Success. The monitor&amp;apos;s execution response details
7350
7596
 
7351
7597
  <details>
7352
7598
  <summary>
@@ -7757,6 +8003,24 @@ A list of custom tags added to monitored entities.
7757
8003
  | appliedTags | Array&lt;<a href="#metag">METag</a>&gt; | A list of added custom tags. |
7758
8004
  | matchedEntitiesCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of monitored entities where the tags have been added. |
7759
8005
 
8006
+ ### AffectedEntities
8007
+
8008
+ Information about affected entities of an attack.
8009
+
8010
+ | Name | Type |
8011
+ | -------------------- | -------------------------------------------- |
8012
+ | processGroup | <a href="#affectedentity">AffectedEntity</a> |
8013
+ | processGroupInstance | <a href="#affectedentity">AffectedEntity</a> |
8014
+
8015
+ ### AffectedEntity
8016
+
8017
+ Information about an affected entity.
8018
+
8019
+ | Name | Type | Description |
8020
+ | ---- | ----------------------------------------------------------------------------- | ----------------------------------------------- |
8021
+ | id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitored entity ID of the affected entity. |
8022
+ | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the affected entity. |
8023
+
7760
8024
  ### AggregatedLog
7761
8025
 
7762
8026
  Aggregated log records.
@@ -7894,6 +8158,114 @@ Settings schema details for asset
7894
8158
  | schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Asset schema id |
7895
8159
  | scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Asset configuration scope |
7896
8160
 
8161
+ ### Attack
8162
+
8163
+ Describes an attack.
8164
+
8165
+ | Name | Type | Description |
8166
+ | ---------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------- |
8167
+ | affectedEntities | <a href="#affectedentities">AffectedEntities</a> | |
8168
+ | attackId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the attack. |
8169
+ | attackTarget | <a href="#attacktarget">AttackTarget</a> | |
8170
+ | attackType | AttackAttackType | |
8171
+ | attacker | <a href="#attacker">Attacker</a> | |
8172
+ | displayId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display ID of the attack. |
8173
+ | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the attack. |
8174
+ | entrypoint | <a href="#attackentrypoint">AttackEntrypoint</a> | |
8175
+ | managementZones | Array&lt;<a href="#managementzone">ManagementZone</a>&gt; | A list of management zones which the affected entities belong to. |
8176
+ | request | <a href="#requestinformation">RequestInformation</a> | |
8177
+ | securityProblem | <a href="#attacksecurityproblem">AttackSecurityProblem</a> | |
8178
+ | state | AttackState | |
8179
+ | technology | AttackTechnology | |
8180
+ | timestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when the attack occurred. |
8181
+ | vulnerability | <a href="#vulnerability">Vulnerability</a> | |
8182
+
8183
+ ### AttackEntrypoint
8184
+
8185
+ Describes the entrypoint used by an attacker to start a specific attack.
8186
+
8187
+ | Name | Type | Description |
8188
+ | ------------------ | ----------------------------------------------------------------------------------- | --------------------------------------------------------------- |
8189
+ | codeLocation | <a href="#codelocation">CodeLocation</a> | |
8190
+ | entrypointFunction | <a href="#functiondefinition">FunctionDefinition</a> | |
8191
+ | payload | Array&lt;<a href="#attackentrypointpayloaditem">AttackEntrypointPayloadItem</a>&gt; | All relevant payload data that has been sent during the attack. |
8192
+
8193
+ ### AttackEntrypointPayloadItem
8194
+
8195
+ A list of values that has possibly been truncated.
8196
+
8197
+ | Name | Type | Description |
8198
+ | -------------- | --------------------------------------------------------------- | ------------------- |
8199
+ | truncationInfo | <a href="#truncationinfo">TruncationInfo</a> | |
8200
+ | values | Array&lt;<a href="#entrypointpayload">EntrypointPayload</a>&gt; | Values of the list. |
8201
+
8202
+ ### AttackList
8203
+
8204
+ A list of attacks.
8205
+
8206
+ | Name | Type | Description |
8207
+ | ------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8208
+ | attacks | Array&lt;<a href="#attack">Attack</a>&gt; | A list of attacks. |
8209
+ | nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
8210
+ | pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of entries per page. |
8211
+ | totalCount<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of entries in the result. |
8212
+
8213
+ ### AttackRequestHeader
8214
+
8215
+ A header element of the attack&apos;s request.
8216
+
8217
+ | Name | Type | Description |
8218
+ | ----- | ----------------------------------------------------------------------------- | -------------------------------- |
8219
+ | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the header element. |
8220
+ | value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the header element. |
8221
+
8222
+ ### AttackSecurityProblem
8223
+
8224
+ Assessment information and the ID of a security problem related to an attack.
8225
+
8226
+ | Name | Type | Description |
8227
+ | ----------------- | ------------------------------------------------------------------------------------ | ------------------------ |
8228
+ | assessment | <a href="#attacksecurityproblemassessmentdto">AttackSecurityProblemAssessmentDto</a> | |
8229
+ | securityProblemId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The security problem ID. |
8230
+
8231
+ ### AttackSecurityProblemAssessmentDto
8232
+
8233
+ The assessment of a security problem related to an attack.
8234
+
8235
+ | Name | Type | Description |
8236
+ | --------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------- |
8237
+ | dataAssets | AttackSecurityProblemAssessmentDtoDataAssets | |
8238
+ | exposure | AttackSecurityProblemAssessmentDtoExposure | |
8239
+ | numberOfReachableDataAssets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of data assets reachable by the attacked target. |
8240
+
8241
+ ### AttackTarget
8242
+
8243
+ Information about the targeted host/database of an attack.
8244
+
8245
+ | Name | Type | Description |
8246
+ | -------- | ----------------------------------------------------------------------------- | ------------------------------------------------------ |
8247
+ | entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitored entity ID of the targeted host/database. |
8248
+ | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the targeted host/database. |
8249
+
8250
+ ### Attacker
8251
+
8252
+ Attacker of an attack.
8253
+
8254
+ | Name | Type | Description |
8255
+ | -------- | ----------------------------------------------------------------------------- | ------------------------------ |
8256
+ | location | <a href="#attackerlocation">AttackerLocation</a> | |
8257
+ | sourceIp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The source IP of the attacker. |
8258
+
8259
+ ### AttackerLocation
8260
+
8261
+ Location of an attacker.
8262
+
8263
+ | Name | Type | Description |
8264
+ | ----------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
8265
+ | city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | City of the attacker. |
8266
+ | country | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The country of the attacker. |
8267
+ | countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The country code of the country of the attacker, according to the ISO 3166-1 Alpha-2 standard. |
8268
+
7897
8269
  ### AuditLog
7898
8270
 
7899
8271
  The audit log of your environment.
@@ -8109,6 +8481,21 @@ The details of a code-level vulnerability.
8109
8481
  | vulnerableFunction | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The vulnerable function of the vulnerability. |
8110
8482
  | vulnerableFunctionInput | <a href="#vulnerablefunctioninput">VulnerableFunctionInput</a> | |
8111
8483
 
8484
+ ### CodeLocation
8485
+
8486
+ Information about a code location.
8487
+
8488
+ | Name | Type | Description |
8489
+ | -------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------ |
8490
+ | className | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The fully qualified class name of the code location. |
8491
+ | columnNumber | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The column number of the code location. |
8492
+ | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A human readable string representation of the code location. |
8493
+ | fileName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The file name of the code location. |
8494
+ | functionName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The function/method name of the code location. |
8495
+ | lineNumber | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The line number of the code location. |
8496
+ | parameterTypes | <a href="#truncatableliststring">TruncatableListString</a> | |
8497
+ | returnType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The return type of the function. |
8498
+
8112
8499
  ### Comment
8113
8500
 
8114
8501
  The comment to a problem.
@@ -8201,7 +8588,7 @@ The set of entities allowed to use the credential.
8201
8588
 
8202
8589
  ### CredentialUsageHandler
8203
8590
 
8204
- Keeps information about credential's usage.
8591
+ Keeps information about credential&apos;s usage.
8205
8592
 
8206
8593
  | Name | Type | Description |
8207
8594
  | ----- | ----------------------------------------------------------------------------- | ------------------- |
@@ -8683,6 +9070,16 @@ A list of entry points and a flag which indicates whether this list was truncate
8683
9070
  | items | Array&lt;<a href="#entrypoint">EntryPoint</a>&gt; | A list of entry points. |
8684
9071
  | truncated | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Indicates whether the list of entry points was truncated or not. |
8685
9072
 
9073
+ ### EntrypointPayload
9074
+
9075
+ Describes a payload sent to an entrypoint during an attack.
9076
+
9077
+ | Name | Type | Description |
9078
+ | ----- | ----------------------------------------------------------------------------------------- | ----------------------------------- |
9079
+ | name | null &#124; <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Name of the payload, if applicable. |
9080
+ | type | EntrypointPayloadType | |
9081
+ | value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Value of the payload. |
9082
+
8686
9083
  ### EnumType
8687
9084
 
8688
9085
  Definition of an enum property.
@@ -8908,13 +9305,13 @@ Data Source defined action objects
8908
9305
 
8909
9306
  ### ExecuteActionsResponse
8910
9307
 
8911
- | Name | Type | Description |
8912
- | ---- | ----------------------------------------------------------------------------- | -------------------- |
8913
- | code | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP Status code |
9308
+ | Name | Type | Description |
9309
+ | ------ | ----------------------------------------------------------------------------- | -------------------------------------- |
9310
+ | agName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Active Gate name for actions execution |
8914
9311
 
8915
9312
  ### ExecutionFullResults
8916
9313
 
8917
- Contains extended monitor's execution details.
9314
+ Contains extended monitor&apos;s execution details.
8918
9315
 
8919
9316
  | Name | Type | Description |
8920
9317
  | -------------------- | ----------------------------------------------------------------------------- | ------------------------------------------- |
@@ -8928,7 +9325,7 @@ Contains extended monitor's execution details.
8928
9325
 
8929
9326
  ### ExecutionSimpleResults
8930
9327
 
8931
- Contains basic results of the monitor's on-demand execution.
9328
+ Contains basic results of the monitor&apos;s on-demand execution.
8932
9329
 
8933
9330
  | Name | Type | Description |
8934
9331
  | ----------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
@@ -8955,7 +9352,7 @@ Contains basic results of the monitor's on-demand execution.
8955
9352
 
8956
9353
  ### ExecutionStep
8957
9354
 
8958
- Contains detailed information about the monitor's step execution.
9355
+ Contains detailed information about the monitor&apos;s step execution.
8959
9356
 
8960
9357
  | Name | Type |
8961
9358
  | -------------------------------- | ------------------------ |
@@ -8991,12 +9388,12 @@ A list of exported log records.
8991
9388
 
8992
9389
  List of assets imported with the active extension environment configuration.
8993
9390
 
8994
- | Name | Type | Description |
8995
- | ---------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------- |
8996
- | assets<sup>\*required</sup> | Array&lt;<a href="#assetinfodto">AssetInfoDto</a>&gt; | The list of the imported assets. |
8997
- | errors<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | List of errors during asset import |
8998
- | status<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The status of the assets list. |
8999
- | version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension version |
9391
+ | Name | Type | Description |
9392
+ | ---------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
9393
+ | assets<sup>\*required</sup> | Array&lt;<a href="#assetinfodto">AssetInfoDto</a>&gt; | The list of the imported assets. |
9394
+ | errors<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | List of errors during asset import |
9395
+ | status<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The status of the assets list. |
9396
+ | version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Version of the active extension environment configuration. |
9000
9397
 
9001
9398
  ### ExtensionEnvironmentConfigurationVersion
9002
9399
 
@@ -9032,11 +9429,12 @@ Details of feature sets
9032
9429
 
9033
9430
  A list of extensions with additional metadata.
9034
9431
 
9035
- | Name | Type | Description |
9036
- | ---------------------------------- | ------------------------------------------------------------------------------------------ | ------------------ |
9037
- | extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension name |
9038
- | keywords<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | Extension keywords |
9039
- | version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension version |
9432
+ | Name | Type | Description |
9433
+ | ---------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
9434
+ | activeVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Active version in the environment (null if none is active) |
9435
+ | extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension name |
9436
+ | keywords<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | Extension keywords for the highest version |
9437
+ | version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Highest installed version |
9040
9438
 
9041
9439
  ### ExtensionInfoList
9042
9440
 
@@ -9152,7 +9550,7 @@ A dimensional or series filter on a metric.
9152
9550
 
9153
9551
  ### FilteredCountsDto
9154
9552
 
9155
- Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.
9553
+ Statistics about the security problem, filtered by the management zone and timeframe start (&apos;from&apos;) query parameters.
9156
9554
 
9157
9555
  | Name | Type | Description |
9158
9556
  | ----------------------------- | ----------------------------------------------------------------------------- | -------------------------------------- |
@@ -9179,6 +9577,19 @@ The FROM position of a relationship.
9179
9577
  | fromTypes | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | A list of monitored entity types that can occupy the FROM position. |
9180
9578
  | id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the relationship. |
9181
9579
 
9580
+ ### FunctionDefinition
9581
+
9582
+ Information about a function definition.
9583
+
9584
+ | Name | Type | Description |
9585
+ | -------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
9586
+ | className | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The fully qualified class name of the class that includes the function. |
9587
+ | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A human readable string representation of the function definition. |
9588
+ | fileName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The file name of the function definition. |
9589
+ | functionName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The function/method name of the function definition. |
9590
+ | parameterTypes | <a href="#truncatableliststring">TruncatableListString</a> | |
9591
+ | returnType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The return type of the function. |
9592
+
9182
9593
  ### GlobalCountsDto
9183
9594
 
9184
9595
  Globally calculated statistics about the security problem. No management zone information is taken into account.
@@ -9264,6 +9675,25 @@ Configuration for external vault synchronization for username and password crede
9264
9675
  | usernameSecretName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
9265
9676
  | vaultUrl | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
9266
9677
 
9678
+ ### HttpProtocolDetails
9679
+
9680
+ HTTP specific request details.
9681
+
9682
+ | Name | Type | Description |
9683
+ | ------------- | -------------------------------------------------------------------------------------- | ------------------------ |
9684
+ | headers | <a href="#truncatablelistattackrequestheader">TruncatableListAttackRequestHeader</a> | |
9685
+ | parameters | <a href="#truncatablelisthttprequestparameter">TruncatableListHttpRequestParameter</a> | |
9686
+ | requestMethod | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The HTTP request method. |
9687
+
9688
+ ### HttpRequestParameter
9689
+
9690
+ An HTTP request parameter.
9691
+
9692
+ | Name | Type | Description |
9693
+ | ----- | ----------------------------------------------------------------------------- | --------------------------- |
9694
+ | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the parameter. |
9695
+ | value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the parameter. |
9696
+
9267
9697
  ### Impact
9268
9698
 
9269
9699
  The impact analysis of the problem on other entities/users.
@@ -9360,7 +9790,7 @@ A synthetic location.
9360
9790
 
9361
9791
  ### LocationExecutionResults
9362
9792
 
9363
- Results of the execution HTTP monitor's requests at a given location
9793
+ Results of the execution HTTP monitor&apos;s requests at a given location
9364
9794
 
9365
9795
  | Name | Type | Description |
9366
9796
  | -------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
@@ -9643,7 +10073,7 @@ A DTO for monitor entity ID.
9643
10073
 
9644
10074
  ### MonitorExecutionResults
9645
10075
 
9646
- Results of the execution of all HTTP monitor's requests.
10076
+ Results of the execution of all HTTP monitor&apos;s requests.
9647
10077
 
9648
10078
  | Name | Type | Description |
9649
10079
  | ------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
@@ -9652,10 +10082,11 @@ Results of the execution of all HTTP monitor's requests.
9652
10082
 
9653
10083
  ### MonitorRequestExecutionResult
9654
10084
 
9655
- A result of the execution HTTP monitor's request.
10085
+ A result of the execution HTTP monitor&apos;s request.
9656
10086
 
9657
10087
  | Name | Type | Description |
9658
10088
  | -------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
10089
+ | cloudPlatform | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Cloud platform of the location. |
9659
10090
  | customLogs | Array&lt;<a href="#customlogline">CustomLogLine</a>&gt; | Custom log messages. |
9660
10091
  | engineId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | VUC's id on which monitor's request was executed. |
9661
10092
  | failureMessage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Request's failure message. |
@@ -9898,6 +10329,7 @@ Some fields are inherited from the base _SyntheticLocation_ object.
9898
10329
  | latitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The latitude of the location in <code>DDD.dddd</code> format. |
9899
10330
  | locationNodeOutageDelayInMinutes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
9900
10331
  | longitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The longitude of the location in <code>DDD.dddd</code> format. |
10332
+ | namExecutionSupported | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
9901
10333
  | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
9902
10334
  | nodes | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | <p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl">GET all nodes</a> call.</p> |
9903
10335
  | regionCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0">GET regions of the country</a> request.</p> |
@@ -10000,6 +10432,14 @@ Configuration of a property in a settings schema.
10000
10432
 
10001
10433
  Metadata of the property.
10002
10434
 
10435
+ ### ProtocolDetails
10436
+
10437
+ Details that are specific to the used protocol.
10438
+
10439
+ | Name | Type |
10440
+ | ---- | ------------------------------------------------------ |
10441
+ | http | <a href="#httpprotocoldetails">HttpProtocolDetails</a> |
10442
+
10003
10443
  ### PublicCertificateCredentials
10004
10444
 
10005
10445
  A credentials set of the `PUBLIC_CERTIFICATE` type.
@@ -10133,7 +10573,7 @@ A Release is a combination of a component and a version.
10133
10573
  A Component can be any form of deployable that can be associated with a version.
10134
10574
  In the first draft, a Component is always a Service.
10135
10575
 
10136
- The tuple &lt;name, product, stage, version&gt; is always unique.
10576
+ The tuple &amp;lt;name, product, stage, version&amp;gt; is always unique.
10137
10577
 
10138
10578
  | Name | Type | Description |
10139
10579
  | --------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
@@ -10182,6 +10622,7 @@ Assessment of the remediation item.
10182
10622
 
10183
10623
  | Name | Type | Description |
10184
10624
  | --------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
10625
+ | assessmentAccuracy | RemediationAssessmentAssessmentAccuracy | |
10185
10626
  | dataAssets | RemediationAssessmentDataAssets | |
10186
10627
  | exposure | RemediationAssessmentExposure | |
10187
10628
  | numberOfDataAssets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of related data assets. |
@@ -10263,7 +10704,7 @@ The mute state of a remediation item of a security problem.
10263
10704
 
10264
10705
  ### RemediationItemMuteStateChange
10265
10706
 
10266
- An updated configuration of the remediation item's mute state.
10707
+ An updated configuration of the remediation item&apos;s mute state.
10267
10708
 
10268
10709
  | Name | Type | Description |
10269
10710
  | ---------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------- |
@@ -10388,6 +10829,17 @@ A vulnerable component with details for a remediation progress entity (PGI).
10388
10829
  | loadOrigins | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The load origins of the vulnerable components. |
10389
10830
  | shortName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The short, component-only name of the vulnerable component. |
10390
10831
 
10832
+ ### RequestInformation
10833
+
10834
+ Describes the complete request information of an attack.
10835
+
10836
+ | Name | Type | Description |
10837
+ | --------------- | ----------------------------------------------------------------------------- | ------------------------------- |
10838
+ | host | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The target host of the request. |
10839
+ | path | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The request path. |
10840
+ | protocolDetails | <a href="#protocoldetails">ProtocolDetails</a> | |
10841
+ | url | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The requested URL. |
10842
+
10391
10843
  ### RiskAssessment
10392
10844
 
10393
10845
  Risk assessment of a security problem.
@@ -10560,7 +11012,7 @@ Metadata of the setting.
10560
11012
 
10561
11013
  ### SchemaDefinitionRestDtoProperties
10562
11014
 
10563
- A list of schema's properties.
11015
+ A list of schema&apos;s properties.
10564
11016
 
10565
11017
  ### SchemaDefinitionRestDtoTableColumns
10566
11018
 
@@ -10626,6 +11078,21 @@ Definition of properties that can be persisted.
10626
11078
  | ----------------------------- | ------------------------------------------------------------------------------------------ | -------------------------- |
10627
11079
  | versions<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | A list of schema versions. |
10628
11080
 
11081
+ ### SecurityContextDtoImpl
11082
+
11083
+ | Name | Type | Description |
11084
+ | --------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11085
+ | securityContext | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The security context, that will be set for matching entities. If there exists a management zone with this name, it will be set for all matching entities, overriding all automatic management zone rules. |
11086
+
11087
+ ### SecurityContextResultDto
11088
+
11089
+ The response payload holding the result of the security context application.
11090
+
11091
+ | Name | Type | Description |
11092
+ | ----------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
11093
+ | entityIds | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The entity ids that matched the entity selector and now have the supplied security context set. |
11094
+ | managementZoneIds | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>&gt; | The management zone ids that is applied to the entity ids, if the security context matched an existing management zone's name, otherwise null. |
11095
+
10629
11096
  ### SecurityProblem
10630
11097
 
10631
11098
  Parameters of a security problem
@@ -11003,11 +11470,10 @@ Outage handling configuration.
11003
11470
  | Name | Type | Description |
11004
11471
  | ------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
11005
11472
  | globalConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures for all locations. |
11006
- | globalOutages<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
11473
+ | globalOutages | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
11007
11474
  | localConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures. |
11008
11475
  | localLocationOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of failing locations. |
11009
- | localOutages<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
11010
- | type<sup>\*required</sup> | MultiProtocol | |
11476
+ | localOutages | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
11011
11477
 
11012
11478
  ### SyntheticMonitorSummaryDto
11013
11479
 
@@ -11044,16 +11510,11 @@ Network Availability monitor.
11044
11510
  | frequencyMin<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
11045
11511
  | locations<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The locations to which the monitor is assigned. |
11046
11512
  | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
11047
- | properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitordtoproperties">SyntheticMultiProtocolMonitorDtoProperties</a> | |
11048
11513
  | steps<sup>\*required</sup> | Array&lt;<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>&gt; | The steps of the monitor. |
11049
11514
  | syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
11050
11515
  | tags | Array&lt;<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>&gt; | <p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
11051
11516
  | type<sup>\*required</sup> | SyntheticMultiProtocolMonitorDtoType | |
11052
11517
 
11053
- ### SyntheticMultiProtocolMonitorDtoProperties
11054
-
11055
- The properties of the monitor.
11056
-
11057
11518
  ### SyntheticMultiProtocolMonitorStepDto
11058
11519
 
11059
11520
  The step of a network availability monitor.
@@ -11076,34 +11537,24 @@ The properties which apply to all requests in the step.
11076
11537
 
11077
11538
  Network availability monitor.
11078
11539
 
11079
- | Name | Type | Description |
11080
- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11081
- | active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If false, the monitor is disabled. <i>default:</i> <code>true</code> |
11082
- | frequencyMin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
11083
- | locations<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The locations to which the monitor is assigned. |
11084
- | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
11085
- | properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedtoproperties">SyntheticMultiProtocolMonitorUpdateDtoProperties</a> | |
11086
- | steps<sup>\*required</sup> | Array&lt;<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>&gt; | The steps of the monitor. |
11087
- | syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
11088
- | tags | Array&lt;<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>&gt; | <p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
11089
- | type<sup>\*required</sup> | MultiProtocol | |
11090
-
11091
- ### SyntheticMultiProtocolMonitorUpdateDtoProperties
11092
-
11093
- The properties of the monitor.
11540
+ | Name | Type | Description |
11541
+ | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11542
+ | active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If false, the monitor is disabled. <i>default:</i> <code>true</code> |
11543
+ | frequencyMin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
11544
+ | locations<sup>\*required</sup> | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The locations to which the monitor is assigned. |
11545
+ | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
11546
+ | steps<sup>\*required</sup> | Array&lt;<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>&gt; | The steps of the monitor. |
11547
+ | syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
11548
+ | tags | Array&lt;<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>&gt; | <p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
11549
+ | type<sup>\*required</sup> | MultiProtocol | |
11094
11550
 
11095
11551
  ### SyntheticMultiProtocolRequestConfigurationDto
11096
11552
 
11097
11553
  The configuration of a network availability monitor request.
11098
11554
 
11099
- | Name | Type | Description |
11100
- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
11101
- | constraints<sup>\*required</sup> | Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>&gt; | Request constraints. |
11102
- | properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolrequestconfigurationdtoproperties">SyntheticMultiProtocolRequestConfigurationDtoProperties</a> | |
11103
-
11104
- ### SyntheticMultiProtocolRequestConfigurationDtoProperties
11105
-
11106
- Request properties.
11555
+ | Name | Type | Description |
11556
+ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -------------------- |
11557
+ | constraints<sup>\*required</sup> | Array&lt;<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>&gt; | Request constraints. |
11107
11558
 
11108
11559
  ### SyntheticOnDemandBatchStatus
11109
11560
 
@@ -11276,6 +11727,7 @@ Configuration of a private synthetic location
11276
11727
  | latitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The latitude of the location in <code>DDD.dddd</code> format. |
11277
11728
  | locationNodeOutageDelayInMinutes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
11278
11729
  | longitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The longitude of the location in <code>DDD.dddd</code> format. |
11730
+ | namExecutionSupported | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
11279
11731
  | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
11280
11732
  | nodes | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | <p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl">GET all nodes</a> call.</p> |
11281
11733
  | regionCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0">GET regions of the country</a> request.</p> |
@@ -11402,6 +11854,41 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
11402
11854
  | valueAfterChangePoint | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The metric's value after the problem start. |
11403
11855
  | valueBeforeChangePoint | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The metric's value before the problem start. |
11404
11856
 
11857
+ ### TruncatableListAttackRequestHeader
11858
+
11859
+ A list of values that has possibly been truncated.
11860
+
11861
+ | Name | Type | Description |
11862
+ | -------------- | ------------------------------------------------------------------- | ------------------- |
11863
+ | truncationInfo | <a href="#truncationinfo">TruncationInfo</a> | |
11864
+ | values | Array&lt;<a href="#attackrequestheader">AttackRequestHeader</a>&gt; | Values of the list. |
11865
+
11866
+ ### TruncatableListHttpRequestParameter
11867
+
11868
+ A list of values that has possibly been truncated.
11869
+
11870
+ | Name | Type | Description |
11871
+ | -------------- | --------------------------------------------------------------------- | ------------------- |
11872
+ | truncationInfo | <a href="#truncationinfo">TruncationInfo</a> | |
11873
+ | values | Array&lt;<a href="#httprequestparameter">HttpRequestParameter</a>&gt; | Values of the list. |
11874
+
11875
+ ### TruncatableListString
11876
+
11877
+ A list of values that has possibly been truncated.
11878
+
11879
+ | Name | Type | Description |
11880
+ | -------------- | ------------------------------------------------------------------------------------------ | ------------------- |
11881
+ | truncationInfo | <a href="#truncationinfo">TruncationInfo</a> | |
11882
+ | values | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | Values of the list. |
11883
+
11884
+ ### TruncationInfo
11885
+
11886
+ Information on a possible truncation.
11887
+
11888
+ | Name | Type | Description |
11889
+ | --------- | ------------------------------------------------------------------------------- | ------------------------------------- |
11890
+ | truncated | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If the list/value has been truncated. |
11891
+
11405
11892
  ### UiButtonCustomization
11406
11893
 
11407
11894
  UI customization for defining a button that calls a function when pressed
@@ -11607,6 +12094,18 @@ A credentials set of the `USERNAME_PASSWORD` type.
11607
12094
  | linesOk | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> |
11608
12095
  | warnings | <a href="#warnings">Warnings</a> |
11609
12096
 
12097
+ ### Vulnerability
12098
+
12099
+ Describes the exploited vulnerability.
12100
+
12101
+ | Name | Type | Description |
12102
+ | ----------------------- | ----------------------------------------------------------------------------- | -------------------------------------- |
12103
+ | codeLocation | <a href="#codelocation">CodeLocation</a> | |
12104
+ | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the vulnerability. |
12105
+ | vulnerabilityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The id of the vulnerability. |
12106
+ | vulnerableFunction | <a href="#functiondefinition">FunctionDefinition</a> | |
12107
+ | vulnerableFunctionInput | <a href="#vulnerablefunctioninput">VulnerableFunctionInput</a> | |
12108
+
11610
12109
  ### VulnerableComponent
11611
12110
 
11612
12111
  Vulnerable component of a security problem.
@@ -11708,10 +12207,10 @@ The scope of the credentials set.
11708
12207
 
11709
12208
  Defines the actual set of fields depending on the value. See one of the following objects:
11710
12209
 
11711
- - `USERNAME_PASSWORD` -> CredentialsDetailsUsernamePasswordResponseElement
11712
- - `CERTIFICATE` -> CredentialsDetailsCertificateResponseElement
11713
- - `TOKEN` -> CredentialsDetailsTokenResponseElement
11714
- - `PUBLIC_CERTIFICATE` -> CredentialsDetailsCertificateResponseElement
12210
+ - `USERNAME_PASSWORD` -&gt; CredentialsDetailsUsernamePasswordResponseElement
12211
+ - `CERTIFICATE` -&gt; CredentialsDetailsCertificateResponseElement
12212
+ - `TOKEN` -&gt; CredentialsDetailsTokenResponseElement
12213
+ - `PUBLIC_CERTIFICATE` -&gt; CredentialsDetailsCertificateResponseElement
11715
12214
 
11716
12215
  #### Enum keys
11717
12216
 
@@ -11729,8 +12228,8 @@ Defines the actual set of fields depending on the value. See one of the followin
11729
12228
 
11730
12229
  Defines the actual set of fields depending on the value. See one of the following objects:
11731
12230
 
11732
- - `BURN_RATE` -> BurnRateAlert
11733
- - `STATUS` -> StatusAlert
12231
+ - `BURN_RATE` -&gt; BurnRateAlert
12232
+ - `STATUS` -&gt; StatusAlert
11734
12233
 
11735
12234
  #### Enum keys
11736
12235
 
@@ -11748,7 +12247,7 @@ Defines the actual set of fields depending on the value. See one of the followin
11748
12247
 
11749
12248
  The actual state of the ActiveGate auto-update.
11750
12249
 
11751
- Applicable only if the **setting** parameter is set to `INHERITED`. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the **setting** value.
12250
+ Applicable only if the **setting** parameter is set to `INHERITED`. In that case, the value is taken from the parent setting. Otherwise, it&apos;s just a duplicate of the **setting** value.
11752
12251
 
11753
12252
  #### Enum keys
11754
12253
 
@@ -11998,6 +12497,86 @@ The type of the asset.
11998
12497
 
11999
12498
  </div>
12000
12499
 
12500
+ ### AttackAttackType
12501
+
12502
+ <div class="padding-left--md">
12503
+
12504
+ The type of the attack.
12505
+
12506
+ #### Enum keys
12507
+
12508
+ <div class="padding-left--md">
12509
+
12510
+ `CommandInjection` | `JndiInjection` | `SqlInjection` | `Ssrf`
12511
+
12512
+ </div>
12513
+
12514
+ </div>
12515
+
12516
+ ### AttackSecurityProblemAssessmentDtoDataAssets
12517
+
12518
+ <div class="padding-left--md">
12519
+
12520
+ The reachability of data assets by the attacked target.
12521
+
12522
+ #### Enum keys
12523
+
12524
+ <div class="padding-left--md">
12525
+
12526
+ `NotAvailable` | `NotDetected` | `Reachable`
12527
+
12528
+ </div>
12529
+
12530
+ </div>
12531
+
12532
+ ### AttackSecurityProblemAssessmentDtoExposure
12533
+
12534
+ <div class="padding-left--md">
12535
+
12536
+ The level of exposure of the attacked target
12537
+
12538
+ #### Enum keys
12539
+
12540
+ <div class="padding-left--md">
12541
+
12542
+ `NotAvailable` | `NotDetected` | `PublicNetwork`
12543
+
12544
+ </div>
12545
+
12546
+ </div>
12547
+
12548
+ ### AttackState
12549
+
12550
+ <div class="padding-left--md">
12551
+
12552
+ The state of the attack.
12553
+
12554
+ #### Enum keys
12555
+
12556
+ <div class="padding-left--md">
12557
+
12558
+ `Allowlisted` | `Blocked` | `Exploited`
12559
+
12560
+ </div>
12561
+
12562
+ </div>
12563
+
12564
+ ### AttackTechnology
12565
+
12566
+ <div class="padding-left--md">
12567
+
12568
+ The technology of the attack.
12569
+
12570
+ #### Enum keys
12571
+
12572
+ <div class="padding-left--md">
12573
+
12574
+ `Dotnet` | `Go` | `Java` | `NodeJs`
12575
+
12576
+ </div>
12577
+
12578
+ </div>
12579
+
12001
12580
  ### AuditLogEntryCategory
12002
12581
 
12003
12582
  <div class="padding-left--md">
@@ -12056,7 +12635,7 @@ The type of code level vulnerability.
12056
12635
 
12057
12636
  <div class="padding-left--md">
12058
12637
 
12059
- `CmdInjection` | `ImproperInputValidation` | `SqlInjection`
12638
+ `CmdInjection` | `ImproperInputValidation` | `SqlInjection` | `Ssrf`
12060
12639
 
12061
12640
  </div>
12062
12641
 
@@ -12222,10 +12801,10 @@ The set of scopes of the credentials set.
12222
12801
 
12223
12802
  Defines the actual set of fields depending on the value. See one of the following objects:
12224
12803
 
12225
- - `CERTIFICATE` -> CertificateCredentials
12226
- - `PUBLIC_CERTIFICATE` -> PublicCertificateCredentials
12227
- - `USERNAME_PASSWORD` -> UserPasswordCredentials
12228
- - `TOKEN` -> TokenCredentials
12804
+ - `CERTIFICATE` -&gt; CertificateCredentials
12805
+ - `PUBLIC_CERTIFICATE` -&gt; PublicCertificateCredentials
12806
+ - `USERNAME_PASSWORD` -&gt; UserPasswordCredentials
12807
+ - `TOKEN` -&gt; TokenCredentials
12229
12808
 
12230
12809
  #### Enum keys
12231
12810
 
@@ -12317,6 +12896,22 @@ The type of the HTTP request part that contains the value that was used in this
12317
12896
 
12318
12897
  </div>
12319
12898
 
12899
+ ### EntrypointPayloadType
12900
+
12901
+ <div class="padding-left--md">
12902
+
12903
+ Type of the payload.
12904
+
12905
+ #### Enum keys
12906
+
12907
+ <div class="padding-left--md">
12908
+
12909
+ `HttpBody` | `HttpCookie` | `HttpHeaderName` | `HttpHeaderValue` | `HttpOther` | `HttpParameterName` | `HttpParameterValue` | `HttpUrl` | `Unknown`
12910
+
12911
+ </div>
12912
+
12913
+ </div>
12914
+
12320
12915
  ### EnumTypeType
12321
12916
 
12322
12917
  <div class="padding-left--md">
@@ -12403,11 +12998,11 @@ The severity level associated with the event type.
12403
12998
 
12404
12999
  Defines the actual set of fields depending on the value. See one of the following objects:
12405
13000
 
12406
- - `EVENT` -> EventEvidence
12407
- - `METRIC` -> MetricEvidence
12408
- - `TRANSACTIONAL` -> TransactionalEvidence
12409
- - `MAINTENANCE_WINDOW` -> MaintenanceWindowEvidence
12410
- - `AVAILABILITY_EVIDENCE` -> AvailabilityEvidence
13001
+ - `EVENT` -&gt; EventEvidence
13002
+ - `METRIC` -&gt; MetricEvidence
13003
+ - `TRANSACTIONAL` -&gt; TransactionalEvidence
13004
+ - `MAINTENANCE_WINDOW` -&gt; MaintenanceWindowEvidence
13005
+ - `AVAILABILITY_EVIDENCE` -&gt; AvailabilityEvidence
12411
13006
 
12412
13007
  #### Enum keys
12413
13008
 
@@ -12425,8 +13020,8 @@ Defines the actual set of fields depending on the value. See one of the followin
12425
13020
 
12426
13021
  Defines the actual set of fields depending on the value. See one of the following objects:
12427
13022
 
12428
- - `BROWSER` -> BMAction
12429
- - `HTTP` -> MonitorRequestExecutionResult
13023
+ - `BROWSER` -&gt; BMAction
13024
+ - `HTTP` -&gt; MonitorRequestExecutionResult
12430
13025
 
12431
13026
  #### Enum keys
12432
13027
 
@@ -12476,11 +13071,11 @@ Latest status of given configuration.
12476
13071
 
12477
13072
  Defines the actual set of fields depending on the value. See one of the following objects:
12478
13073
 
12479
- - `HASHICORP_VAULT_APPROLE` -> HashicorpApproleConfig
12480
- - `HASHICORP_VAULT_CERTIFICATE` -> HashicorpCertificateConfig
12481
- - `AZURE_KEY_VAULT_CLIENT_SECRET` -> AzureClientSecretConfig
12482
- - `CYBERARK_VAULT_USERNAME_PASSWORD` -> CyberArkUsernamePasswordConfig
12483
- - `CYBERARK_VAULT_ALLOWED_LOCATION` -> CyberArkAllowedLocationConfig
13074
+ - `HASHICORP_VAULT_APPROLE` -&gt; HashicorpApproleConfig
13075
+ - `HASHICORP_VAULT_CERTIFICATE` -&gt; HashicorpCertificateConfig
13076
+ - `AZURE_KEY_VAULT_CLIENT_SECRET` -&gt; AzureClientSecretConfig
13077
+ - `CYBERARK_VAULT_USERNAME_PASSWORD` -&gt; CyberArkUsernamePasswordConfig
13078
+ - `CYBERARK_VAULT_ALLOWED_LOCATION` -&gt; CyberArkAllowedLocationConfig
12484
13079
 
12485
13080
  #### Enum keys
12486
13081
 
@@ -12512,11 +13107,11 @@ Defines the actual set of fields depending on the value. See one of the followin
12512
13107
 
12513
13108
  Defines the actual set of fields depending on the value. See one of the following objects:
12514
13109
 
12515
- - `HASHICORP_VAULT_APPROLE` -> HashicorpApprole
12516
- - `HASHICORP_VAULT_CERTIFICATE` -> HashicorpCertificate
12517
- - `AZURE_KEY_VAULT_CLIENT_SECRET` -> AzureClientSecret
12518
- - `CYBERARK_VAULT_USERNAME_PASSWORD` -> CyberArkUsernamePassword
12519
- - `CYBERARK_VAULT_ALLOWED_LOCATION` -> CyberArkAllowedLocationDto
13110
+ - `HASHICORP_VAULT_APPROLE` -&gt; HashicorpApprole
13111
+ - `HASHICORP_VAULT_CERTIFICATE` -&gt; HashicorpCertificate
13112
+ - `AZURE_KEY_VAULT_CLIENT_SECRET` -&gt; AzureClientSecret
13113
+ - `CYBERARK_VAULT_USERNAME_PASSWORD` -&gt; CyberArkUsernamePassword
13114
+ - `CYBERARK_VAULT_ALLOWED_LOCATION` -&gt; CyberArkAllowedLocationDto
12520
13115
 
12521
13116
  #### Enum keys
12522
13117
 
@@ -12946,10 +13541,10 @@ Type of this filter, determines which other fields are present.Can be any of:
12946
13541
 
12947
13542
  Defines the actual set of fields depending on the value. See one of the following objects:
12948
13543
 
12949
- - `SERVICE` -> ServiceImpact
12950
- - `APPLICATION` -> ApplicationImpact
12951
- - `MOBILE` -> MobileImpact
12952
- - `CUSTOM_APPLICATION` -> CustomApplicationImpact
13544
+ - `SERVICE` -&gt; ServiceImpact
13545
+ - `APPLICATION` -&gt; ApplicationImpact
13546
+ - `MOBILE` -&gt; MobileImpact
13547
+ - `CUSTOM_APPLICATION` -&gt; CustomApplicationImpact
12953
13548
 
12954
13549
  #### Enum keys
12955
13550
 
@@ -13129,7 +13724,7 @@ Decimal: 1 MB = 1000 kB = 1,000,000 bytes
13129
13724
 
13130
13725
  If not set, the decimal system is used.
13131
13726
 
13132
- [Metric expressions](https://dt-url.net/metricExpression) don't return this field.
13727
+ [Metric expressions](https://dt-url.net/metricExpression) don&apos;t return this field.
13133
13728
 
13134
13729
  #### Enum keys
13135
13730
 
@@ -13199,7 +13794,7 @@ The name of the monitoring state.
13199
13794
 
13200
13795
  <div class="padding-left--md">
13201
13796
 
13202
- `AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
13797
+ `AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
13203
13798
 
13204
13799
  </div>
13205
13800
 
@@ -13333,6 +13928,22 @@ The level of exposure of the service.
13333
13928
 
13334
13929
  </div>
13335
13930
 
13931
+ ### RemediationAssessmentAssessmentAccuracy
13932
+
13933
+ <div class="padding-left--md">
13934
+
13935
+ The accuracy of the assessment.
13936
+
13937
+ #### Enum keys
13938
+
13939
+ <div class="padding-left--md">
13940
+
13941
+ `Full` | `NotAvailable` | `Reduced`
13942
+
13943
+ </div>
13944
+
13945
+ </div>
13946
+
13336
13947
  ### RemediationAssessmentDataAssets
13337
13948
 
13338
13949
  <div class="padding-left--md">
@@ -13525,7 +14136,7 @@ The current state of the remediation progress entity.
13525
14136
 
13526
14137
  <div class="padding-left--md">
13527
14138
 
13528
- The level of available information on which this assessment has been done.
14139
+ The accuracy of the assessment.
13529
14140
 
13530
14141
  #### Enum keys
13531
14142
 
@@ -13621,7 +14232,7 @@ The reachability of related data assets by affected entities.
13621
14232
 
13622
14233
  <div class="padding-left--md">
13623
14234
 
13624
- The level of available information on which this assessment has been done.
14235
+ The accuracy of the assessment.
13625
14236
 
13626
14237
  #### Enum keys
13627
14238
 
@@ -14139,7 +14750,7 @@ The reason for un-muting the security problems.
14139
14750
 
14140
14751
  The calculated burn rate type.
14141
14752
 
14142
- Has a value of 'FAST', 'SLOW' or 'NONE'.
14753
+ Has a value of &apos;FAST&apos;, &apos;SLOW&apos; or &apos;NONE&apos;.
14143
14754
 
14144
14755
  #### Enum keys
14145
14756
 
@@ -14174,8 +14785,8 @@ The evaluation type of the SLO.
14174
14785
  The status of the location:
14175
14786
 
14176
14787
  - `ENABLED`: The location is displayed as active in the UI. You can assign monitors to the location.
14177
- - `DISABLED`: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
14178
- - `HIDDEN`: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as `HIDDEN` when no monitor is assigned to it.
14788
+ - `DISABLED`: The location is displayed as inactive in the UI. You can&apos;t assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
14789
+ - `HIDDEN`: The location is not displayed in the UI. You can&apos;t assign monitors to the location. You can only set location as `HIDDEN` when no monitor is assigned to it.
14179
14790
 
14180
14791
  #### Enum keys
14181
14792
 
@@ -14193,9 +14804,9 @@ The status of the location:
14193
14804
 
14194
14805
  Defines the actual set of fields depending on the value. See one of the following objects:
14195
14806
 
14196
- - `PUBLIC` -> PublicSyntheticLocation
14197
- - `PRIVATE` -> PrivateSyntheticLocation
14198
- - `CLUSTER` -> PrivateSyntheticLocation
14807
+ - `PUBLIC` -&gt; PublicSyntheticLocation
14808
+ - `PRIVATE` -&gt; PrivateSyntheticLocation
14809
+ - `CLUSTER` -&gt; PrivateSyntheticLocation
14199
14810
 
14200
14811
  #### Enum keys
14201
14812
 
@@ -14213,8 +14824,8 @@ Defines the actual set of fields depending on the value. See one of the followin
14213
14824
 
14214
14825
  Defines the actual set of fields depending on the value. See one of the following objects:
14215
14826
 
14216
- - `PUBLIC` -> SyntheticPublicLocationUpdate
14217
- - `PRIVATE` -> SyntheticPrivateLocationUpdate
14827
+ - `PUBLIC` -&gt; SyntheticPublicLocationUpdate
14828
+ - `PRIVATE` -&gt; SyntheticPrivateLocationUpdate
14218
14829
 
14219
14830
  #### Enum keys
14220
14831
 
@@ -14226,24 +14837,6 @@ Defines the actual set of fields depending on the value. See one of the followin
14226
14837
 
14227
14838
  </div>
14228
14839
 
14229
- ### SyntheticMonitorOutageHandlingSettingsDtoType
14230
-
14231
- <div class="padding-left--md">
14232
-
14233
- Defines the actual set of fields depending on the value. See one of the following objects:
14234
-
14235
- - `MULTI_PROTOCOL` -> SyntheticMultiProtocolMonitorUpdateDto
14236
-
14237
- #### Enum keys
14238
-
14239
- <div class="padding-left--md">
14240
-
14241
- `MultiProtocol`
14242
-
14243
- </div>
14244
-
14245
- </div>
14246
-
14247
14840
  ### SyntheticMonitorSummaryDtoType
14248
14841
 
14249
14842
  <div class="padding-left--md">
@@ -14372,7 +14965,7 @@ Execution repeat mode. If not set, the mode is SEQUENTIAL.
14372
14965
 
14373
14966
  <div class="padding-left--md">
14374
14967
 
14375
- The execution's processing mode
14968
+ The execution&apos;s processing mode
14376
14969
 
14377
14970
  #### Enum keys
14378
14971
 
@@ -14522,7 +15115,7 @@ The type of the input.
14522
15115
 
14523
15116
  <div class="padding-left--md">
14524
15117
 
14525
- `Command` | `Jndi` | `SqlStatement`
15118
+ `Command` | `HttpClient` | `Jndi` | `SqlStatement`
14526
15119
 
14527
15120
  </div>
14528
15121