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

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 (37) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +1 -1
  3. package/docs/DOCS.md +351 -347
  4. package/dynatrace-metadata.json +2 -2
  5. package/package.json +1 -1
  6. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.d.ts +3 -3
  7. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.transformation.d.ts +1 -1
  8. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.d.ts +3 -3
  9. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.transformation.d.ts +1 -1
  10. package/types/packages/client/classic-environment-v2/src/lib/models/cloud-event.d.ts +1 -1
  11. package/types/packages/client/classic-environment-v2/src/lib/models/cloud-event.transformation.d.ts +1 -1
  12. package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.d.ts +1 -1
  13. package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.transformation.d.ts +1 -1
  14. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.d.ts +3 -3
  15. package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.transformation.d.ts +1 -1
  16. package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.d.ts +3 -3
  17. package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.transformation.d.ts +1 -1
  18. package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.d.ts +3 -3
  19. package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.transformation.d.ts +1 -1
  20. package/types/packages/client/classic-environment-v2/src/lib/models/json-node.d.ts +3 -3
  21. package/types/packages/client/classic-environment-v2/src/lib/models/json-node.transformation.d.ts +1 -1
  22. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +3 -3
  23. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.transformation.d.ts +1 -1
  24. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.d.ts +3 -3
  25. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.transformation.d.ts +1 -1
  26. package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +3 -3
  27. package/types/packages/client/classic-environment-v2/src/lib/models/object-node.transformation.d.ts +1 -1
  28. package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.d.ts +3 -3
  29. package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.transformation.d.ts +1 -1
  30. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +1 -1
  31. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.transformation.d.ts +1 -1
  32. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.d.ts +3 -3
  33. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.transformation.d.ts +1 -1
  34. package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.d.ts +3 -3
  35. package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.transformation.d.ts +1 -1
  36. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.d.ts +3 -3
  37. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.transformation.d.ts +1 -1
package/docs/DOCS.md CHANGED
@@ -14,17 +14,21 @@ Notes about compatibility:
14
14
  - Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
15
15
  - We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.
16
16
 
17
- import NpmLogo from '@site/static/img/npm-logo.png';
17
+ import NpmLogo from "@site/static/img/npm-logo.png";
18
18
 
19
19
  <div class="row margin-bottom--md">
20
20
  <div class="col">
21
21
  <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2">
22
- <span class="margin-right--xs">@dynatrace-sdk/client-classic-environment-v2</span>
22
+ <span class="margin-right--xs">
23
+ @dynatrace-sdk/client-classic-environment-v2
24
+ </span>
23
25
  <img className="no-zoom" width="20px" src={NpmLogo} />
24
26
  </a>
25
27
  </div>
26
- <div class="col" style={{textAlign: 'right'}}>
27
- <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.8.0">v1.8.0</a>
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
31
+ </a>
28
32
  </div>
29
33
  </div>
30
34
 
@@ -196,7 +200,7 @@ Deletes an ActiveGate token
196
200
  | ----------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
197
201
  | config.activeGateTokenIdentifier<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ActiveGate token identifier, consisting of <a href="https://dt-url.net/rn00tjg">prefix and public part</a> of the token to be deleted. |
198
202
 
199
- <!-- no returns -->
203
+ {/* no returns */}
200
204
 
201
205
  <details>
202
206
  <summary>
@@ -288,7 +292,7 @@ Deletes an API token
288
292
  | ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
289
293
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of the token to be deleted.</p> <p>You can specify either the ID or the secret of the token.</p> <p>You can't delete the token you're using for authentication of the request.</p> |
290
294
 
291
- <!-- no returns -->
295
+ {/* no returns */}
292
296
 
293
297
  <details>
294
298
  <summary>
@@ -469,7 +473,7 @@ Updates an API token
469
473
  | config.body<sup>\*required</sup> | <a href="#apitokenupdate">ApiTokenUpdate</a> | |
470
474
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of the token to be updated.</p> <p>You can't disable the token you're using for authentication of the request.</p> |
471
475
 
472
- <!-- no returns -->
476
+ {/* no returns */}
473
477
 
474
478
  <details>
475
479
  <summary>
@@ -512,7 +516,7 @@ To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6)
512
516
 
513
517
  </div>
514
518
 
515
- <!-- no parameters -->
519
+ {/* no parameters */}
516
520
 
517
521
  #### Returns
518
522
 
@@ -550,7 +554,7 @@ To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6)
550
554
 
551
555
  </div>
552
556
 
553
- <!-- no parameters -->
557
+ {/* no parameters */}
554
558
 
555
559
  #### Returns
556
560
 
@@ -588,7 +592,7 @@ To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6)
588
592
 
589
593
  </div>
590
594
 
591
- <!-- no parameters -->
595
+ {/* no parameters */}
592
596
 
593
597
  #### Returns
594
598
 
@@ -673,7 +677,7 @@ Gets the global auto-update configuration of environment ActiveGates.
673
677
 
674
678
  </div>
675
679
 
676
- <!-- no parameters -->
680
+ {/* no parameters */}
677
681
 
678
682
  #### Returns
679
683
 
@@ -717,7 +721,7 @@ Updates the configuration of auto-update for the specified ActiveGate
717
721
  | config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
718
722
  | config.body<sup>\*required</sup> | <a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a> | |
719
723
 
720
- <!-- no returns -->
724
+ {/* no returns */}
721
725
 
722
726
  <details>
723
727
  <summary>
@@ -759,7 +763,7 @@ Puts the global auto-update configuration of environment ActiveGates.
759
763
  | -------------------------------- | -------------------------------------------------------------------------------- |
760
764
  | config.body<sup>\*required</sup> | <a href="#activegateglobalautoupdateconfig">ActiveGateGlobalAutoUpdateConfig</a> |
761
765
 
762
- <!-- no returns -->
766
+ {/* no returns */}
763
767
 
764
768
  <details>
765
769
  <summary>
@@ -801,7 +805,7 @@ Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
801
805
  | config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
802
806
  | config.body<sup>\*required</sup> | <a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a> | |
803
807
 
804
- <!-- no returns -->
808
+ {/* no returns */}
805
809
 
806
810
  <details>
807
811
  <summary>
@@ -843,7 +847,7 @@ Validates the payload for the `POST /activeGates/autoUpdate` request.
843
847
  | -------------------------------- | -------------------------------------------------------------------------------- |
844
848
  | config.body<sup>\*required</sup> | <a href="#activegateglobalautoupdateconfig">ActiveGateGlobalAutoUpdateConfig</a> |
845
849
 
846
- <!-- no returns -->
850
+ {/* no returns */}
847
851
 
848
852
  <details>
849
853
  <summary>
@@ -935,7 +939,7 @@ Deletes the specified update job
935
939
  | config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
936
940
  | config.jobId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A unique identifier for a update-job of ActiveGate. |
937
941
 
938
- <!-- no returns -->
942
+ {/* no returns */}
939
943
 
940
944
  <details>
941
945
  <summary>
@@ -1122,7 +1126,7 @@ Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
1122
1126
  | config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
1123
1127
  | config.body<sup>\*required</sup> | <a href="#updatejob">UpdateJob</a> | |
1124
1128
 
1125
- <!-- no returns -->
1129
+ {/* no returns */}
1126
1130
 
1127
1131
  <details>
1128
1132
  <summary>
@@ -1317,14 +1321,14 @@ You can limit the output by using pagination:
1317
1321
 
1318
1322
  #### Parameters
1319
1323
 
1320
- | Name | Type | Description |
1321
- | ------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1322
- | config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters the audit log. You can use the following criteria:</p> <ul> <li>User: <code>user(&quot;userIdentification&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Event type: <code>eventType(&quot;value&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Category of a logged operation: <code>category(&quot;value&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Entity ID: <code>entityId(&quot;id&quot;)</code>. The <code>CONTAINS</code> operator applies.</li> </ul> <p>For each criterion, you can specify multiple alternatives with comma-separated values. In this case, the OR logic applies. For example, <code>eventType(&quot;CREATE&quot;,&quot;UPDATE&quot;)</code> means eventType can be &quot;CREATE&quot; or &quot;UPDATE&quot;.</p> <p>You can specify multiple comma-separated criteria, such as <code>eventType(&quot;CREATE&quot;,&quot;UPDATE&quot;),category(&quot;CONFIG&quot;)</code>. Only results matching <strong>all</strong> criteria are included in response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>&quot;</code></li> </ul> |
1323
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
1324
- | 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> |
1325
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of log entries in a single response payload.</p> <p>The maximal allowed page size is 5000.</p> <p>If not set, 1000 is used.</p> |
1326
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p> <i>default:</i> <code>"-timestamp"</code> |
1327
- | 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> |
1324
+ | Name | Type | Description |
1325
+ | ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1326
+ | config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters the audit log. You can use the following criteria:</p> <ul> <li>User: <code>user(&quot;userIdentification&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Event type: <code>eventType(&quot;value&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Category of a logged operation: <code>category(&quot;value&quot;)</code>. The <code>EQUALS</code> operator applies.</li> <li>Entity ID: <code>entityId(&quot;id&quot;)</code>. The <code>CONTAINS</code> operator applies.</li> </ul> <p>For each criterion, you can specify multiple alternatives with comma-separated values. In this case, the OR logic applies. For example, <code>eventType(&quot;CREATE&quot;,&quot;UPDATE&quot;)</code> means eventType can be &quot;CREATE&quot; or &quot;UPDATE&quot;.</p> <p>You can specify multiple comma-separated criteria, such as <code>eventType(&quot;CREATE&quot;,&quot;UPDATE&quot;),category(&quot;CONFIG&quot;)</code>. Only results matching <strong>all</strong> criteria are included in 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> |
1327
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
1328
+ | 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> |
1329
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of log entries in a single response payload.</p> <p>The maximal allowed page size is 5000.</p> <p>If not set, 1000 is used.</p> |
1330
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p> <i>default:</i> <code>"-timestamp"</code> |
1331
+ | 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> |
1328
1332
 
1329
1333
  #### Returns
1330
1334
 
@@ -1368,7 +1372,7 @@ The ingestion of business events is subject to licensing (see [licensing documen
1368
1372
 
1369
1373
  </div>
1370
1374
 
1371
- <!-- no parameters -->
1375
+ {/* no parameters */}
1372
1376
 
1373
1377
  #### Returns
1374
1378
 
@@ -1617,7 +1621,7 @@ Provide credential ID in the path.
1617
1621
  | ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------- |
1618
1622
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the credentials set to be deleted. |
1619
1623
 
1620
- <!-- no returns -->
1624
+ {/* no returns */}
1621
1625
 
1622
1626
  <details>
1623
1627
  <summary>
@@ -2020,14 +2024,14 @@ Lists events within the specified timeframe
2020
2024
 
2021
2025
  #### Parameters
2022
2026
 
2023
- | Name | Type | Description |
2024
- | --------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2025
- | 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> |
2026
- | 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> |
2027
- | 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> |
2028
- | 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> |
2029
- | 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> |
2030
- | 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> |
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> |
2031
2035
 
2032
2036
  #### Returns
2033
2037
 
@@ -2164,7 +2168,7 @@ const data = await extensions_2_0Client.createMonitoringConfiguration({
2164
2168
  | config.body<sup>\*required</sup> | Array&lt;<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>&gt; | |
2165
2169
  | 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. |
2166
2170
 
2167
- <!-- no returns -->
2171
+ {/* no returns */}
2168
2172
 
2169
2173
  </div>
2170
2174
 
@@ -2700,7 +2704,7 @@ const data =
2700
2704
  ### getSchemaFile
2701
2705
 
2702
2706
  <div class="padding-bottom--md">
2703
- <strong>extensions_2_0Client.getSchemaFile(config): Promise&lt;<a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>&gt;</strong>
2707
+ <strong>extensions_2_0Client.getSchemaFile(config): Promise&lt;JsonNode&gt;</strong>
2704
2708
 
2705
2709
  <div class="padding-left--md">
2706
2710
 
@@ -2991,7 +2995,7 @@ Lists all the extension 2.0 schemas versions available in your environment
2991
2995
 
2992
2996
  </div>
2993
2997
 
2994
- <!-- no parameters -->
2998
+ {/* no parameters */}
2995
2999
 
2996
3000
  #### Returns
2997
3001
 
@@ -3131,7 +3135,7 @@ Deletes the specified monitoring configuration
3131
3135
  | config.configurationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested monitoring configuration. |
3132
3136
  | 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. |
3133
3137
 
3134
- <!-- no returns -->
3138
+ {/* no returns */}
3135
3139
 
3136
3140
  <details>
3137
3141
  <summary>
@@ -3512,7 +3516,7 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
3512
3516
 
3513
3517
  </div>
3514
3518
 
3515
- <!-- no parameters -->
3519
+ {/* no parameters */}
3516
3520
 
3517
3521
  #### Returns
3518
3522
 
@@ -3592,7 +3596,7 @@ You can additionally limit the output by using pagination:
3592
3596
  | 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" | |
3593
3597
  | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of metric properties included in the response.</p> <p><code>metricId</code> is <strong>always</strong> included in the result. The following additional properties are available:</p> <ul> <li><code>displayName</code>: The name of the metric in the user interface. Enabled by default.</li> <li><code>description</code>: A short description of the metric. Enabled by default.</li> <li><code>unit</code>: The unit of the metric. Enabled by default.</li> <li><code>tags</code>: The tags of the metric.</li> </ul> <ul> <li><code>dduBillable</code>: An indicator whether the usage of metric consumes <a href="https://dt-url.net/ddu">Davis data units</a>. Deprecated and always <code>false</code> for Dynatrace Platform Subscription. Superseded by <code>billable</code>.</li> <li><code>billable</code>: An indicator whether the usage of metric is billable.</li> </ul> <ul> <li><code>created</code>: The timestamp (UTC milliseconds) when the metrics has been created.</li> <li><code>lastWritten</code>: The timestamp (UTC milliseconds) when metric data points have been written for the last time.</li> <li><code>aggregationTypes</code>: The list of allowed aggregations for the metric. Note that it may be different after a <a href="https://dt-url.net/metricSelector">transformation</a> is applied.</li> <li><code>defaultAggregation</code>: The default aggregation of the metric. It is used when no aggregation is specified or the <code>:auto</code> transformation is set.</li> <li><code>dimensionDefinitions</code>: The fine metric division (for example, process group and process ID for some process-related metric).</li> <li><code>transformations</code>: A list of <a href="https://dt-url.net/metricSelector">transformations</a> that can be applied to the metric.</li> <li><code>entityType</code>: A list of entity types supported by the metric.</li> <li><code>minimumValue</code>: The minimum allowed value of the metric.</li> <li><code>maximumValue</code>: The maximum allowed value of the metric.</li> <li><code>rootCauseRelevant</code>: Whether (true or false) the metric is related to a root cause of a problem. A root-cause relevant metric represents a strong indicator for a faulty component.</li> <li><code>impactRelevant</code>: Whether (true or false) the metric is relevant to a problem's impact. An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed.</li> <li><code>metricValueType</code>: The type of the metric's value. You have these options: <ul> <li><code>score</code>: A score metric is a metric where high values indicate a good situation, while low values indicate trouble. An example of such a metric is a success rate.</li> <li><code>error</code>: An error metric is a metric where high values indicate trouble, while low values indicate a good situation. An example of such a metric is an error count.</li> </ul> </li> <li><code>latency</code>: The latency of the metric, in minutes. The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace. The allowed value range is from <code>1</code> to <code>60</code> minutes.</li> <li><code>metricSelector</code>: The underlying metric selector used by a func: metric.</li> <li><code>scalar</code>: Indicates whether the metric expression resolves to a scalar (<code>true</code>) or to a series (<code>false</code>). A scalar result always contains one data point. The amount of data points in a series result depends on the resolution you're using.</li> <li><code>resolutionInfSupported</code>: If <code>true</code>, resolution=Inf can be applied to the metric query.</li> </ul> <p>To add properties, list them with leading plus <code>+</code>. To exclude default properties, list them with leading minus <code>-</code>.</p> <p>To specify several properties, join them with a comma (for example <code>fields=+aggregationTypes,-description</code>).</p> <p>If you specify just one property, the response contains the metric key and the specified property. To return metric keys only, specify <code>metricId</code> here.</p> |
3594
3598
  | config.metadataSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The metadata scope of the query. Only metrics with specified properties 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> <p><code>unit(&quot;unit-1&quot;,&quot;unit-2&quot;)</code></p> </li> <li> <p><code>tags(&quot;tag-1&quot;,&quot;tag-2&quot;)</code></p> </li> <li> <p><code>dimensionKey(&quot;dimkey-1&quot;,&quot;dimkey-2&quot;)</code>. The filtering applies only to dimensions that were written within the last 14 days.</p> </li> <li> <p><code>custom(&quot;true&quot;)</code>. &quot;true&quot; to include only user-defined metrics metrics (without namespace or with <code>ext:</code>, <code>calc:</code>, <code>func:</code>, <code>appmon:</code>), &quot;false&quot; to filter them out.</p> </li> <li> <p><code>exported(&quot;true&quot;)</code>. &quot;true&quot; to include only exported metrics, &quot;false&quot; to filter them out.</p> </li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>tags(&quot;feature&quot;,&quot;cloud&quot;),unit(&quot;Percent&quot;),dimensionKey(&quot;location&quot;),custom(&quot;true&quot;)</code>. Only results matching <strong>all</strong> criteria are included in response.</p> <p>For example, to list metrics that have the tags <strong>feature</strong> AND <strong>cloud</strong> with a unit of <strong>Percent</strong> OR <strong>MegaByte</strong> AND a dimension with a dimension key <strong>location</strong>, use this <strong>metadataSelector</strong>: <code>tags(&quot;feature&quot;),unit(&quot;Percent&quot;,&quot;MegaByte&quot;),tags(&quot;cloud&quot;),dimensionKey(&quot;location&quot;)</code>.</p> |
3595
- | config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Selects metrics for the query by their keys.</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>You can select a full set of related metrics by using a trailing asterisk (<code>\*</code>) wildcard. For example, <code>builtin:host.\*</code> selects all host-based metrics and <code>builtin:\*</code> selects all Dynatrace-provided metrics.</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> <p>Only <code>aggregation</code>, <code>merge</code>, <code>parents</code>, and <code>splitBy</code> transformations are supported by this endpoint.</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>~</code>):</p> <ul> <li>Quotes (<code>&quot;</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type &quot;APACHE&quot;</strong> you must specify this selector:</p> <p><code>&quot;ext:selfmonitoring.jmx.Agents: Type ~&quot;APACHE~&quot;&quot;</code></p> <p>To find metrics based on a search term, rather than metricId, use the <strong>text</strong> query parameter instead of this one.</p> |
3599
+ | config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Selects metrics for the query by their keys.</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>You can select a full set of related metrics by using a trailing asterisk (<code>\*</code>) wildcard. For example, <code>builtin:host.\*</code> selects all host-based metrics and <code>builtin:\*</code> selects all Dynatrace-provided metrics.</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> <p>Only <code>aggregation</code>, <code>merge</code>, <code>parents</code>, and <code>splitBy</code> transformations are supported by this endpoint.</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>To find metrics based on a search term, rather than metricId, use the <strong>text</strong> query parameter instead of this one.</p> |
3596
3600
  | 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> |
3597
3601
  | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of metric schemata in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> <p>If a value higher than 500 is used, only 500 results per page are returned.</p> |
3598
3602
  | config.text | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Metric registry search term. Only show metrics that contain the term in their key, display name, or description. Use the <code>metricSelector</code> parameter instead of this one to select a complete metric hierarchy instead of doing a text-based search. |
@@ -3642,7 +3646,7 @@ Deletion cannot be undone! You can't delete a metric if it has data points inges
3642
3646
  | ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------- |
3643
3647
  | config.metricKey<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The key of the required metric. |
3644
3648
 
3645
- <!-- no returns -->
3649
+ {/* no returns */}
3646
3650
 
3647
3651
  <details>
3648
3652
  <summary>
@@ -3774,15 +3778,15 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
3774
3778
 
3775
3779
  #### Parameters
3776
3780
 
3777
- | Name | Type | Description |
3778
- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3779
- | 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" | |
3780
- | 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/{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> |
3781
- | 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> |
3782
- | 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>~</code>):</p> <ul> <li>Quotes (<code>&quot;</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type &quot;APACHE&quot;</strong> you must specify this selector:</p> <p><code>&quot;ext:selfmonitoring.jmx.Agents: Type ~&quot;APACHE~&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> |
3783
- | 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> |
3784
- | 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> |
3785
- | 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> |
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> |
3786
3790
 
3787
3791
  #### Returns
3788
3792
 
@@ -3980,15 +3984,15 @@ You can limit the output by using pagination:
3980
3984
 
3981
3985
  #### Parameters
3982
3986
 
3983
- | Name | Type | Description |
3984
- | --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3985
- | 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> |
3986
- | 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> |
3987
- | 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> |
3988
- | 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> |
3989
- | 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> |
3990
- | 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> |
3991
- | 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> |
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> |
3992
3996
 
3993
3997
  #### Returns
3994
3998
 
@@ -4207,14 +4211,14 @@ Deletes the specified tag from the specified entities
4207
4211
 
4208
4212
  #### Parameters
4209
4213
 
4210
- | Name | Type | Description |
4211
- | ------------------------------------------ | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4212
- | 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> |
4213
- | 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> |
4214
- | 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> |
4215
- | 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> |
4216
- | 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> |
4217
- | 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> |
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> |
4218
4222
 
4219
4223
  #### Returns
4220
4224
 
@@ -4257,11 +4261,11 @@ Automatically applied tags and imported tags are not included.
4257
4261
 
4258
4262
  #### Parameters
4259
4263
 
4260
- | Name | Type | Description |
4261
- | ------------------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4262
- | 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> |
4263
- | 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> |
4264
- | 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> |
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> |
4265
4269
 
4266
4270
  #### Returns
4267
4271
 
@@ -4303,12 +4307,12 @@ All existing tags remain unaffected.
4303
4307
 
4304
4308
  #### Parameters
4305
4309
 
4306
- | Name | Type | Description |
4307
- | ------------------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4308
- | config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> | |
4309
- | 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> |
4310
- | 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> |
4311
- | 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> |
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> |
4312
4316
 
4313
4317
  #### Returns
4314
4318
 
@@ -4357,11 +4361,11 @@ Only process group instances are supported.
4357
4361
 
4358
4362
  #### Parameters
4359
4363
 
4360
- | Name | Type | Description |
4361
- | --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
4362
- | 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> |
4363
- | 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> |
4364
- | 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> |
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> |
4365
4369
 
4366
4370
  #### Returns
4367
4371
 
@@ -4461,7 +4465,7 @@ If the network zone is used as an alternative zone for any OneAgent, it will be
4461
4465
  | ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------- |
4462
4466
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the network zone to be deleted. |
4463
4467
 
4464
- <!-- no returns -->
4468
+ {/* no returns */}
4465
4469
 
4466
4470
  <details>
4467
4471
  <summary>
@@ -4495,7 +4499,7 @@ Lists all existing network zones
4495
4499
 
4496
4500
  </div>
4497
4501
 
4498
- <!-- no parameters -->
4502
+ {/* no parameters */}
4499
4503
 
4500
4504
  #### Returns
4501
4505
 
@@ -4574,7 +4578,7 @@ Gets the global configuration of network zones
4574
4578
 
4575
4579
  </div>
4576
4580
 
4577
- <!-- no parameters -->
4581
+ {/* no parameters */}
4578
4582
 
4579
4583
  #### Returns
4580
4584
 
@@ -4658,7 +4662,7 @@ Updates the global configuration of network zones
4658
4662
  | -------------------------------- | ------------------------------------------------------ |
4659
4663
  | config.body<sup>\*required</sup> | <a href="#networkzonesettings">NetworkZoneSettings</a> |
4660
4664
 
4661
- <!-- no returns -->
4665
+ {/* no returns */}
4662
4666
 
4663
4667
  <details>
4664
4668
  <summary>
@@ -4749,7 +4753,7 @@ Adds a new comment on the specified problem
4749
4753
  | config.body<sup>\*required</sup> | <a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a> | |
4750
4754
  | config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
4751
4755
 
4752
- <!-- no returns -->
4756
+ {/* no returns */}
4753
4757
 
4754
4758
  <details>
4755
4759
  <summary>
@@ -4791,7 +4795,7 @@ Deletes the specified comment from a problem
4791
4795
  | config.commentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required comment. |
4792
4796
  | config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
4793
4797
 
4794
- <!-- no returns -->
4798
+ {/* no returns */}
4795
4799
 
4796
4800
  <details>
4797
4801
  <summary>
@@ -4959,16 +4963,16 @@ Lists problems observed within the specified timeframe
4959
4963
 
4960
4964
  #### Parameters
4961
4965
 
4962
- | Name | Type | Description |
4963
- | ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
4964
- | 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> |
4965
- | 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> |
4966
- | 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> |
4967
- | 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> |
4968
- | 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> |
4969
- | 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>~</code> and <code>&quot;</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text(&quot;~&quot;&quot;)</code>). The search value is limited to 30 characters.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
4970
- | 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> |
4971
- | 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> |
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> |
4972
4976
 
4973
4977
  #### Returns
4974
4978
 
@@ -5012,7 +5016,7 @@ Updates the specified comment on a problem
5012
5016
  | config.commentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required comment. |
5013
5017
  | config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
5014
5018
 
5015
- <!-- no returns -->
5019
+ {/* no returns */}
5016
5020
 
5017
5021
  <details>
5018
5022
  <summary>
@@ -5056,15 +5060,15 @@ Returns all releases
5056
5060
 
5057
5061
  #### Parameters
5058
5062
 
5059
- | Name | Type | Description |
5060
- | ----------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5061
- | config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>). <i>default:</i> <code>false</code> |
5062
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
5063
- | 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> |
5064
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
5065
- | config.releasesSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName(&quot;ManagementZone-A&quot;). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState(&quot;Active&quot;) or monitoringState(&quot;Inactive&quot;). You can specify only one monitoring state.</li> <li>Health state: healthState(&quot;HEALTHY&quot;) or healthState(&quot;UNHEALTHY&quot;). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem(&quot;Detected&quot;) or affectedBySecurityProblem(&quot;Not detected&quot;). You can specify only one security vulnerability state.</li> <li>Name: entityName(&quot;name&quot;). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId(&quot;id&quot;).</li> <li>Product: releasesProduct(&quot;product&quot;). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage(&quot;stage&quot;). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion(&quot;version&quot;). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name(&quot;Server&quot;),monitoringState(&quot;Active&quot;),healthState(&quot;HEALTHY&quot;),releasesVersion(&quot;1.0.7&quot;).</p> <p>The special characters ~ and &quot; need to be escaped using a ~ (e.g. double quote search entityName(&quot;~&quot;&quot;).</p> <i>default:</i> <code>""</code> |
5066
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p> <i>default:</i> <code>"name"</code> |
5067
- | 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> |
5063
+ | Name | Type | Description |
5064
+ | ----------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5065
+ | config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>). <i>default:</i> <code>false</code> |
5066
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
5067
+ | 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> |
5068
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
5069
+ | config.releasesSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName(&quot;ManagementZone-A&quot;). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState(&quot;Active&quot;) or monitoringState(&quot;Inactive&quot;). You can specify only one monitoring state.</li> <li>Health state: healthState(&quot;HEALTHY&quot;) or healthState(&quot;UNHEALTHY&quot;). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem(&quot;Detected&quot;) or affectedBySecurityProblem(&quot;Not detected&quot;). You can specify only one security vulnerability state.</li> <li>Name: entityName(&quot;name&quot;). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId(&quot;id&quot;).</li> <li>Product: releasesProduct(&quot;product&quot;). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage(&quot;stage&quot;). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion(&quot;version&quot;). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name(&quot;Server&quot;),monitoringState(&quot;Active&quot;),healthState(&quot;HEALTHY&quot;),releasesVersion(&quot;1.0.7&quot;).</p> <p>The special characters &#126; and &quot; need to be escaped using a &#126; (e.g. double quote search entityName(&quot;&#126;&quot;&quot;).</p> <i>default:</i> <code>""</code> |
5070
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p> <i>default:</i> <code>"name"</code> |
5071
+ | 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> |
5068
5072
 
5069
5073
  #### Returns
5070
5074
 
@@ -5377,10 +5381,10 @@ Lists remediation items of a third-party security problem
5377
5381
 
5378
5382
  #### Parameters
5379
5383
 
5380
- | Name | Type | Description |
5381
- | ------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5382
- | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5383
- | config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState(&quot;value&quot;)</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted(&quot;value&quot;)</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets(&quot;value&quot;)</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure(&quot;value&quot;)</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage(&quot;value&quot;)</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired(&quot;value&quot;)</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains(&quot;value&quot;)</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy(&quot;value&quot;)</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains(&quot;value&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5384
+ | Name | Type | Description |
5385
+ | ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5386
+ | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5387
+ | config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState(&quot;value&quot;)</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted(&quot;value&quot;)</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets(&quot;value&quot;)</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure(&quot;value&quot;)</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage(&quot;value&quot;)</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired(&quot;value&quot;)</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains(&quot;value&quot;)</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy(&quot;value&quot;)</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains(&quot;value&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>&#126;</code>) inside quotes:</p> <ul> <li>Tilde <code>&#126;</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5384
5388
 
5385
5389
  #### Returns
5386
5390
 
@@ -5423,11 +5427,11 @@ Lists remediation progress entities
5423
5427
 
5424
5428
  #### Parameters
5425
5429
 
5426
- | Name | Type | Description |
5427
- | --------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5428
- | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5429
- | config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
5430
- | config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state(&quot;value&quot;)</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage(&quot;value&quot;)</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired(&quot;value&quot;)</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains(&quot;value&quot;)</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5430
+ | Name | Type | Description |
5431
+ | --------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5432
+ | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5433
+ | config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
5434
+ | config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state(&quot;value&quot;)</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage(&quot;value&quot;)</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired(&quot;value&quot;)</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains(&quot;value&quot;)</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>&#126;</code>) inside quotes:</p> <ul> <li>Tilde <code>&#126;</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5431
5435
 
5432
5436
  #### Returns
5433
5437
 
@@ -5518,15 +5522,15 @@ Lists all security problems
5518
5522
 
5519
5523
  #### Parameters
5520
5524
 
5521
- | Name | Type | Description |
5522
- | ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5523
- | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
5524
- | 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> |
5525
- | 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> |
5526
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of security problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
5527
- | config.securityProblemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only security problems matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Status: <code>status(&quot;value&quot;)</code>. Find the possible values in the description of the <strong>status</strong> field of the response. If not set, all security problems are returned.</li> <li>Muted: <code>muted(&quot;value&quot;)</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Risk level: <code>riskLevel(&quot;value&quot;)</code>. The Davis risk level. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum risk score: <code>minRiskScore(&quot;5.5&quot;)</code>. The Davis minimum risk score. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum risk score: <code>maxRiskScore(&quot;5.5&quot;)</code>. The Davis maximum risk score. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Base risk level: <code>baseRiskLevel(&quot;value&quot;)</code>. The Base risk level from the CVSS. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum base risk score: <code>minBaseRiskScore(&quot;5.5&quot;)</code>. The minimum base risk score from the CVSS. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum base risk score: <code>maxBaseRiskScore(&quot;5.5&quot;)</code>. The maximum base risk score from the CVSS. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>External vulnerability ID contains: <code>externalVulnerabilityIdContains(&quot;id-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>External vulnerability ID: <code>externalVulnerabilityId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>CVE ID: <code>cveId(&quot;id&quot;)</code>.</li> <li>Risk assessment <code>riskAssessment(&quot;value-1&quot;, &quot;value-2&quot;)</code> Possible values are <code>EXPOSED</code>, <code>SENSITIVE</code>, <code>EXPLOIT</code>, <code>VULNERABLE_FUNCTION_IN_USE</code> and <code>ACCURACY_REDUCED</code>.</li> <li>Related host ID: <code>relatedHostIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related host name: <code>relatedHostNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related host name contains: <code>relatedHostNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes cluster ID: <code>relatedKubernetesClusterIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes cluster name: <code>relatedKubernetesClusterNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related Kubernetes cluster name contains: <code>relatedKubernetesClusterNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes workload ID: <code>relatedKubernetesWorkloadIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes workload name: <code>relatedKubernetesWorkloadNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related Kubernetes workload name contains: <code>relatedKubernetesWorkloadNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</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>Affected process group instance ID: <code>affectedPgiIds(&quot;pgiId-1&quot;, &quot;pgiId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group ID: <code>affectedPgIds(&quot;pgId-1&quot;, &quot;pgId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group name: <code>affectedPgNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case-sensitive.</li> <li>Affected process group name contains: <code>affectedPgNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerable component ID: <code>vulnerableComponentIds(&quot;componentId-1&quot;, &quot;componentId-2&quot;)</code>. Specify component IDs here.</li> <li>Vulnerable component name: <code>vulnerableComponentNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case-sensitive.</li> <li>Vulnerable component name contains: <code>vulnerableComponentNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Host tags: <code>hostTags(&quot;hostTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group tags: <code>pgTags(&quot;pgTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group instance tags: <code>pgiTags(&quot;pgiTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Tags: <code>tags(&quot;tag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.</li> <li>Display ID: <code>displayIds(&quot;S-1234&quot;, &quot;S-5678&quot;)</code>. The <code>EQUALS</code> operator is used.</li> <li>Security problem ID: <code>securityProblemIds(&quot;12544152654387159360&quot;, &quot;5904857564184044850&quot;)</code>. The <code>EQUALS</code> operator is used.</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> <li>Vulnerability type: <code>vulnerabilityType(&quot;type-1&quot;, &quot;type-2&quot;)</code>. Possible values are <code>THIRD_PARTY</code>, <code>CODE_LEVEL</code>, <code>RUNTIME</code>.</li> </ul> <p>Risk score and risk category are mutually exclusive (cannot be used at the same time).</p> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5528
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+status,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: The security problem status (<code>+</code> open first or <code>-</code> resolved first)</li> <li><code>muted</code>: The security problem mute state (<code>+</code> unmuted first or <code>-</code> muted first)</li> <li><code>technology</code>: The security problem technology</li> <li><code>firstSeenTimestamp</code>: The timestamp of the first occurrence of the security problem (<code>+</code> new problems first or <code>-</code> old problems first)</li> <li><code>lastUpdatedTimestamp</code>: The timestamp of the last update of the security problem (<code>+</code> recently updated problems first or <code>-</code> earlier updated problems first)</li> <li><code>securityProblemId</code>: The auto-generated ID of the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>externalVulnerabilityId</code>: The ID of the external vulnerability (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>displayId</code>: The display ID (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>riskAssessment.riskScore</code>: Davis Security Score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.riskLevel</code>: Davis Security Score level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.exposure</code>: Whether the problem is exposed to the internet</li> <li><code>riskAssessment.baseRiskScore</code>: The CVSS score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.baseRiskLevel</code>: The CVSS level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.dataAssets</code>: Whether data assets are affected</li> <li><code>riskAssessment.vulnerableFunctionUsage</code>: Whether vulnerable functions are used</li> <li><code>riskAssessment.assessmentAccuracy</code>: The assessments accuracy (<code>+</code> less accuracy first or <code>-</code> more accuracy first)</li> <li><code>globalCounts.affectedNodes</code>: Number of affected nodes (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroupInstances</code>: Number of affected process group instances (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroups</code>: Number of affected process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.exposedProcessGroups</code>: Number of exposed process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.reachableDataAssets</code>: Number of reachable data assets (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedApplications</code>: Number of related applications (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedAttacks</code>: Number of attacks on the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedHosts</code>: Number of related hosts (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesClusters</code>: Number of related Kubernetes cluster (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesWorkloads</code>: Number of related Kubernetes workloads (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedServices</code>: Number of related services (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.vulnerableComponents</code>: Number of vulnerable components (<code>+</code> lower number first or <code>-</code> higher number first)</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> |
5529
- | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> <p>The end of the timeframe must not be older than 365 days.</p> |
5525
+ | Name | Type | Description |
5526
+ | ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5527
+ | config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
5528
+ | 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> |
5529
+ | 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> |
5530
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of security problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
5531
+ | config.securityProblemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only security problems matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Status: <code>status(&quot;value&quot;)</code>. Find the possible values in the description of the <strong>status</strong> field of the response. If not set, all security problems are returned.</li> <li>Muted: <code>muted(&quot;value&quot;)</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Risk level: <code>riskLevel(&quot;value&quot;)</code>. The Davis risk level. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum risk score: <code>minRiskScore(&quot;5.5&quot;)</code>. The Davis minimum risk score. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum risk score: <code>maxRiskScore(&quot;5.5&quot;)</code>. The Davis maximum risk score. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Base risk level: <code>baseRiskLevel(&quot;value&quot;)</code>. The Base risk level from the CVSS. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum base risk score: <code>minBaseRiskScore(&quot;5.5&quot;)</code>. The minimum base risk score from the CVSS. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum base risk score: <code>maxBaseRiskScore(&quot;5.5&quot;)</code>. The maximum base risk score from the CVSS. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>External vulnerability ID contains: <code>externalVulnerabilityIdContains(&quot;id-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>External vulnerability ID: <code>externalVulnerabilityId(&quot;id-1&quot;, &quot;id-2&quot;)</code>.</li> <li>CVE ID: <code>cveId(&quot;id&quot;)</code>.</li> <li>Risk assessment <code>riskAssessment(&quot;value-1&quot;, &quot;value-2&quot;)</code> Possible values are <code>EXPOSED</code>, <code>SENSITIVE</code>, <code>EXPLOIT</code>, <code>VULNERABLE_FUNCTION_IN_USE</code> and <code>ACCURACY_REDUCED</code>.</li> <li>Related host ID: <code>relatedHostIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related host name: <code>relatedHostNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related host name contains: <code>relatedHostNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes cluster ID: <code>relatedKubernetesClusterIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes cluster name: <code>relatedKubernetesClusterNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related Kubernetes cluster name contains: <code>relatedKubernetesClusterNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes workload ID: <code>relatedKubernetesWorkloadIds(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes workload name: <code>relatedKubernetesWorkloadNames(&quot;value-1&quot;, &quot;value-2&quot;)</code>. Values are case-sensitive.</li> <li>Related Kubernetes workload name contains: <code>relatedKubernetesWorkloadNameContains(&quot;value-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</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>Affected process group instance ID: <code>affectedPgiIds(&quot;pgiId-1&quot;, &quot;pgiId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group ID: <code>affectedPgIds(&quot;pgId-1&quot;, &quot;pgId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group name: <code>affectedPgNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case-sensitive.</li> <li>Affected process group name contains: <code>affectedPgNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerable component ID: <code>vulnerableComponentIds(&quot;componentId-1&quot;, &quot;componentId-2&quot;)</code>. Specify component IDs here.</li> <li>Vulnerable component name: <code>vulnerableComponentNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case-sensitive.</li> <li>Vulnerable component name contains: <code>vulnerableComponentNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> <li>Host tags: <code>hostTags(&quot;hostTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group tags: <code>pgTags(&quot;pgTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group instance tags: <code>pgiTags(&quot;pgiTag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Tags: <code>tags(&quot;tag-1&quot;)</code>. The <code>CONTAINS</code> operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.</li> <li>Display ID: <code>displayIds(&quot;S-1234&quot;, &quot;S-5678&quot;)</code>. The <code>EQUALS</code> operator is used.</li> <li>Security problem ID: <code>securityProblemIds(&quot;12544152654387159360&quot;, &quot;5904857564184044850&quot;)</code>. The <code>EQUALS</code> operator is used.</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> <li>Vulnerability type: <code>vulnerabilityType(&quot;type-1&quot;, &quot;type-2&quot;)</code>. Possible values are <code>THIRD_PARTY</code>, <code>CODE_LEVEL</code>, <code>RUNTIME</code>.</li> </ul> <p>Risk score and risk category are mutually exclusive (cannot be used at the same time).</p> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>&#126;</code>) inside quotes:</p> <ul> <li>Tilde <code>&#126;</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5532
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+status,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: The security problem status (<code>+</code> open first or <code>-</code> resolved first)</li> <li><code>muted</code>: The security problem mute state (<code>+</code> unmuted first or <code>-</code> muted first)</li> <li><code>technology</code>: The security problem technology</li> <li><code>firstSeenTimestamp</code>: The timestamp of the first occurrence of the security problem (<code>+</code> new problems first or <code>-</code> old problems first)</li> <li><code>lastUpdatedTimestamp</code>: The timestamp of the last update of the security problem (<code>+</code> recently updated problems first or <code>-</code> earlier updated problems first)</li> <li><code>securityProblemId</code>: The auto-generated ID of the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>externalVulnerabilityId</code>: The ID of the external vulnerability (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>displayId</code>: The display ID (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>riskAssessment.riskScore</code>: Davis Security Score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.riskLevel</code>: Davis Security Score level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.exposure</code>: Whether the problem is exposed to the internet</li> <li><code>riskAssessment.baseRiskScore</code>: The CVSS score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.baseRiskLevel</code>: The CVSS level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.dataAssets</code>: Whether data assets are affected</li> <li><code>riskAssessment.vulnerableFunctionUsage</code>: Whether vulnerable functions are used</li> <li><code>riskAssessment.assessmentAccuracy</code>: The assessments accuracy (<code>+</code> less accuracy first or <code>-</code> more accuracy first)</li> <li><code>globalCounts.affectedNodes</code>: Number of affected nodes (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroupInstances</code>: Number of affected process group instances (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroups</code>: Number of affected process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.exposedProcessGroups</code>: Number of exposed process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.reachableDataAssets</code>: Number of reachable data assets (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedApplications</code>: Number of related applications (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedAttacks</code>: Number of attacks on the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedHosts</code>: Number of related hosts (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesClusters</code>: Number of related Kubernetes cluster (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesWorkloads</code>: Number of related Kubernetes workloads (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedServices</code>: Number of related services (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.vulnerableComponents</code>: Number of vulnerable components (<code>+</code> lower number first or <code>-</code> higher number first)</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> |
5533
+ | config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> <p>The end of the timeframe must not be older than 365 days.</p> |
5530
5534
 
5531
5535
  #### Returns
5532
5536
 
@@ -5567,11 +5571,11 @@ Lists all vulnerable functions and their usage for a third-party security proble
5567
5571
 
5568
5572
  #### Parameters
5569
5573
 
5570
- | Name | Type | Description |
5571
- | ---------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
5572
- | config.groupBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines additional grouping types in which vulnerable functions should be displayed.</p> <p>You can add one of the following grouping types.</p> <ul> <li>Process group: <code>PROCESS_GROUP</code></li> </ul> |
5573
- | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5574
- | config.vulnerableFunctionsSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.</p> <p>You can add the following criteria. Values are <em>not</em> case sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Management zone ID: <code>managementZoneIds(&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>Process group ID: <code>processGroupIds(&quot;pgId-1&quot;, &quot;pgId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Process group name: <code>processGroupNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case sensitive.</li> <li>Process group name contains: <code>processGroupNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5574
+ | Name | Type | Description |
5575
+ | ---------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5576
+ | config.groupBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines additional grouping types in which vulnerable functions should be displayed.</p> <p>You can add one of the following grouping types.</p> <ul> <li>Process group: <code>PROCESS_GROUP</code></li> </ul> |
5577
+ | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5578
+ | config.vulnerableFunctionsSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.</p> <p>You can add the following criteria. Values are <em>not</em> case sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Management zone ID: <code>managementZoneIds(&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>Process group ID: <code>processGroupIds(&quot;pgId-1&quot;, &quot;pgId-2&quot;)</code>. Specify Dynatrace entity IDs here.</li> <li>Process group name: <code>processGroupNames(&quot;name-1&quot;, &quot;name-2&quot;)</code>. Values are case sensitive.</li> <li>Process group name contains: <code>processGroupNameContains(&quot;name-1&quot;)</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>&#126;</code>) inside quotes:</p> <ul> <li>Tilde <code>&#126;</code></li> <li>Quote <code>&quot;</code></li> </ul> |
5575
5579
 
5576
5580
  #### Returns
5577
5581
 
@@ -5616,7 +5620,7 @@ Mutes a security problem
5616
5620
  | config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> | |
5617
5621
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
5618
5622
 
5619
- <!-- no returns -->
5623
+ {/* no returns */}
5620
5624
 
5621
5625
  <details>
5622
5626
  <summary>
@@ -5659,7 +5663,7 @@ Sets the mute state of a remediation item
5659
5663
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5660
5664
  | config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
5661
5665
 
5662
- <!-- no returns -->
5666
+ {/* no returns */}
5663
5667
 
5664
5668
  <details>
5665
5669
  <summary>
@@ -5702,7 +5706,7 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
5702
5706
  | config.body<sup>\*required</sup> | <a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a> | |
5703
5707
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
5704
5708
 
5705
- <!-- no returns -->
5709
+ {/* no returns */}
5706
5710
 
5707
5711
  <details>
5708
5712
  <summary>
@@ -5744,7 +5748,7 @@ Un-mutes a security problem
5744
5748
  | config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> | |
5745
5749
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
5746
5750
 
5747
- <!-- no returns -->
5751
+ {/* no returns */}
5748
5752
 
5749
5753
  <details>
5750
5754
  <summary>
@@ -5844,7 +5848,7 @@ Creates a new SLO
5844
5848
  | -------------------------------- | -------------------------------------------------------- |
5845
5849
  | config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> |
5846
5850
 
5847
- <!-- no returns -->
5851
+ {/* no returns */}
5848
5852
 
5849
5853
  <details>
5850
5854
  <summary>
@@ -5892,7 +5896,7 @@ Deletes an SLO
5892
5896
  | ------------------------------ | ----------------------------------------------------------------------------- |
5893
5897
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
5894
5898
 
5895
- <!-- no returns -->
5899
+ {/* no returns */}
5896
5900
 
5897
5901
  <details>
5898
5902
  <summary>
@@ -5936,19 +5940,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
5936
5940
 
5937
5941
  #### Parameters
5938
5942
 
5939
- | Name | Type | Description |
5940
- | --------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5941
- | config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). <i>default:</i> <code>false</code> |
5942
- | config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). <i>default:</i> <code>"true"</code> |
5943
- | config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. <i>default:</i> <code>"false"</code> |
5944
- | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
5945
- | 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> |
5946
- | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
5947
- | config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). <i>default:</i> <code>true</code> |
5948
- | config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id(&quot;id-1&quot;,&quot;id-2&quot;)</code>.</li> <li>Name: <code>name(&quot;name&quot;)</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState(&quot;HEALTHY&quot;)</code> or <code>healthState(&quot;UNHEALTHY&quot;)</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text(&quot;value&quot;)</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName(&quot;value&quot;)</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone(&quot;MZ-A&quot;)</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID(&quot;123&quot;)</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name(&quot;Service Availability&quot;)</li> <li>.../api/v2/slo?sloSelector=id(&quot;id&quot;)</li> <li>.../api/v2/slo?sloSelector=text(&quot;Description&quot;),healthState(&quot;HEALTHY&quot;).</li> </ul> <p>The special characters <code>~</code> and <code>&quot;</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text(&quot;~&quot;&quot;)</code>).</p> <i>default:</i> <code>""</code> |
5949
- | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> <i>default:</i> <code>"name"</code> |
5950
- | config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
5951
- | 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> |
5943
+ | Name | Type | Description |
5944
+ | --------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5945
+ | config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). <i>default:</i> <code>false</code> |
5946
+ | config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). <i>default:</i> <code>"true"</code> |
5947
+ | config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. <i>default:</i> <code>"false"</code> |
5948
+ | config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
5949
+ | 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> |
5950
+ | config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
5951
+ | config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). <i>default:</i> <code>true</code> |
5952
+ | config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id(&quot;id-1&quot;,&quot;id-2&quot;)</code>.</li> <li>Name: <code>name(&quot;name&quot;)</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState(&quot;HEALTHY&quot;)</code> or <code>healthState(&quot;UNHEALTHY&quot;)</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text(&quot;value&quot;)</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName(&quot;value&quot;)</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone(&quot;MZ-A&quot;)</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID(&quot;123&quot;)</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name(&quot;Service Availability&quot;)</li> <li>.../api/v2/slo?sloSelector=id(&quot;id&quot;)</li> <li>.../api/v2/slo?sloSelector=text(&quot;Description&quot;),healthState(&quot;HEALTHY&quot;).</li> </ul> <p>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>).</p> <i>default:</i> <code>""</code> |
5953
+ | config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> <i>default:</i> <code>"name"</code> |
5954
+ | config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
5955
+ | 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> |
5952
5956
 
5953
5957
  #### Returns
5954
5958
 
@@ -6044,7 +6048,7 @@ Updates an existing SLO
6044
6048
  | config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> | |
6045
6049
  | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
6046
6050
 
6047
- <!-- no returns -->
6051
+ {/* no returns */}
6048
6052
 
6049
6053
  <details>
6050
6054
  <summary>
@@ -6100,7 +6104,7 @@ Deletes the specified settings object
6100
6104
  | config.objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required settings object. |
6101
6105
  | config.updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
6102
6106
 
6103
- <!-- no returns -->
6107
+ {/* no returns */}
6104
6108
 
6105
6109
  <details>
6106
6110
  <summary>
@@ -6401,7 +6405,7 @@ Lists available settings schemas
6401
6405
 
6402
6406
  </div>
6403
6407
 
6404
- <!-- no parameters -->
6408
+ {/* no parameters */}
6405
6409
 
6406
6410
  #### Returns
6407
6411
 
@@ -6582,7 +6586,7 @@ Gets set of synthetic related parameters defined for whole tenant (affects all m
6582
6586
 
6583
6587
  </div>
6584
6588
 
6585
- <!-- no parameters -->
6589
+ {/* no parameters */}
6586
6590
 
6587
6591
  #### Returns
6588
6592
 
@@ -6837,7 +6841,7 @@ Checks the status of public synthetic locations
6837
6841
 
6838
6842
  </div>
6839
6843
 
6840
- <!-- no parameters -->
6844
+ {/* no parameters */}
6841
6845
 
6842
6846
  #### Returns
6843
6847
 
@@ -6916,7 +6920,7 @@ Lists all synthetic nodes available in your environment
6916
6920
 
6917
6921
  </div>
6918
6922
 
6919
- <!-- no parameters -->
6923
+ {/* no parameters */}
6920
6924
 
6921
6925
  #### Returns
6922
6926
 
@@ -6958,7 +6962,7 @@ Deletes the specified private synthetic location
6958
6962
  | -------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
6959
6963
  | config.locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the private synthetic location to be deleted. |
6960
6964
 
6961
- <!-- no returns -->
6965
+ {/* no returns */}
6962
6966
 
6963
6967
  <details>
6964
6968
  <summary>
@@ -7044,7 +7048,7 @@ For public locations you can only change the location status.
7044
7048
  | config.body<sup>\*required</sup> | <a href="#syntheticlocationupdate">SyntheticLocationUpdate</a> | |
7045
7049
  | config.locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the synthetic location to be updated. |
7046
7050
 
7047
- <!-- no returns -->
7051
+ {/* no returns */}
7048
7052
 
7049
7053
  <details>
7050
7054
  <summary>
@@ -7084,7 +7088,7 @@ Changes the status of public synthetic locations
7084
7088
  | -------------------------------- | ---------------------------------------------------------------------------- |
7085
7089
  | config.body<sup>\*required</sup> | <a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a> |
7086
7090
 
7087
- <!-- no returns -->
7091
+ {/* no returns */}
7088
7092
 
7089
7093
  <details>
7090
7094
  <summary>
@@ -7171,7 +7175,7 @@ Deletes a synthetic monitor definition for the given monitor ID. Currently netwo
7171
7175
  | ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------ |
7172
7176
  | config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
7173
7177
 
7174
- <!-- no returns -->
7178
+ {/* no returns */}
7175
7179
 
7176
7180
  <details>
7177
7181
  <summary>
@@ -7294,7 +7298,7 @@ Updates a synthetic monitor definition for the given monitor ID. Currently netwo
7294
7298
  | config.body<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a> | |
7295
7299
  | config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
7296
7300
 
7297
- <!-- no returns -->
7301
+ {/* no returns */}
7298
7302
 
7299
7303
  <details>
7300
7304
  <summary>
@@ -7778,20 +7782,20 @@ Short representation of the alerting profile.
7778
7782
 
7779
7783
  Metadata of an API token.
7780
7784
 
7781
- | Name | Type | Description |
7782
- | ------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7783
- | additionalMetadata | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
7784
- | creationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token creation date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
7785
- | enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is enabled (<code>true</code>) or disabled (<code>false</code>). |
7786
- | expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Token expiration date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).</p> <p>If not set, the token never expires.</p> |
7787
- | id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the token, consisting of prefix and public part of the token. |
7788
- | lastUsedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
7789
- | lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used IP address. |
7790
- | modifiedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last modified date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>). Updating scopes or name counts as modification, enabling or disabling a token does not. |
7791
- | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
7792
- | owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the token. |
7793
- | personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is a <a href="https://dt-url.net/wm03sop">personal access token</a> (<code>true</code>) or an API token (<code>false</code>). |
7794
- | scopes | Array&lt;ApiTokenScopesItem&gt; | A list of scopes assigned to the token. |
7785
+ | Name | Type | Description |
7786
+ | ------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7787
+ | additionalMetadata | ApiTokenAdditionalMetadata | |
7788
+ | creationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token creation date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
7789
+ | enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is enabled (<code>true</code>) or disabled (<code>false</code>). |
7790
+ | expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Token expiration date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).</p> <p>If not set, the token never expires.</p> |
7791
+ | id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the token, consisting of prefix and public part of the token. |
7792
+ | lastUsedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
7793
+ | lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used IP address. |
7794
+ | modifiedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last modified date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>). Updating scopes or name counts as modification, enabling or disabling a token does not. |
7795
+ | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
7796
+ | owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the token. |
7797
+ | personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is a <a href="https://dt-url.net/wm03sop">personal access token</a> (<code>true</code>) or an API token (<code>false</code>). |
7798
+ | scopes | Array&lt;ApiTokenScopesItem&gt; | A list of scopes assigned to the token. |
7795
7799
 
7796
7800
  ### ApiTokenCreate
7797
7801
 
@@ -7905,20 +7909,20 @@ The audit log of your environment.
7905
7909
 
7906
7910
  An entry of the audit log.
7907
7911
 
7908
- | Name | Type | Description |
7909
- | ---------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7910
- | category<sup>\*required</sup> | AuditLogEntryCategory | |
7911
- | entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of an entity from the <strong>category</strong>.</p> <p>For example, it can be config ID for the <code>CONFIG</code> category or token ID for the <code>TOKEN</code> category.</p> |
7912
- | environmentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the Dynatrace environment where the recorded operation occurred. |
7913
- | eventType<sup>\*required</sup> | AuditLogEntryEventType | |
7914
- | logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the log entry. |
7915
- | message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The logged message. |
7916
- | patch | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
7917
- | success<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The recorded operation is successful (<code>true</code>) or failed (<code>false</code>). |
7918
- | timestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the record creation, in UTC milliseconds. |
7919
- | user<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the user who performed the recorded operation. |
7920
- | userOrigin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin and the IP address of the <strong>user</strong>. |
7921
- | userType<sup>\*required</sup> | AuditLogEntryUserType | |
7912
+ | Name | Type | Description |
7913
+ | ---------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7914
+ | category<sup>\*required</sup> | AuditLogEntryCategory | |
7915
+ | entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of an entity from the <strong>category</strong>.</p> <p>For example, it can be config ID for the <code>CONFIG</code> category or token ID for the <code>TOKEN</code> category.</p> |
7916
+ | environmentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the Dynatrace environment where the recorded operation occurred. |
7917
+ | eventType<sup>\*required</sup> | AuditLogEntryEventType | |
7918
+ | logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the log entry. |
7919
+ | message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The logged message. |
7920
+ | patch | AuditLogEntryPatch | |
7921
+ | success<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The recorded operation is successful (<code>true</code>) or failed (<code>false</code>). |
7922
+ | timestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the record creation, in UTC milliseconds. |
7923
+ | user<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the user who performed the recorded operation. |
7924
+ | userOrigin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin and the IP address of the <strong>user</strong>. |
7925
+ | userType<sup>\*required</sup> | AuditLogEntryUserType | |
7922
7926
 
7923
7927
  ### AuthorDto
7924
7928
 
@@ -8076,20 +8080,20 @@ A credentials set of the `CERTIFICATE` type.
8076
8080
 
8077
8081
  CloudEvents is a [specification](https://github.com/cloudevents/spec/blob/v1.0/spec.json) for describing event data in common formats to provide interoperability across services, platforms and systems.
8078
8082
 
8079
- | Name | Type | Description |
8080
- | -------------------------------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8081
- | data | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
8082
- | data_base64 | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8083
- | datacontenttype | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8084
- | dataschema | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8085
- | dtcontext | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Dynatrace context |
8086
- | id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8087
- | source<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8088
- | specversion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8089
- | subject | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8090
- | time | Date | |
8091
- | traceparent | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Trace related to this event. See <a href="https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/distributed-tracing.md">distributed tracing</a> for further information. |
8092
- | type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8083
+ | Name | Type | Description |
8084
+ | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8085
+ | data | Record&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> &#124; <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>&gt; | |
8086
+ | data_base64 | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8087
+ | datacontenttype | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8088
+ | dataschema | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8089
+ | dtcontext | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Dynatrace context |
8090
+ | id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8091
+ | source<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8092
+ | specversion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8093
+ | subject | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8094
+ | time | Date | |
8095
+ | traceparent | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Trace related to this event. See <a href="https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/distributed-tracing.md">distributed tracing</a> for further information. |
8096
+ | type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
8093
8097
 
8094
8098
  ### CodeLevelVulnerabilityDetails
8095
8099
 
@@ -8510,18 +8514,18 @@ A constraint on the values that are going to be deleted.
8510
8514
 
8511
8515
  An effective settings value.
8512
8516
 
8513
- | Name | Type | Description |
8514
- | ------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
8515
- | author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
8516
- | created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
8517
- | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
8518
- | modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
8519
- | origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin of the settings value. |
8520
- | schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
8521
- | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
8522
- | searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
8523
- | summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
8524
- | value | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
8517
+ | Name | Type | Description |
8518
+ | ------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
8519
+ | author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
8520
+ | created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
8521
+ | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
8522
+ | modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
8523
+ | origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin of the settings value. |
8524
+ | schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
8525
+ | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
8526
+ | searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
8527
+ | summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
8528
+ | value | SettingsValue | |
8525
8529
 
8526
8530
  ### EffectiveSettingsValuesList
8527
8531
 
@@ -8696,13 +8700,13 @@ Definition of an enum property.
8696
8700
 
8697
8701
  An allowed value for an enum property.
8698
8702
 
8699
- | Name | Type | Description |
8700
- | -------------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------- |
8701
- | description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the value. |
8702
- | displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the value. |
8703
- | enumInstance | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the value in an existing Java enum class. |
8704
- | icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The icon of the value. |
8705
- | value<sup>\*required</sup> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
8703
+ | Name | Type | Description |
8704
+ | -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
8705
+ | description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the value. |
8706
+ | displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the value. |
8707
+ | enumInstance | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the value in an existing Java enum class. |
8708
+ | icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The icon of the value. |
8709
+ | value<sup>\*required</sup> | EnumValueValue | |
8706
8710
 
8707
8711
  ### Error
8708
8712
 
@@ -9054,11 +9058,11 @@ A list of extensions with additional metadata.
9054
9058
 
9055
9059
  ### ExtensionMonitoringConfiguration
9056
9060
 
9057
- | Name | Type | Description |
9058
- | ----------------------------- | ---------------------------------------------------------------------------------------- | ------------------- |
9059
- | objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration id |
9060
- | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration scope |
9061
- | value<sup>\*required</sup> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
9061
+ | Name | Type | Description |
9062
+ | ----------------------------- | ----------------------------------------------------------------------------- | ------------------- |
9063
+ | objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration id |
9064
+ | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration scope |
9065
+ | value<sup>\*required</sup> | ExtensionMonitoringConfigurationValue | |
9062
9066
 
9063
9067
  ### ExtensionMonitoringConfigurationsList
9064
9068
 
@@ -9727,10 +9731,10 @@ A list of entities and their monitoring states.
9727
9731
 
9728
9732
  ### MonitoringConfigurationDto
9729
9733
 
9730
- | Name | Type | Description |
9731
- | -------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
9732
- | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope this monitoring configuration will be defined for |
9733
- | value | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
9734
+ | Name | Type | Description |
9735
+ | -------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------- |
9736
+ | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope this monitoring configuration will be defined for |
9737
+ | value | JsonNode | |
9734
9738
 
9735
9739
  ### MonitoringConfigurationResponse
9736
9740
 
@@ -9741,9 +9745,9 @@ A list of entities and their monitoring states.
9741
9745
 
9742
9746
  ### MonitoringConfigurationUpdateDto
9743
9747
 
9744
- | Name | Type |
9745
- | ----- | ---------------------------------------------------------------------------------------- |
9746
- | value | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> |
9748
+ | Name | Type |
9749
+ | ----- | -------- |
9750
+ | value | JsonNode |
9747
9751
 
9748
9752
  ### MuteState
9749
9753
 
@@ -9864,15 +9868,15 @@ A list of settings objects.
9864
9868
 
9865
9869
  A precondition for visibility of a property.
9866
9870
 
9867
- | Name | Type | Description |
9868
- | ------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
9869
- | expectedValue | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
9870
- | expectedValues | Array&lt;<a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>&gt; | <p>A list of valid values of the property.</p> <p>Only applicable to properties of the <code>IN</code> type.</p> |
9871
- | pattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The Regular expression which is matched against the property.</p> <p>Only applicable to properties of the <code>REGEX_MATCH</code> type.</p> |
9872
- | precondition | <a href="#precondition">Precondition</a> | |
9873
- | preconditions | Array&lt;<a href="#precondition">Precondition</a>&gt; | <p>A list of child preconditions to be evaluated.</p> <p>Only applicable to properties of the <code>AND</code> and <code>OR</code> types.</p> |
9874
- | property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The property to be evaluated. |
9875
- | type<sup>\*required</sup> | PreconditionType | |
9871
+ | Name | Type | Description |
9872
+ | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
9873
+ | expectedValue | PreconditionExpectedValue | |
9874
+ | expectedValues | Array&lt;Record&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> &#124; <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>&gt;&gt; | <p>A list of valid values of the property.</p> <p>Only applicable to properties of the <code>IN</code> type.</p> |
9875
+ | pattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The Regular expression which is matched against the property.</p> <p>Only applicable to properties of the <code>REGEX_MATCH</code> type.</p> |
9876
+ | precondition | <a href="#precondition">Precondition</a> | |
9877
+ | preconditions | Array&lt;<a href="#precondition">Precondition</a>&gt; | <p>A list of child preconditions to be evaluated.</p> <p>Only applicable to properties of the <code>AND</code> and <code>OR</code> types.</p> |
9878
+ | property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The property to be evaluated. |
9879
+ | type<sup>\*required</sup> | PreconditionType | |
9876
9880
 
9877
9881
  ### PrivateSyntheticLocation
9878
9882
 
@@ -9880,26 +9884,26 @@ Configuration of a private synthetic location.
9880
9884
 
9881
9885
  Some fields are inherited from the base _SyntheticLocation_ object.
9882
9886
 
9883
- | Name | Type | Description |
9884
- | -------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9885
- | autoUpdateChromium | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Auto upgrade of Chromium is enabled (<code>true</code>) or disabled (<code>false</code>). |
9886
- | availabilityLocationOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
9887
- | availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \n\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
9888
- | availabilityNotificationsEnabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
9889
- | city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
9890
- | countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go">GET all countries</a> request.</p> |
9891
- | deploymentType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
9892
- | entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location. |
9893
- | geoLocationId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location. |
9894
- | 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. |
9895
- | 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. |
9896
- | 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. |
9897
- | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
9898
- | 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> |
9899
- | 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> |
9900
- | status | SyntheticLocationStatus | |
9901
- | type<sup>\*required</sup> | SyntheticLocationType | |
9902
- | useNewKubernetesVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
9887
+ | Name | Type | Description |
9888
+ | -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9889
+ | autoUpdateChromium | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Auto upgrade of Chromium is enabled (<code>true</code>) or disabled (<code>false</code>). |
9890
+ | availabilityLocationOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
9891
+ | availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
9892
+ | availabilityNotificationsEnabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
9893
+ | city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
9894
+ | countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go">GET all countries</a> request.</p> |
9895
+ | deploymentType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
9896
+ | entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location. |
9897
+ | geoLocationId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location. |
9898
+ | 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
+ | 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
+ | 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. |
9901
+ | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
9902
+ | 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
+ | 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> |
9904
+ | status | SyntheticLocationStatus | |
9905
+ | type<sup>\*required</sup> | SyntheticLocationType | |
9906
+ | useNewKubernetesVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
9903
9907
 
9904
9908
  ### Problem
9905
9909
 
@@ -9970,27 +9974,27 @@ The vulnerable functions of a process group including their usage.
9970
9974
 
9971
9975
  Configuration of a property in a settings schema.
9972
9976
 
9973
- | Name | Type | Description |
9974
- | ------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
9975
- | constraints | Array&lt;<a href="#constraint">Constraint</a>&gt; | A list of constraints limiting the values to be accepted. |
9976
- | datasource | <a href="#datasourcedefinition">DatasourceDefinition</a> | |
9977
- | default | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
9978
- | description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the property. |
9979
- | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the property. |
9980
- | documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | An extended description and/or links to documentation. |
9981
- | forceSecretResubmission | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Defines if value is allowed to be modified when secret properties are not |
9982
- | items | <a href="#item">Item</a> | |
9983
- | maxObjects<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
9984
- | metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a> | |
9985
- | migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pattern with references to properties to create a new value. |
9986
- | minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The minimum number of <strong>objects</strong> in a collection property. |
9987
- | modificationPolicy | PropertyDefinitionModificationPolicy | |
9988
- | nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
9989
- | precondition | <a href="#precondition">Precondition</a> | |
9990
- | referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type referenced by the property value |
9991
- | subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The subtype of the property's value. |
9992
- | type<sup>\*required</sup> | PropertyDefinitionType | |
9993
- | uiCustomization | <a href="#uicustomization">UiCustomization</a> | |
9977
+ | Name | Type | Description |
9978
+ | ------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
9979
+ | constraints | Array&lt;<a href="#constraint">Constraint</a>&gt; | A list of constraints limiting the values to be accepted. |
9980
+ | datasource | <a href="#datasourcedefinition">DatasourceDefinition</a> | |
9981
+ | default | PropertyDefinitionDefault | |
9982
+ | description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the property. |
9983
+ | displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the property. |
9984
+ | documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | An extended description and/or links to documentation. |
9985
+ | forceSecretResubmission | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Defines if value is allowed to be modified when secret properties are not |
9986
+ | items | <a href="#item">Item</a> | |
9987
+ | maxObjects<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
9988
+ | metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a> | |
9989
+ | migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pattern with references to properties to create a new value. |
9990
+ | minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The minimum number of <strong>objects</strong> in a collection property. |
9991
+ | modificationPolicy | PropertyDefinitionModificationPolicy | |
9992
+ | nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
9993
+ | precondition | <a href="#precondition">Precondition</a> | |
9994
+ | referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type referenced by the property value |
9995
+ | subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The subtype of the property's value. |
9996
+ | type<sup>\*required</sup> | PropertyDefinitionType | |
9997
+ | uiCustomization | <a href="#uicustomization">UiCustomization</a> | |
9994
9998
 
9995
9999
  ### PropertyDefinitionMetadata
9996
10000
 
@@ -10129,7 +10133,7 @@ A Release is a combination of a component and a version.
10129
10133
  A Component can be any form of deployable that can be associated with a version.
10130
10134
  In the first draft, a Component is always a Service.
10131
10135
 
10132
- The tuple <name, product, stage, version> is always unique.
10136
+ The tuple &lt;name, product, stage, version&gt; is always unique.
10133
10137
 
10134
10138
  | Name | Type | Description |
10135
10139
  | --------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
@@ -10798,60 +10802,60 @@ Analysis of problem impact to a service.
10798
10802
 
10799
10803
  A settings object.
10800
10804
 
10801
- | Name | Type | Description |
10802
- | ---------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10803
- | author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
10804
- | created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
10805
- | createdBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who created the settings object. |
10806
- | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
10807
- | modificationInfo | <a href="#modificationinfo">ModificationInfo</a> | |
10808
- | modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
10809
- | modifiedBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who performed the most recent modification. |
10810
- | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the settings object. |
10811
- | schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
10812
- | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10813
- | scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
10814
- | searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
10815
- | summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
10816
- | updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
10817
- | value | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
10805
+ | Name | Type | Description |
10806
+ | ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10807
+ | author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
10808
+ | created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
10809
+ | createdBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who created the settings object. |
10810
+ | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
10811
+ | modificationInfo | <a href="#modificationinfo">ModificationInfo</a> | |
10812
+ | modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
10813
+ | modifiedBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who performed the most recent modification. |
10814
+ | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the settings object. |
10815
+ | schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
10816
+ | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10817
+ | scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
10818
+ | searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
10819
+ | summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
10820
+ | updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
10821
+ | value | SettingsValue | |
10818
10822
 
10819
10823
  ### SettingsObjectCreate
10820
10824
 
10821
10825
  Configuration of a new settings object.
10822
10826
 
10823
- | Name | Type | Description |
10824
- | ----------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10825
- | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | External identifier for the object being created |
10826
- | insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the new object. The new object will be added after the specified one.</p> <p>If <code>null</code>, the new object will be placed in the last position.</p> <p>If set to empty string, the new object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <code>ordered</code> parameter is set to <code>true</code>).</p> |
10827
- | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of the settings object that should be replaced.</p> <p>Only applicable if an external identifier is provided.</p> |
10828
- | schemaId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
10829
- | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10830
- | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
10831
- | value<sup>\*required</sup> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
10827
+ | Name | Type | Description |
10828
+ | ----------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10829
+ | externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | External identifier for the object being created |
10830
+ | insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the new object. The new object will be added after the specified one.</p> <p>If <code>null</code>, the new object will be placed in the last position.</p> <p>If set to empty string, the new object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <code>ordered</code> parameter is set to <code>true</code>).</p> |
10831
+ | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of the settings object that should be replaced.</p> <p>Only applicable if an external identifier is provided.</p> |
10832
+ | schemaId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
10833
+ | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10834
+ | scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
10835
+ | value<sup>\*required</sup> | SettingsValue | |
10832
10836
 
10833
10837
  ### SettingsObjectResponse
10834
10838
 
10835
10839
  The response to a creation- or update-request.
10836
10840
 
10837
- | Name | Type | Description |
10838
- | ------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
10839
- | code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP status code for the object. |
10840
- | error | <a href="#error">Error</a> | |
10841
- | invalidValue | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
10842
- | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | For a successful request, the ID of the created or modified settings object. |
10841
+ | Name | Type | Description |
10842
+ | ------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
10843
+ | code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP status code for the object. |
10844
+ | error | <a href="#error">Error</a> | |
10845
+ | invalidValue | SettingsValue | |
10846
+ | objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | For a successful request, the ID of the created or modified settings object. |
10843
10847
 
10844
10848
  ### SettingsObjectUpdate
10845
10849
 
10846
10850
  An update of a settings object.
10847
10851
 
10848
- | Name | Type | Description |
10849
- | -------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10850
- | insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved behind the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertBefore</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
10851
- | insertBefore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved in front of the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertAfter</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the last position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
10852
- | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10853
- | updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
10854
- | value<sup>\*required</sup> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
10852
+ | Name | Type | Description |
10853
+ | -------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10854
+ | insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved behind the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertBefore</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
10855
+ | insertBefore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved in front of the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertAfter</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the last position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
10856
+ | schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
10857
+ | updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
10858
+ | value<sup>\*required</sup> | SettingsValue | |
10855
10859
 
10856
10860
  ### SloBurnRate
10857
10861
 
@@ -11128,24 +11132,24 @@ String to string map of metadata properties for batch
11128
11132
 
11129
11133
  Describes the status of an on-demand execution.
11130
11134
 
11131
- | Name | Type | Description |
11132
- | ------------------------------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
11133
- | batchId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the batch. |
11134
- | customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
11135
- | dataDeliveryTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when whole data set has been collected on server, in UTC milliseconds. |
11136
- | executionId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the execution. |
11137
- | executionStage<sup>\*required</sup> | SyntheticOnDemandExecutionExecutionStage | |
11138
- | executionTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when execution was finished, in UTC milliseconds. |
11139
- | fullResults | <a href="#executionfullresults">ExecutionFullResults</a> | |
11140
- | locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the location from where the monitor is to be executed. |
11141
- | metadata | <a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a> | |
11142
- | monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
11143
- | nextExecutionId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Next execution id for sequential mode. |
11144
- | processingMode<sup>\*required</sup> | SyntheticOnDemandExecutionProcessingMode | |
11145
- | schedulingTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The scheduling timestamp, in UTC milliseconds. |
11146
- | simpleResults | <a href="#executionsimpleresults">ExecutionSimpleResults</a> | |
11147
- | source<sup>\*required</sup> | SyntheticOnDemandExecutionSource | |
11148
- | userId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the user who triggered the on-demand execution. |
11135
+ | Name | Type | Description |
11136
+ | ------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
11137
+ | batchId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the batch. |
11138
+ | customizedScript | ObjectNode | |
11139
+ | dataDeliveryTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when whole data set has been collected on server, in UTC milliseconds. |
11140
+ | executionId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the execution. |
11141
+ | executionStage<sup>\*required</sup> | SyntheticOnDemandExecutionExecutionStage | |
11142
+ | executionTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when execution was finished, in UTC milliseconds. |
11143
+ | fullResults | <a href="#executionfullresults">ExecutionFullResults</a> | |
11144
+ | locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the location from where the monitor is to be executed. |
11145
+ | metadata | <a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a> | |
11146
+ | monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
11147
+ | nextExecutionId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Next execution id for sequential mode. |
11148
+ | processingMode<sup>\*required</sup> | SyntheticOnDemandExecutionProcessingMode | |
11149
+ | schedulingTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The scheduling timestamp, in UTC milliseconds. |
11150
+ | simpleResults | <a href="#executionsimpleresults">ExecutionSimpleResults</a> | |
11151
+ | source<sup>\*required</sup> | SyntheticOnDemandExecutionSource | |
11152
+ | userId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the user who triggered the on-demand execution. |
11149
11153
 
11150
11154
  ### SyntheticOnDemandExecutionMetadata
11151
11155
 
@@ -11187,7 +11191,7 @@ Contains monitors to be executed on demand from the locations specified.
11187
11191
 
11188
11192
  | Name | Type | Description |
11189
11193
  | ------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
11190
- | customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
11194
+ | customizedScript | SyntheticOnDemandExecutionRequestMonitorCustomizedScript | |
11191
11195
  | executionCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. <i>default:</i> <code>1</code> |
11192
11196
  | locations | Array&lt;<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>&gt; | The locations from where the monitor is to be executed. |
11193
11197
  | monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier. |
@@ -11264,13 +11268,13 @@ Configuration of a private synthetic location
11264
11268
  | -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11265
11269
  | autoUpdateChromium | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Auto upgrade of Chromium is enabled (<code>true</code>) or disabled (<code>false</code>). |
11266
11270
  | availabilityLocationOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
11267
- | availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \n\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
11271
+ | availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
11268
11272
  | availabilityNotificationsEnabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
11269
11273
  | city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
11270
11274
  | countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go">GET all countries</a> request.</p> |
11271
11275
  | deploymentType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
11272
11276
  | 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. |
11273
- | 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. |
11277
+ | 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. |
11274
11278
  | 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. |
11275
11279
  | name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
11276
11280
  | 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> |