@dynatrace-sdk/client-classic-environment-v2 1.8.0 → 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/README.md +1 -1
- package/cjs/index.js +8816 -1848
- package/docs/DOCS.md +400 -417
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +8816 -1848
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +15 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +12 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-patch.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/cloud-event.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/cloud-event.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details-type.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.d.ts +6 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +0 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/json-node.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/json-node.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitor-request-execution-result.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition-expected-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-default.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts +2 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.transformation.d.ts +2 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.transformation.d.ts +0 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.d.ts +0 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto-type.transformation.d.ts +0 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-properties.transformation.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-properties.transformation.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto-properties.transformation.d.ts +0 -6
package/docs/DOCS.md
CHANGED
|
@@ -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
|
|
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"
|
|
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:
|
|
27
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.
|
|
28
|
+
<div class="col" style={{ textAlign: "right" }}>
|
|
29
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.9.1">
|
|
30
|
+
v1.9.1
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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("userIdentification")</code>. The <code>EQUALS</code> operator applies.</li> <li>Event type: <code>eventType("value")</code>. The <code>EQUALS</code> operator applies.</li> <li>Category of a logged operation: <code>category("value")</code>. The <code>EQUALS</code> operator applies.</li> <li>Entity ID: <code>entityId("id")</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("CREATE","UPDATE")</code> means eventType can be "CREATE" or "UPDATE".</p> <p>You can specify multiple comma-separated criteria, such as <code>eventType("CREATE","UPDATE"),category("CONFIG")</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
|
|
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("userIdentification")</code>. The <code>EQUALS</code> operator applies.</li> <li>Event type: <code>eventType("value")</code>. The <code>EQUALS</code> operator applies.</li> <li>Category of a logged operation: <code>category("value")</code>. The <code>EQUALS</code> operator applies.</li> <li>Entity ID: <code>entityId("id")</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("CREATE","UPDATE")</code> means eventType can be "CREATE" or "UPDATE".</p> <p>You can specify multiple comma-separated criteria, such as <code>eventType("CREATE","UPDATE"),category("CONFIG")</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>"</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
|
-
|
|
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
|
-
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w">GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code>.</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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <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("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w">GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code>.</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<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>> | |
|
|
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
|
-
|
|
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<
|
|
2707
|
+
<strong>extensions_2_0Client.getSchemaFile(config): Promise<JsonNode></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
|
-
|
|
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
|
-
|
|
3138
|
+
{/* no returns */}
|
|
3135
3139
|
|
|
3136
3140
|
<details>
|
|
3137
3141
|
<summary>
|
|
@@ -3311,7 +3315,10 @@ import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
|
3311
3315
|
Exports log records | maturity=EARLY_ADOPTER
|
|
3312
3316
|
|
|
3313
3317
|
**Required scope:** storage:logs:read
|
|
3314
|
-
**
|
|
3318
|
+
**One of the following permissions is required:**
|
|
3319
|
+
|
|
3320
|
+
- environment:roles:logviewer
|
|
3321
|
+
- storage:logs:read
|
|
3315
3322
|
|
|
3316
3323
|
Returns the first _X_ records (specified in the **pageSize** query parameter).
|
|
3317
3324
|
|
|
@@ -3364,7 +3371,10 @@ const data = await logsClient.exportLogRecords();
|
|
|
3364
3371
|
Gets aggregated log records | maturity=EARLY_ADOPTER
|
|
3365
3372
|
|
|
3366
3373
|
**Required scope:** storage:logs:read
|
|
3367
|
-
**
|
|
3374
|
+
**One of the following permissions is required:**
|
|
3375
|
+
|
|
3376
|
+
- environment:roles:logviewer
|
|
3377
|
+
- storage:logs:read
|
|
3368
3378
|
|
|
3369
3379
|
Returns the aggregated number of occurrences of log values divided into time slots.
|
|
3370
3380
|
|
|
@@ -3417,7 +3427,10 @@ const data = await logsClient.getLogHistogramData();
|
|
|
3417
3427
|
Reads log records | maturity=EARLY_ADOPTER
|
|
3418
3428
|
|
|
3419
3429
|
**Required scope:** storage:logs:read
|
|
3420
|
-
**
|
|
3430
|
+
**One of the following permissions is required:**
|
|
3431
|
+
|
|
3432
|
+
- environment:roles:logviewer
|
|
3433
|
+
- storage:logs:read
|
|
3421
3434
|
|
|
3422
3435
|
Returns the first _X_ records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
3423
3436
|
|
|
@@ -3512,7 +3525,7 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
|
|
|
3512
3525
|
|
|
3513
3526
|
</div>
|
|
3514
3527
|
|
|
3515
|
-
|
|
3528
|
+
{/* no parameters */}
|
|
3516
3529
|
|
|
3517
3530
|
#### Returns
|
|
3518
3531
|
|
|
@@ -3592,7 +3605,7 @@ You can additionally limit the output by using pagination:
|
|
|
3592
3605
|
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
|
|
3593
3606
|
| 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
3607
|
| 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("unit-1","unit-2")</code></p> </li> <li> <p><code>tags("tag-1","tag-2")</code></p> </li> <li> <p><code>dimensionKey("dimkey-1","dimkey-2")</code>. The filtering applies only to dimensions that were written within the last 14 days.</p> </li> <li> <p><code>custom("true")</code>. "true" to include only user-defined metrics metrics (without namespace or with <code>ext:</code>, <code>calc:</code>, <code>func:</code>, <code>appmon:</code>), "false" to filter them out.</p> </li> <li> <p><code>exported("true")</code>. "true" to include only exported metrics, "false" to filter them out.</p> </li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>tags("feature","cloud"),unit("Percent"),dimensionKey("location"),custom("true")</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("feature"),unit("Percent","MegaByte"),tags("cloud"),dimensionKey("location")</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>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code
|
|
3608
|
+
| 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>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>~</code>):</p> <ul> <li>Quotes (<code>"</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type "APACHE"</strong> you must specify this selector:</p> <p><code>"ext:selfmonitoring.jmx.Agents: Type ~"APACHE~""</code></p> <p>To find metrics based on a search term, rather than metricId, use the <strong>text</strong> query parameter instead of this one.</p> |
|
|
3596
3609
|
| 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
3610
|
| 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
3611
|
| 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 +3655,7 @@ Deletion cannot be undone! You can't delete a metric if it has data points inges
|
|
|
3642
3655
|
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------- |
|
|
3643
3656
|
| 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
3657
|
|
|
3645
|
-
|
|
3658
|
+
{/* no returns */}
|
|
3646
3659
|
|
|
3647
3660
|
<details>
|
|
3648
3661
|
<summary>
|
|
@@ -3774,15 +3787,15 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
|
|
|
3774
3787
|
|
|
3775
3788
|
#### Parameters
|
|
3776
3789
|
|
|
3777
|
-
| Name | Type | Description
|
|
3778
|
-
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
3779
|
-
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code
|
|
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("name-1","name-2")</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName("name-1","name-2"),mzId(1234)</code>. Only results matching <strong>all</strong> of the criteria are included in the response.For example, to list metrics that have the id <strong>123</strong> OR <strong>234</strong> AND the name <strong>name-1</strong> OR <strong>name-2</strong>, use this <strong>mzSelector</strong>: `mzId(123,234),mzName("name-1","name-2").</li> </ul>
|
|
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>
|
|
3790
|
+
| Name | Type | Description |
|
|
3791
|
+
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3792
|
+
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
|
|
3793
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <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> |
|
|
3794
|
+
| 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> |
|
|
3795
|
+
| 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>"</code>) the key. The following characters inside of a quoted metric key must be escaped with a tilde (<code>~</code>):</p> <ul> <li>Quotes (<code>"</code>)</li> <li>Tildes (<code>~</code>)</li> </ul> <p>For example, to query the metric with the key of <strong>ext:selfmonitoring.jmx.Agents: Type "APACHE"</strong> you must specify this selector:</p> <p><code>"ext:selfmonitoring.jmx.Agents: Type ~"APACHE~""</code></p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector">Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> |
|
|
3796
|
+
| 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("name-1","name-2")</code> To set several criteria, separate them with a comma (<code>,</code>). For example, <code>mzName("name-1","name-2"),mzId(1234)</code>. Only results matching <strong>all</strong> of the criteria are included in the response.For example, to list metrics that have the id <strong>123</strong> OR <strong>234</strong> AND the name <strong>name-1</strong> OR <strong>name-2</strong>, use this <strong>mzSelector</strong>: `mzId(123,234),mzName("name-1","name-2").</li> </ul> |
|
|
3797
|
+
| 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> |
|
|
3798
|
+
| 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
3799
|
|
|
3787
3800
|
#### Returns
|
|
3788
3801
|
|
|
@@ -3980,15 +3993,15 @@ You can limit the output by using pagination:
|
|
|
3980
3993
|
|
|
3981
3994
|
#### Parameters
|
|
3982
3995
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>
|
|
3996
|
+
| Name | Type | Description |
|
|
3997
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3998
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The field is <strong>required</strong> when you're querying the first page of results.</p> |
|
|
3999
|
+
| 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> |
|
|
4000
|
+
| 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> |
|
|
4001
|
+
| 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> |
|
|
4002
|
+
| 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> |
|
|
4003
|
+
| 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> |
|
|
4004
|
+
| 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
4005
|
|
|
3993
4006
|
#### Returns
|
|
3994
4007
|
|
|
@@ -4207,14 +4220,14 @@ Deletes the specified tag from the specified entities
|
|
|
4207
4220
|
|
|
4208
4221
|
#### Parameters
|
|
4209
4222
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>
|
|
4223
|
+
| Name | Type | Description |
|
|
4224
|
+
| ------------------------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4225
|
+
| 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> |
|
|
4226
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
4227
|
+
| 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> |
|
|
4228
|
+
| 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> |
|
|
4229
|
+
| 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> |
|
|
4230
|
+
| 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
4231
|
|
|
4219
4232
|
#### Returns
|
|
4220
4233
|
|
|
@@ -4257,11 +4270,11 @@ Automatically applied tags and imported tags are not included.
|
|
|
4257
4270
|
|
|
4258
4271
|
#### Parameters
|
|
4259
4272
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>
|
|
4273
|
+
| Name | Type | Description |
|
|
4274
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4275
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
4276
|
+
| 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> |
|
|
4277
|
+
| 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
4278
|
|
|
4266
4279
|
#### Returns
|
|
4267
4280
|
|
|
@@ -4303,12 +4316,12 @@ All existing tags remain unaffected.
|
|
|
4303
4316
|
|
|
4304
4317
|
#### Parameters
|
|
4305
4318
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>
|
|
4319
|
+
| Name | Type | Description |
|
|
4320
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4321
|
+
| config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> | |
|
|
4322
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
4323
|
+
| 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> |
|
|
4324
|
+
| 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
4325
|
|
|
4313
4326
|
#### Returns
|
|
4314
4327
|
|
|
@@ -4357,11 +4370,11 @@ Only process group instances are supported.
|
|
|
4357
4370
|
|
|
4358
4371
|
#### Parameters
|
|
4359
4372
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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>
|
|
4373
|
+
| Name | Type | Description |
|
|
4374
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4375
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> |
|
|
4376
|
+
| 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> |
|
|
4377
|
+
| 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
4378
|
|
|
4366
4379
|
#### Returns
|
|
4367
4380
|
|
|
@@ -4461,7 +4474,7 @@ If the network zone is used as an alternative zone for any OneAgent, it will be
|
|
|
4461
4474
|
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
4462
4475
|
| 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
4476
|
|
|
4464
|
-
|
|
4477
|
+
{/* no returns */}
|
|
4465
4478
|
|
|
4466
4479
|
<details>
|
|
4467
4480
|
<summary>
|
|
@@ -4495,7 +4508,7 @@ Lists all existing network zones
|
|
|
4495
4508
|
|
|
4496
4509
|
</div>
|
|
4497
4510
|
|
|
4498
|
-
|
|
4511
|
+
{/* no parameters */}
|
|
4499
4512
|
|
|
4500
4513
|
#### Returns
|
|
4501
4514
|
|
|
@@ -4574,7 +4587,7 @@ Gets the global configuration of network zones
|
|
|
4574
4587
|
|
|
4575
4588
|
</div>
|
|
4576
4589
|
|
|
4577
|
-
|
|
4590
|
+
{/* no parameters */}
|
|
4578
4591
|
|
|
4579
4592
|
#### Returns
|
|
4580
4593
|
|
|
@@ -4658,7 +4671,7 @@ Updates the global configuration of network zones
|
|
|
4658
4671
|
| -------------------------------- | ------------------------------------------------------ |
|
|
4659
4672
|
| config.body<sup>\*required</sup> | <a href="#networkzonesettings">NetworkZoneSettings</a> |
|
|
4660
4673
|
|
|
4661
|
-
|
|
4674
|
+
{/* no returns */}
|
|
4662
4675
|
|
|
4663
4676
|
<details>
|
|
4664
4677
|
<summary>
|
|
@@ -4694,7 +4707,7 @@ import { problemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
|
4694
4707
|
Closes the specified problem and adds a closing comment on it
|
|
4695
4708
|
|
|
4696
4709
|
**Required scope:** environment-api:problems:write
|
|
4697
|
-
**Required permission:** environment:roles:
|
|
4710
|
+
**Required permission:** environment:roles:viewer
|
|
4698
4711
|
|
|
4699
4712
|
</div>
|
|
4700
4713
|
|
|
@@ -4749,7 +4762,7 @@ Adds a new comment on the specified problem
|
|
|
4749
4762
|
| config.body<sup>\*required</sup> | <a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a> | |
|
|
4750
4763
|
| 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
4764
|
|
|
4752
|
-
|
|
4765
|
+
{/* no returns */}
|
|
4753
4766
|
|
|
4754
4767
|
<details>
|
|
4755
4768
|
<summary>
|
|
@@ -4791,7 +4804,7 @@ Deletes the specified comment from a problem
|
|
|
4791
4804
|
| 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
4805
|
| 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
4806
|
|
|
4794
|
-
|
|
4807
|
+
{/* no returns */}
|
|
4795
4808
|
|
|
4796
4809
|
<details>
|
|
4797
4810
|
<summary>
|
|
@@ -4959,16 +4972,16 @@ Lists problems observed within the specified timeframe
|
|
|
4959
4972
|
|
|
4960
4973
|
#### Parameters
|
|
4961
4974
|
|
|
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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code
|
|
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("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("[context]key:value","key:value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code
|
|
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>
|
|
4975
|
+
| Name | Type | Description |
|
|
4976
|
+
| ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4977
|
+
| 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("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName("value")</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals("value"))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState("HEALTHY")</code></li> <li>First seen timestamp: <code>firstSeenTms.<operator>(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code><attribute>("value1","value2")</code> and <code><attribute>.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.<relationshipName>()</code> and <code>toRelationships.<relationshipName>()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(<criterion>)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector">Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type("HOST"),healthState("HEALTHY")</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The maximum number of entities that may be selected is limited to 10000.</p> |
|
|
4978
|
+
| 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> |
|
|
4979
|
+
| 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> |
|
|
4980
|
+
| 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> |
|
|
4981
|
+
| 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> |
|
|
4982
|
+
| 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("open")</code> or <code>status("closed")</code>. You can specify only one status.</li> <li>Severity level: <code>severityLevel("level-1","level-2")</code>. Find the possible values in the description of the <strong>severityLevel</strong> field of the response.</li> <li>Impact level: <code>impactLevel("level-11","level-2")</code> Find the possible values in the description of the <strong>impactLevel</strong> field of the response.</li> <li>Root cause entity: <code>rootCauseEntity("id-1", "id-2")</code>.</li> <li>Management zone ID: <code>managementZoneIds("mZId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("value-1","value-2")</code>.</li> <li>Impacted entities: <code>impactedEntities("id-1", "id-2")</code>.</li> <li>Affected entities: <code>affectedEntities("id-1", "id-2")</code>.</li> <li>Type of affected entities: <code>affectedEntityTypes("value-1","value-2")</code>.</li> <li>Problem ID: <code>problemId("id-1", "id-2")</code>.</li> <li>Alerting profile ID: <code>problemFilterIds("id-1", "id-2")</code>.</li> <li>Alerting profile name (contains, case-insensitive): <code>problemFilterNames("value-1","value-2")</code>.</li> <li>Alerting profile name (exact match, case-insensitive): <code>problemFilterNames.equals("value-1","value-2")</code>.</li> <li>Entity tags: <code>entityTags("[context]key:value","key:value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. If a value-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Display ID of the problem: <code>displayId("id-1", "id-2")</code>.</li> <li>Under maintenance: <code>underMaintenance(true|false)</code>. Shows (true) or hides (false) all problems created during maintenance mode.</li> <li>Text search: <code>text("value")</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>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</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> |
|
|
4983
|
+
| 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> |
|
|
4984
|
+
| 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
4985
|
|
|
4973
4986
|
#### Returns
|
|
4974
4987
|
|
|
@@ -5012,7 +5025,7 @@ Updates the specified comment on a problem
|
|
|
5012
5025
|
| 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
5026
|
| 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
5027
|
|
|
5015
|
-
|
|
5028
|
+
{/* no returns */}
|
|
5016
5029
|
|
|
5017
5030
|
<details>
|
|
5018
5031
|
<summary>
|
|
@@ -5056,15 +5069,15 @@ Returns all releases
|
|
|
5056
5069
|
|
|
5057
5070
|
#### Parameters
|
|
5058
5071
|
|
|
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("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). 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("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters
|
|
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>
|
|
5072
|
+
| Name | Type | Description |
|
|
5073
|
+
| ----------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5074
|
+
| 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> |
|
|
5075
|
+
| 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> |
|
|
5076
|
+
| 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> |
|
|
5077
|
+
| 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> |
|
|
5078
|
+
| 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("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). 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("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").</p> <i>default:</i> <code>""</code> |
|
|
5079
|
+
| 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> |
|
|
5080
|
+
| 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
5081
|
|
|
5069
5082
|
#### Returns
|
|
5070
5083
|
|
|
@@ -5377,10 +5390,10 @@ Lists remediation items of a third-party security problem
|
|
|
5377
5390
|
|
|
5378
5391
|
#### Parameters
|
|
5379
5392
|
|
|
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("value")</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets("value")</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure("value")</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy("value")</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains("value")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code
|
|
5393
|
+
| Name | Type | Description |
|
|
5394
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5395
|
+
| 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. |
|
|
5396
|
+
| config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState("value")</code>. Find the possible values in the description of the <strong>vulnerabilityState</strong> field of the response. If not set, all entities are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Reachable data asset assessment: <code>assessment.dataAssets("value")</code> Possible values are <code>REACHABLE</code>, and <code>NOT_DETECTED</code>.</li> <li>Network exposure assessment: <code>assessment.exposure("value")</code> Possible values are <code>PUBLIC_NETWORK</code>, and <code>NOT_DETECTED</code>.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Assessment accuracy: <code>assessment.accuracy("value")</code> Possible values are <code>FULL</code> and <code>REDUCED</code>.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Tracking link display name: <code>trackingLink.displayNameContains("value")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5384
5397
|
|
|
5385
5398
|
#### Returns
|
|
5386
5399
|
|
|
@@ -5423,11 +5436,11 @@ Lists remediation progress entities
|
|
|
5423
5436
|
|
|
5424
5437
|
#### Parameters
|
|
5425
5438
|
|
|
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("value")</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code
|
|
5439
|
+
| Name | Type | Description |
|
|
5440
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5441
|
+
| 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. |
|
|
5442
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5443
|
+
| config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state("value")</code>. Possible values the <strong>state</strong> field are <code>AFFECTED</code> and <code>UNAFFECTED</code>. If not set, all entities are returned.</li> <li>Vulnerable function usage assessment: <code>assessment.vulnerableFunctionUsage("value")</code> Possible values are <code>IN_USE</code>, and <code>NOT_IN_USE</code>.</li> <li>Vulnerable function restart required: <code>assessment.vulnerableFunctionRestartRequired("value")</code> Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Vulnerable function in use contains: <code>assessment.vulnerableFunctionInUseContains("value")</code>. Possible values are <code>class::function</code>, <code>class::</code> and <code>function</code>. The <code>CONTAINS</code> operator is used. Only vulnerable functions in use are considered.</li> <li>Entity name contains: <code>entityNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5431
5444
|
|
|
5432
5445
|
#### Returns
|
|
5433
5446
|
|
|
@@ -5518,15 +5531,15 @@ Lists all security problems
|
|
|
5518
5531
|
|
|
5519
5532
|
#### Parameters
|
|
5520
5533
|
|
|
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("value")</code>. Find the possible values in the description of the <strong>status</strong> field of the response. If not set, all security problems are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Risk level: <code>riskLevel("value")</code>. The Davis risk level. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum risk score: <code>minRiskScore("5.5")</code>. The Davis minimum risk score. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum risk score: <code>maxRiskScore("5.5")</code>. The Davis maximum risk score. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Base risk level: <code>baseRiskLevel("value")</code>. The Base risk level from the CVSS. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum base risk score: <code>minBaseRiskScore("5.5")</code>. The minimum base risk score from the CVSS. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum base risk score: <code>maxBaseRiskScore("5.5")</code>. The maximum base risk score from the CVSS. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>External vulnerability ID contains: <code>externalVulnerabilityIdContains("id-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>External vulnerability ID: <code>externalVulnerabilityId("id-1", "id-2")</code>.</li> <li>CVE ID: <code>cveId("id")</code>.</li> <li>Risk assessment <code>riskAssessment("value-1", "value-2")</code> Possible values are <code>EXPOSED</code>, <code>SENSITIVE</code>, <code>EXPLOIT</code>, <code>VULNERABLE_FUNCTION_IN_USE</code> and <code>ACCURACY_REDUCED</code>.</li> <li>Related host ID: <code>relatedHostIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related host name: <code>relatedHostNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related host name contains: <code>relatedHostNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes cluster ID: <code>relatedKubernetesClusterIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes cluster name: <code>relatedKubernetesClusterNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes cluster name contains: <code>relatedKubernetesClusterNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes workload ID: <code>relatedKubernetesWorkloadIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes workload name: <code>relatedKubernetesWorkloadNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes workload name contains: <code>relatedKubernetesWorkloadNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Management zone ID: <code>managementZoneIds("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group instance ID: <code>affectedPgiIds("pgiId-1", "pgiId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group ID: <code>affectedPgIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group name: <code>affectedPgNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group name contains: <code>affectedPgNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerable component ID: <code>vulnerableComponentIds("componentId-1", "componentId-2")</code>. Specify component IDs here.</li> <li>Vulnerable component name: <code>vulnerableComponentNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Vulnerable component name contains: <code>vulnerableComponentNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Host tags: <code>hostTags("hostTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group tags: <code>pgTags("pgTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group instance tags: <code>pgiTags("pgiTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Tags: <code>tags("tag-1")</code>. The <code>CONTAINS</code> operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.</li> <li>Display ID: <code>displayIds("S-1234", "S-5678")</code>. The <code>EQUALS</code> operator is used.</li> <li>Security problem ID: <code>securityProblemIds("12544152654387159360", "5904857564184044850")</code>. The <code>EQUALS</code> operator is used.</li> <li>Technology: <code>technology("technology-1", "technology-2")</code>. Find the possible values in the description of the <strong>technology</strong> field of the response. The <code>EQUALS</code> operator is used.</li> <li>Vulnerability type: <code>vulnerabilityType("type-1", "type-2")</code>. Possible values are <code>THIRD_PARTY</code>, <code>CODE_LEVEL</code>, <code>RUNTIME</code>.</li> </ul> <p>Risk score and risk category are mutually exclusive (cannot be used at the same time).</p> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code
|
|
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>
|
|
5534
|
+
| Name | Type | Description |
|
|
5535
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5536
|
+
| 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> |
|
|
5537
|
+
| 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> |
|
|
5538
|
+
| 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> |
|
|
5539
|
+
| 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> |
|
|
5540
|
+
| config.securityProblemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only security problems matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Status: <code>status("value")</code>. Find the possible values in the description of the <strong>status</strong> field of the response. If not set, all security problems are returned.</li> <li>Muted: <code>muted("value")</code>. Possible values are <code>TRUE</code> or <code>FALSE</code>.</li> <li>Risk level: <code>riskLevel("value")</code>. The Davis risk level. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum risk score: <code>minRiskScore("5.5")</code>. The Davis minimum risk score. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum risk score: <code>maxRiskScore("5.5")</code>. The Davis maximum risk score. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Base risk level: <code>baseRiskLevel("value")</code>. The Base risk level from the CVSS. Find the possible values in the description of the <strong>riskLevel</strong> field of the response.</li> <li>Minimum base risk score: <code>minBaseRiskScore("5.5")</code>. The minimum base risk score from the CVSS. The <code>GREATER THAN OR EQUAL TO</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>Maximum base risk score: <code>maxBaseRiskScore("5.5")</code>. The maximum base risk score from the CVSS. The <code>LESS THAN</code> operator is used. Specify a number between <code>1.0</code> and <code>10.0</code>.</li> <li>External vulnerability ID contains: <code>externalVulnerabilityIdContains("id-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>External vulnerability ID: <code>externalVulnerabilityId("id-1", "id-2")</code>.</li> <li>CVE ID: <code>cveId("id")</code>.</li> <li>Risk assessment <code>riskAssessment("value-1", "value-2")</code> Possible values are <code>EXPOSED</code>, <code>SENSITIVE</code>, <code>EXPLOIT</code>, <code>VULNERABLE_FUNCTION_IN_USE</code> and <code>ACCURACY_REDUCED</code>.</li> <li>Related host ID: <code>relatedHostIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related host name: <code>relatedHostNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related host name contains: <code>relatedHostNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes cluster ID: <code>relatedKubernetesClusterIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes cluster name: <code>relatedKubernetesClusterNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes cluster name contains: <code>relatedKubernetesClusterNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Related Kubernetes workload ID: <code>relatedKubernetesWorkloadIds("value-1", "value-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Related Kubernetes workload name: <code>relatedKubernetesWorkloadNames("value-1", "value-2")</code>. Values are case-sensitive.</li> <li>Related Kubernetes workload name contains: <code>relatedKubernetesWorkloadNameContains("value-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Management zone ID: <code>managementZoneIds("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group instance ID: <code>affectedPgiIds("pgiId-1", "pgiId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group ID: <code>affectedPgIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Affected process group name: <code>affectedPgNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Affected process group name contains: <code>affectedPgNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Vulnerable component ID: <code>vulnerableComponentIds("componentId-1", "componentId-2")</code>. Specify component IDs here.</li> <li>Vulnerable component name: <code>vulnerableComponentNames("name-1", "name-2")</code>. Values are case-sensitive.</li> <li>Vulnerable component name contains: <code>vulnerableComponentNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> <li>Host tags: <code>hostTags("hostTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group tags: <code>pgTags("pgTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Process group instance tags: <code>pgiTags("pgiTag-1")</code>. The <code>CONTAINS</code> operator is used. Maximum value length is 48 characters.</li> <li>Tags: <code>tags("tag-1")</code>. The <code>CONTAINS</code> operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.</li> <li>Display ID: <code>displayIds("S-1234", "S-5678")</code>. The <code>EQUALS</code> operator is used.</li> <li>Security problem ID: <code>securityProblemIds("12544152654387159360", "5904857564184044850")</code>. The <code>EQUALS</code> operator is used.</li> <li>Technology: <code>technology("technology-1", "technology-2")</code>. Find the possible values in the description of the <strong>technology</strong> field of the response. The <code>EQUALS</code> operator is used.</li> <li>Vulnerability type: <code>vulnerabilityType("type-1", "type-2")</code>. Possible values are <code>THIRD_PARTY</code>, <code>CODE_LEVEL</code>, <code>RUNTIME</code>.</li> </ul> <p>Risk score and risk category are mutually exclusive (cannot be used at the same time).</p> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5541
|
+
| 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> |
|
|
5542
|
+
| 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
5543
|
|
|
5531
5544
|
#### Returns
|
|
5532
5545
|
|
|
@@ -5567,11 +5580,11 @@ Lists all vulnerable functions and their usage for a third-party security proble
|
|
|
5567
5580
|
|
|
5568
5581
|
#### Parameters
|
|
5569
5582
|
|
|
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("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group ID: <code>processGroupIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Process group name: <code>processGroupNames("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group name contains: <code>processGroupNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code
|
|
5583
|
+
| Name | Type | Description |
|
|
5584
|
+
| ---------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5585
|
+
| 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> |
|
|
5586
|
+
| 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. |
|
|
5587
|
+
| config.vulnerableFunctionsSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.</p> <p>You can add the following criteria. Values are <em>not</em> case sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Management zone ID: <code>managementZoneIds("mzId-1", "mzId-2")</code>.</li> <li>Management zone name: <code>managementZones("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group ID: <code>processGroupIds("pgId-1", "pgId-2")</code>. Specify Dynatrace entity IDs here.</li> <li>Process group name: <code>processGroupNames("name-1", "name-2")</code>. Values are case sensitive.</li> <li>Process group name contains: <code>processGroupNameContains("name-1")</code>. The <code>CONTAINS</code> operator is used.</li> </ul> <p>Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (<code>~</code>) inside quotes:</p> <ul> <li>Tilde <code>~</code></li> <li>Quote <code>"</code></li> </ul> |
|
|
5575
5588
|
|
|
5576
5589
|
#### Returns
|
|
5577
5590
|
|
|
@@ -5616,7 +5629,7 @@ Mutes a security problem
|
|
|
5616
5629
|
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> | |
|
|
5617
5630
|
| 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
5631
|
|
|
5619
|
-
|
|
5632
|
+
{/* no returns */}
|
|
5620
5633
|
|
|
5621
5634
|
<details>
|
|
5622
5635
|
<summary>
|
|
@@ -5659,7 +5672,7 @@ Sets the mute state of a remediation item
|
|
|
5659
5672
|
| 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
5673
|
| 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
5674
|
|
|
5662
|
-
|
|
5675
|
+
{/* no returns */}
|
|
5663
5676
|
|
|
5664
5677
|
<details>
|
|
5665
5678
|
<summary>
|
|
@@ -5702,7 +5715,7 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
|
|
|
5702
5715
|
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a> | |
|
|
5703
5716
|
| 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
5717
|
|
|
5705
|
-
|
|
5718
|
+
{/* no returns */}
|
|
5706
5719
|
|
|
5707
5720
|
<details>
|
|
5708
5721
|
<summary>
|
|
@@ -5744,7 +5757,7 @@ Un-mutes a security problem
|
|
|
5744
5757
|
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> | |
|
|
5745
5758
|
| 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
5759
|
|
|
5747
|
-
|
|
5760
|
+
{/* no returns */}
|
|
5748
5761
|
|
|
5749
5762
|
<details>
|
|
5750
5763
|
<summary>
|
|
@@ -5844,7 +5857,7 @@ Creates a new SLO
|
|
|
5844
5857
|
| -------------------------------- | -------------------------------------------------------- |
|
|
5845
5858
|
| config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> |
|
|
5846
5859
|
|
|
5847
|
-
|
|
5860
|
+
{/* no returns */}
|
|
5848
5861
|
|
|
5849
5862
|
<details>
|
|
5850
5863
|
<summary>
|
|
@@ -5892,7 +5905,7 @@ Deletes an SLO
|
|
|
5892
5905
|
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5893
5906
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
|
|
5894
5907
|
|
|
5895
|
-
|
|
5908
|
+
{/* no returns */}
|
|
5896
5909
|
|
|
5897
5910
|
<details>
|
|
5898
5911
|
<summary>
|
|
@@ -5936,19 +5949,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
|
|
|
5936
5949
|
|
|
5937
5950
|
#### Parameters
|
|
5938
5951
|
|
|
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("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code
|
|
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>
|
|
5952
|
+
| Name | Type | Description |
|
|
5953
|
+
| --------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5954
|
+
| 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> |
|
|
5955
|
+
| 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> |
|
|
5956
|
+
| 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> |
|
|
5957
|
+
| 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> |
|
|
5958
|
+
| 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> |
|
|
5959
|
+
| 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> |
|
|
5960
|
+
| 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> |
|
|
5961
|
+
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> <i>default:</i> <code>""</code> |
|
|
5962
|
+
| 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> |
|
|
5963
|
+
| 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> |
|
|
5964
|
+
| 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
5965
|
|
|
5953
5966
|
#### Returns
|
|
5954
5967
|
|
|
@@ -6044,7 +6057,7 @@ Updates an existing SLO
|
|
|
6044
6057
|
| config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> | |
|
|
6045
6058
|
| 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
6059
|
|
|
6047
|
-
|
|
6060
|
+
{/* no returns */}
|
|
6048
6061
|
|
|
6049
6062
|
<details>
|
|
6050
6063
|
<summary>
|
|
@@ -6100,7 +6113,7 @@ Deletes the specified settings object
|
|
|
6100
6113
|
| 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
6114
|
| 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
6115
|
|
|
6103
|
-
|
|
6116
|
+
{/* no returns */}
|
|
6104
6117
|
|
|
6105
6118
|
<details>
|
|
6106
6119
|
<summary>
|
|
@@ -6401,7 +6414,7 @@ Lists available settings schemas
|
|
|
6401
6414
|
|
|
6402
6415
|
</div>
|
|
6403
6416
|
|
|
6404
|
-
|
|
6417
|
+
{/* no parameters */}
|
|
6405
6418
|
|
|
6406
6419
|
#### Returns
|
|
6407
6420
|
|
|
@@ -6582,7 +6595,7 @@ Gets set of synthetic related parameters defined for whole tenant (affects all m
|
|
|
6582
6595
|
|
|
6583
6596
|
</div>
|
|
6584
6597
|
|
|
6585
|
-
|
|
6598
|
+
{/* no parameters */}
|
|
6586
6599
|
|
|
6587
6600
|
#### Returns
|
|
6588
6601
|
|
|
@@ -6837,7 +6850,7 @@ Checks the status of public synthetic locations
|
|
|
6837
6850
|
|
|
6838
6851
|
</div>
|
|
6839
6852
|
|
|
6840
|
-
|
|
6853
|
+
{/* no parameters */}
|
|
6841
6854
|
|
|
6842
6855
|
#### Returns
|
|
6843
6856
|
|
|
@@ -6916,7 +6929,7 @@ Lists all synthetic nodes available in your environment
|
|
|
6916
6929
|
|
|
6917
6930
|
</div>
|
|
6918
6931
|
|
|
6919
|
-
|
|
6932
|
+
{/* no parameters */}
|
|
6920
6933
|
|
|
6921
6934
|
#### Returns
|
|
6922
6935
|
|
|
@@ -6958,7 +6971,7 @@ Deletes the specified private synthetic location
|
|
|
6958
6971
|
| -------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
6959
6972
|
| 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
6973
|
|
|
6961
|
-
|
|
6974
|
+
{/* no returns */}
|
|
6962
6975
|
|
|
6963
6976
|
<details>
|
|
6964
6977
|
<summary>
|
|
@@ -7044,7 +7057,7 @@ For public locations you can only change the location status.
|
|
|
7044
7057
|
| config.body<sup>\*required</sup> | <a href="#syntheticlocationupdate">SyntheticLocationUpdate</a> | |
|
|
7045
7058
|
| 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
7059
|
|
|
7047
|
-
|
|
7060
|
+
{/* no returns */}
|
|
7048
7061
|
|
|
7049
7062
|
<details>
|
|
7050
7063
|
<summary>
|
|
@@ -7084,7 +7097,7 @@ Changes the status of public synthetic locations
|
|
|
7084
7097
|
| -------------------------------- | ---------------------------------------------------------------------------- |
|
|
7085
7098
|
| config.body<sup>\*required</sup> | <a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a> |
|
|
7086
7099
|
|
|
7087
|
-
|
|
7100
|
+
{/* no returns */}
|
|
7088
7101
|
|
|
7089
7102
|
<details>
|
|
7090
7103
|
<summary>
|
|
@@ -7171,7 +7184,7 @@ Deletes a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
7171
7184
|
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------ |
|
|
7172
7185
|
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7173
7186
|
|
|
7174
|
-
|
|
7187
|
+
{/* no returns */}
|
|
7175
7188
|
|
|
7176
7189
|
<details>
|
|
7177
7190
|
<summary>
|
|
@@ -7249,9 +7262,9 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
|
|
|
7249
7262
|
|
|
7250
7263
|
#### Parameters
|
|
7251
7264
|
|
|
7252
|
-
| Name
|
|
7253
|
-
|
|
|
7254
|
-
| config.
|
|
7265
|
+
| Name | Type | Description |
|
|
7266
|
+
| ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
7267
|
+
| config.monitorSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor activity: <code>active(true)</code>.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
7255
7268
|
|
|
7256
7269
|
#### Returns
|
|
7257
7270
|
|
|
@@ -7294,7 +7307,7 @@ Updates a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
7294
7307
|
| config.body<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a> | |
|
|
7295
7308
|
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7296
7309
|
|
|
7297
|
-
|
|
7310
|
+
{/* no returns */}
|
|
7298
7311
|
|
|
7299
7312
|
<details>
|
|
7300
7313
|
<summary>
|
|
@@ -7778,20 +7791,20 @@ Short representation of the alerting profile.
|
|
|
7778
7791
|
|
|
7779
7792
|
Metadata of an API token.
|
|
7780
7793
|
|
|
7781
|
-
| Name | Type
|
|
7782
|
-
| ------------------- |
|
|
7783
|
-
| additionalMetadata |
|
|
7784
|
-
| creationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7785
|
-
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7786
|
-
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7787
|
-
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7788
|
-
| lastUsedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7789
|
-
| lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7790
|
-
| modifiedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7791
|
-
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7792
|
-
| owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7793
|
-
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7794
|
-
| scopes | Array<ApiTokenScopesItem>
|
|
7794
|
+
| Name | Type | Description |
|
|
7795
|
+
| ------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7796
|
+
| additionalMetadata | ApiTokenAdditionalMetadata | |
|
|
7797
|
+
| 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>) |
|
|
7798
|
+
| 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>). |
|
|
7799
|
+
| 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> |
|
|
7800
|
+
| 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. |
|
|
7801
|
+
| 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>) |
|
|
7802
|
+
| lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used IP address. |
|
|
7803
|
+
| 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. |
|
|
7804
|
+
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7805
|
+
| owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the token. |
|
|
7806
|
+
| 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>). |
|
|
7807
|
+
| scopes | Array<ApiTokenScopesItem> | A list of scopes assigned to the token. |
|
|
7795
7808
|
|
|
7796
7809
|
### ApiTokenCreate
|
|
7797
7810
|
|
|
@@ -7905,20 +7918,20 @@ The audit log of your environment.
|
|
|
7905
7918
|
|
|
7906
7919
|
An entry of the audit log.
|
|
7907
7920
|
|
|
7908
|
-
| Name | Type
|
|
7909
|
-
| ---------------------------------- |
|
|
7910
|
-
| category<sup>\*required</sup> | AuditLogEntryCategory
|
|
7911
|
-
| entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7912
|
-
| environmentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7913
|
-
| eventType<sup>\*required</sup> | AuditLogEntryEventType
|
|
7914
|
-
| logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7915
|
-
| message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7916
|
-
| patch |
|
|
7917
|
-
| success<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7918
|
-
| timestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
7919
|
-
| user<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7920
|
-
| userOrigin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7921
|
-
| userType<sup>\*required</sup> | AuditLogEntryUserType
|
|
7921
|
+
| Name | Type | Description |
|
|
7922
|
+
| ---------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7923
|
+
| category<sup>\*required</sup> | AuditLogEntryCategory | |
|
|
7924
|
+
| 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> |
|
|
7925
|
+
| 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. |
|
|
7926
|
+
| eventType<sup>\*required</sup> | AuditLogEntryEventType | |
|
|
7927
|
+
| logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the log entry. |
|
|
7928
|
+
| message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The logged message. |
|
|
7929
|
+
| patch | AuditLogEntryPatch | |
|
|
7930
|
+
| 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>). |
|
|
7931
|
+
| 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. |
|
|
7932
|
+
| 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. |
|
|
7933
|
+
| 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>. |
|
|
7934
|
+
| userType<sup>\*required</sup> | AuditLogEntryUserType | |
|
|
7922
7935
|
|
|
7923
7936
|
### AuthorDto
|
|
7924
7937
|
|
|
@@ -8076,20 +8089,20 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
8076
8089
|
|
|
8077
8090
|
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
8091
|
|
|
8079
|
-
| Name | Type
|
|
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>
|
|
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>
|
|
8092
|
-
| type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8092
|
+
| Name | Type | Description |
|
|
8093
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8094
|
+
| data | Record<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>> | |
|
|
8095
|
+
| data_base64 | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8096
|
+
| datacontenttype | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8097
|
+
| dataschema | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8098
|
+
| dtcontext | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Dynatrace context |
|
|
8099
|
+
| id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8100
|
+
| source<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8101
|
+
| specversion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8102
|
+
| subject | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8103
|
+
| time | Date | |
|
|
8104
|
+
| 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. |
|
|
8105
|
+
| type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8093
8106
|
|
|
8094
8107
|
### CodeLevelVulnerabilityDetails
|
|
8095
8108
|
|
|
@@ -8510,18 +8523,18 @@ A constraint on the values that are going to be deleted.
|
|
|
8510
8523
|
|
|
8511
8524
|
An effective settings value.
|
|
8512
8525
|
|
|
8513
|
-
| Name | Type
|
|
8514
|
-
| ------------- |
|
|
8515
|
-
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8516
|
-
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
8517
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8518
|
-
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
8519
|
-
| origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8520
|
-
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8521
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8522
|
-
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8523
|
-
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8524
|
-
| value |
|
|
8526
|
+
| Name | Type | Description |
|
|
8527
|
+
| ------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
8528
|
+
| 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. |
|
|
8529
|
+
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
|
|
8530
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
|
|
8531
|
+
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
|
|
8532
|
+
| origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin of the settings value. |
|
|
8533
|
+
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
|
|
8534
|
+
| 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. |
|
|
8535
|
+
| 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. |
|
|
8536
|
+
| 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. |
|
|
8537
|
+
| value | SettingsValue | |
|
|
8525
8538
|
|
|
8526
8539
|
### EffectiveSettingsValuesList
|
|
8527
8540
|
|
|
@@ -8696,13 +8709,13 @@ Definition of an enum property.
|
|
|
8696
8709
|
|
|
8697
8710
|
An allowed value for an enum property.
|
|
8698
8711
|
|
|
8699
|
-
| Name | Type
|
|
8700
|
-
| -------------------------------- |
|
|
8701
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8702
|
-
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8703
|
-
| enumInstance | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8704
|
-
| icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8705
|
-
| value<sup>\*required</sup> |
|
|
8712
|
+
| Name | Type | Description |
|
|
8713
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
8714
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the value. |
|
|
8715
|
+
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the value. |
|
|
8716
|
+
| 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. |
|
|
8717
|
+
| icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The icon of the value. |
|
|
8718
|
+
| value<sup>\*required</sup> | EnumValueValue | |
|
|
8706
8719
|
|
|
8707
8720
|
### Error
|
|
8708
8721
|
|
|
@@ -8987,12 +9000,12 @@ A list of exported log records.
|
|
|
8987
9000
|
|
|
8988
9001
|
List of assets imported with the active extension environment configuration.
|
|
8989
9002
|
|
|
8990
|
-
| Name | Type | Description
|
|
8991
|
-
| ---------------------------- | ------------------------------------------------------------------------------------------ |
|
|
8992
|
-
| assets<sup>\*required</sup> | Array<<a href="#assetinfodto">AssetInfoDto</a>> | The list of the imported assets.
|
|
8993
|
-
| errors<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors during asset import
|
|
8994
|
-
| status<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The status of the assets list.
|
|
8995
|
-
| version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
|
|
9003
|
+
| Name | Type | Description |
|
|
9004
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
|
|
9005
|
+
| assets<sup>\*required</sup> | Array<<a href="#assetinfodto">AssetInfoDto</a>> | The list of the imported assets. |
|
|
9006
|
+
| errors<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors during asset import |
|
|
9007
|
+
| status<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The status of the assets list. |
|
|
9008
|
+
| version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Version of the active extension environment configuration. |
|
|
8996
9009
|
|
|
8997
9010
|
### ExtensionEnvironmentConfigurationVersion
|
|
8998
9011
|
|
|
@@ -9028,11 +9041,12 @@ Details of feature sets
|
|
|
9028
9041
|
|
|
9029
9042
|
A list of extensions with additional metadata.
|
|
9030
9043
|
|
|
9031
|
-
| Name | Type | Description
|
|
9032
|
-
| ---------------------------------- | ------------------------------------------------------------------------------------------ |
|
|
9033
|
-
|
|
|
9034
|
-
|
|
|
9035
|
-
|
|
|
9044
|
+
| Name | Type | Description |
|
|
9045
|
+
| ---------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
|
|
9046
|
+
| activeVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Active version in the environment (null if none is active) |
|
|
9047
|
+
| extensionName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Extension name |
|
|
9048
|
+
| keywords<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | Extension keywords for the highest version |
|
|
9049
|
+
| version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Highest installed version |
|
|
9036
9050
|
|
|
9037
9051
|
### ExtensionInfoList
|
|
9038
9052
|
|
|
@@ -9054,11 +9068,11 @@ A list of extensions with additional metadata.
|
|
|
9054
9068
|
|
|
9055
9069
|
### ExtensionMonitoringConfiguration
|
|
9056
9070
|
|
|
9057
|
-
| Name | Type
|
|
9058
|
-
| ----------------------------- |
|
|
9059
|
-
| objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9060
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9061
|
-
| value<sup>\*required</sup> |
|
|
9071
|
+
| Name | Type | Description |
|
|
9072
|
+
| ----------------------------- | ----------------------------------------------------------------------------- | ------------------- |
|
|
9073
|
+
| objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration id |
|
|
9074
|
+
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration scope |
|
|
9075
|
+
| value<sup>\*required</sup> | ExtensionMonitoringConfigurationValue | |
|
|
9062
9076
|
|
|
9063
9077
|
### ExtensionMonitoringConfigurationsList
|
|
9064
9078
|
|
|
@@ -9652,6 +9666,7 @@ A result of the execution HTTP monitor's request.
|
|
|
9652
9666
|
|
|
9653
9667
|
| Name | Type | Description |
|
|
9654
9668
|
| -------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
9669
|
+
| cloudPlatform | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Cloud platform of the location. |
|
|
9655
9670
|
| customLogs | Array<<a href="#customlogline">CustomLogLine</a>> | Custom log messages. |
|
|
9656
9671
|
| engineId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | VUC's id on which monitor's request was executed. |
|
|
9657
9672
|
| failureMessage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Request's failure message. |
|
|
@@ -9727,10 +9742,10 @@ A list of entities and their monitoring states.
|
|
|
9727
9742
|
|
|
9728
9743
|
### MonitoringConfigurationDto
|
|
9729
9744
|
|
|
9730
|
-
| Name | Type
|
|
9731
|
-
| -------------------------- |
|
|
9732
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9733
|
-
| value |
|
|
9745
|
+
| Name | Type | Description |
|
|
9746
|
+
| -------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------- |
|
|
9747
|
+
| 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 |
|
|
9748
|
+
| value | JsonNode | |
|
|
9734
9749
|
|
|
9735
9750
|
### MonitoringConfigurationResponse
|
|
9736
9751
|
|
|
@@ -9741,9 +9756,9 @@ A list of entities and their monitoring states.
|
|
|
9741
9756
|
|
|
9742
9757
|
### MonitoringConfigurationUpdateDto
|
|
9743
9758
|
|
|
9744
|
-
| Name | Type
|
|
9745
|
-
| ----- |
|
|
9746
|
-
| value |
|
|
9759
|
+
| Name | Type |
|
|
9760
|
+
| ----- | -------- |
|
|
9761
|
+
| value | JsonNode |
|
|
9747
9762
|
|
|
9748
9763
|
### MuteState
|
|
9749
9764
|
|
|
@@ -9864,15 +9879,15 @@ A list of settings objects.
|
|
|
9864
9879
|
|
|
9865
9880
|
A precondition for visibility of a property.
|
|
9866
9881
|
|
|
9867
|
-
| Name | Type
|
|
9868
|
-
| ------------------------- |
|
|
9869
|
-
| expectedValue |
|
|
9870
|
-
| expectedValues | Array<<a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>> | <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>
|
|
9872
|
-
| precondition | <a href="#precondition">Precondition</a>
|
|
9873
|
-
| preconditions | Array<<a href="#precondition">Precondition</a>>
|
|
9874
|
-
| property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9875
|
-
| type<sup>\*required</sup> | PreconditionType
|
|
9882
|
+
| Name | Type | Description |
|
|
9883
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9884
|
+
| expectedValue | PreconditionExpectedValue | |
|
|
9885
|
+
| expectedValues | Array<Record<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>>> | <p>A list of valid values of the property.</p> <p>Only applicable to properties of the <code>IN</code> type.</p> |
|
|
9886
|
+
| 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> |
|
|
9887
|
+
| precondition | <a href="#precondition">Precondition</a> | |
|
|
9888
|
+
| preconditions | Array<<a href="#precondition">Precondition</a>> | <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> |
|
|
9889
|
+
| property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The property to be evaluated. |
|
|
9890
|
+
| type<sup>\*required</sup> | PreconditionType | |
|
|
9876
9891
|
|
|
9877
9892
|
### PrivateSyntheticLocation
|
|
9878
9893
|
|
|
@@ -9880,26 +9895,27 @@ Configuration of a private synthetic location.
|
|
|
9880
9895
|
|
|
9881
9896
|
Some fields are inherited from the base _SyntheticLocation_ object.
|
|
9882
9897
|
|
|
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>).
|
|
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.
|
|
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
|
-
|
|
|
9898
|
-
|
|
|
9899
|
-
|
|
|
9900
|
-
|
|
|
9901
|
-
|
|
|
9902
|
-
|
|
|
9898
|
+
| Name | Type | Description |
|
|
9899
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9900
|
+
| 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>). |
|
|
9901
|
+
| 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. |
|
|
9902
|
+
| 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. |
|
|
9903
|
+
| 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. |
|
|
9904
|
+
| city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
|
|
9905
|
+
| 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> |
|
|
9906
|
+
| 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> |
|
|
9907
|
+
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location. |
|
|
9908
|
+
| geoLocationId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location. |
|
|
9909
|
+
| 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. |
|
|
9910
|
+
| 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. |
|
|
9911
|
+
| 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. |
|
|
9912
|
+
| namExecutionSupported | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
|
|
9913
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
|
|
9914
|
+
| nodes | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <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> |
|
|
9915
|
+
| 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> |
|
|
9916
|
+
| status | SyntheticLocationStatus | |
|
|
9917
|
+
| type<sup>\*required</sup> | SyntheticLocationType | |
|
|
9918
|
+
| 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
9919
|
|
|
9904
9920
|
### Problem
|
|
9905
9921
|
|
|
@@ -9970,27 +9986,27 @@ The vulnerable functions of a process group including their usage.
|
|
|
9970
9986
|
|
|
9971
9987
|
Configuration of a property in a settings schema.
|
|
9972
9988
|
|
|
9973
|
-
| Name | Type
|
|
9974
|
-
| ------------------------------- |
|
|
9975
|
-
| constraints | Array<<a href="#constraint">Constraint</a>>
|
|
9976
|
-
| datasource | <a href="#datasourcedefinition">DatasourceDefinition</a>
|
|
9977
|
-
| default |
|
|
9978
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9979
|
-
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9980
|
-
| documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9981
|
-
| forceSecretResubmission | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
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>
|
|
9984
|
-
| metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>
|
|
9985
|
-
| migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9986
|
-
| minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
9987
|
-
| modificationPolicy | PropertyDefinitionModificationPolicy
|
|
9988
|
-
| nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
9989
|
-
| precondition | <a href="#precondition">Precondition</a>
|
|
9990
|
-
| referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9991
|
-
| subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9992
|
-
| type<sup>\*required</sup> | PropertyDefinitionType
|
|
9993
|
-
| uiCustomization | <a href="#uicustomization">UiCustomization</a>
|
|
9989
|
+
| Name | Type | Description |
|
|
9990
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9991
|
+
| constraints | Array<<a href="#constraint">Constraint</a>> | A list of constraints limiting the values to be accepted. |
|
|
9992
|
+
| datasource | <a href="#datasourcedefinition">DatasourceDefinition</a> | |
|
|
9993
|
+
| default | PropertyDefinitionDefault | |
|
|
9994
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the property. |
|
|
9995
|
+
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the property. |
|
|
9996
|
+
| documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | An extended description and/or links to documentation. |
|
|
9997
|
+
| 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 |
|
|
9998
|
+
| items | <a href="#item">Item</a> | |
|
|
9999
|
+
| 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> |
|
|
10000
|
+
| metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a> | |
|
|
10001
|
+
| migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pattern with references to properties to create a new value. |
|
|
10002
|
+
| 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. |
|
|
10003
|
+
| modificationPolicy | PropertyDefinitionModificationPolicy | |
|
|
10004
|
+
| 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>. |
|
|
10005
|
+
| precondition | <a href="#precondition">Precondition</a> | |
|
|
10006
|
+
| referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type referenced by the property value |
|
|
10007
|
+
| subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The subtype of the property's value. |
|
|
10008
|
+
| type<sup>\*required</sup> | PropertyDefinitionType | |
|
|
10009
|
+
| uiCustomization | <a href="#uicustomization">UiCustomization</a> | |
|
|
9994
10010
|
|
|
9995
10011
|
### PropertyDefinitionMetadata
|
|
9996
10012
|
|
|
@@ -10129,7 +10145,7 @@ A Release is a combination of a component and a version.
|
|
|
10129
10145
|
A Component can be any form of deployable that can be associated with a version.
|
|
10130
10146
|
In the first draft, a Component is always a Service.
|
|
10131
10147
|
|
|
10132
|
-
The tuple
|
|
10148
|
+
The tuple <name, product, stage, version> is always unique.
|
|
10133
10149
|
|
|
10134
10150
|
| Name | Type | Description |
|
|
10135
10151
|
| --------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
@@ -10798,60 +10814,60 @@ Analysis of problem impact to a service.
|
|
|
10798
10814
|
|
|
10799
10815
|
A settings object.
|
|
10800
10816
|
|
|
10801
|
-
| Name | Type
|
|
10802
|
-
| ---------------- |
|
|
10803
|
-
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10804
|
-
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10805
|
-
| createdBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10806
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10807
|
-
| modificationInfo | <a href="#modificationinfo">ModificationInfo</a>
|
|
10808
|
-
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10809
|
-
| modifiedBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10810
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10811
|
-
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10812
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10813
|
-
| scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10814
|
-
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10815
|
-
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10816
|
-
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10817
|
-
| value |
|
|
10817
|
+
| Name | Type | Description |
|
|
10818
|
+
| ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10819
|
+
| 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. |
|
|
10820
|
+
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
|
|
10821
|
+
| 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. |
|
|
10822
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
|
|
10823
|
+
| modificationInfo | <a href="#modificationinfo">ModificationInfo</a> | |
|
|
10824
|
+
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
|
|
10825
|
+
| 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. |
|
|
10826
|
+
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the settings object. |
|
|
10827
|
+
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
|
|
10828
|
+
| 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. |
|
|
10829
|
+
| 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>. |
|
|
10830
|
+
| 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. |
|
|
10831
|
+
| 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. |
|
|
10832
|
+
| 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> |
|
|
10833
|
+
| value | SettingsValue | |
|
|
10818
10834
|
|
|
10819
10835
|
### SettingsObjectCreate
|
|
10820
10836
|
|
|
10821
10837
|
Configuration of a new settings object.
|
|
10822
10838
|
|
|
10823
|
-
| Name | Type
|
|
10824
|
-
| ----------------------------- |
|
|
10825
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10826
|
-
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10827
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10828
|
-
| schemaId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10829
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10830
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10831
|
-
| value<sup>\*required</sup> |
|
|
10839
|
+
| Name | Type | Description |
|
|
10840
|
+
| ----------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10841
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | External identifier for the object being created |
|
|
10842
|
+
| 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> |
|
|
10843
|
+
| 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> |
|
|
10844
|
+
| 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. |
|
|
10845
|
+
| 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. |
|
|
10846
|
+
| 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>. |
|
|
10847
|
+
| value<sup>\*required</sup> | SettingsValue | |
|
|
10832
10848
|
|
|
10833
10849
|
### SettingsObjectResponse
|
|
10834
10850
|
|
|
10835
10851
|
The response to a creation- or update-request.
|
|
10836
10852
|
|
|
10837
|
-
| Name | Type
|
|
10838
|
-
| ------------------------- |
|
|
10839
|
-
| code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10840
|
-
| error | <a href="#error">Error</a>
|
|
10841
|
-
| invalidValue |
|
|
10842
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10853
|
+
| Name | Type | Description |
|
|
10854
|
+
| ------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
10855
|
+
| code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP status code for the object. |
|
|
10856
|
+
| error | <a href="#error">Error</a> | |
|
|
10857
|
+
| invalidValue | SettingsValue | |
|
|
10858
|
+
| 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
10859
|
|
|
10844
10860
|
### SettingsObjectUpdate
|
|
10845
10861
|
|
|
10846
10862
|
An update of a settings object.
|
|
10847
10863
|
|
|
10848
|
-
| Name | Type
|
|
10849
|
-
| -------------------------- |
|
|
10850
|
-
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10851
|
-
| insertBefore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10852
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10853
|
-
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10854
|
-
| value<sup>\*required</sup> |
|
|
10864
|
+
| Name | Type | Description |
|
|
10865
|
+
| -------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10866
|
+
| 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> |
|
|
10867
|
+
| 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> |
|
|
10868
|
+
| 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. |
|
|
10869
|
+
| 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> |
|
|
10870
|
+
| value<sup>\*required</sup> | SettingsValue | |
|
|
10855
10871
|
|
|
10856
10872
|
### SloBurnRate
|
|
10857
10873
|
|
|
@@ -10999,11 +11015,10 @@ Outage handling configuration.
|
|
|
10999
11015
|
| Name | Type | Description |
|
|
11000
11016
|
| ------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
11001
11017
|
| globalConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures for all locations. |
|
|
11002
|
-
| globalOutages
|
|
11018
|
+
| globalOutages | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable at all configured locations. |
|
|
11003
11019
|
| localConsecutiveOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of consecutive failures. |
|
|
11004
11020
|
| localLocationOutageCountThreshold | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of failing locations. |
|
|
11005
|
-
| localOutages
|
|
11006
|
-
| type<sup>\*required</sup> | MultiProtocol | |
|
|
11021
|
+
| localOutages | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
|
|
11007
11022
|
|
|
11008
11023
|
### SyntheticMonitorSummaryDto
|
|
11009
11024
|
|
|
@@ -11040,16 +11055,11 @@ Network Availability monitor.
|
|
|
11040
11055
|
| frequencyMin<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
|
|
11041
11056
|
| locations<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations to which the monitor is assigned. |
|
|
11042
11057
|
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
|
|
11043
|
-
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitordtoproperties">SyntheticMultiProtocolMonitorDtoProperties</a> | |
|
|
11044
11058
|
| steps<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>> | The steps of the monitor. |
|
|
11045
11059
|
| syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
|
|
11046
11060
|
| tags | Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>> | <p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
11047
11061
|
| type<sup>\*required</sup> | SyntheticMultiProtocolMonitorDtoType | |
|
|
11048
11062
|
|
|
11049
|
-
### SyntheticMultiProtocolMonitorDtoProperties
|
|
11050
|
-
|
|
11051
|
-
The properties of the monitor.
|
|
11052
|
-
|
|
11053
11063
|
### SyntheticMultiProtocolMonitorStepDto
|
|
11054
11064
|
|
|
11055
11065
|
The step of a network availability monitor.
|
|
@@ -11072,34 +11082,24 @@ The properties which apply to all requests in the step.
|
|
|
11072
11082
|
|
|
11073
11083
|
Network availability monitor.
|
|
11074
11084
|
|
|
11075
|
-
| Name | Type
|
|
11076
|
-
| -------------------------------------- |
|
|
11077
|
-
| active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
11078
|
-
| frequencyMin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11079
|
-
| locations<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>>
|
|
11080
|
-
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11081
|
-
|
|
|
11082
|
-
|
|
|
11083
|
-
|
|
|
11084
|
-
|
|
|
11085
|
-
| type<sup>\*required</sup> | MultiProtocol | |
|
|
11086
|
-
|
|
11087
|
-
### SyntheticMultiProtocolMonitorUpdateDtoProperties
|
|
11088
|
-
|
|
11089
|
-
The properties of the monitor.
|
|
11085
|
+
| Name | Type | Description |
|
|
11086
|
+
| -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11087
|
+
| active | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If false, the monitor is disabled. <i>default:</i> <code>true</code> |
|
|
11088
|
+
| frequencyMin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The frequency of the monitor, in minutes. |
|
|
11089
|
+
| locations<sup>\*required</sup> | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations to which the monitor is assigned. |
|
|
11090
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the monitor. |
|
|
11091
|
+
| steps<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>> | The steps of the monitor. |
|
|
11092
|
+
| syntheticMonitorOutageHandlingSettings | <a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a> | |
|
|
11093
|
+
| tags | Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>> | <p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
11094
|
+
| type<sup>\*required</sup> | MultiProtocol | |
|
|
11090
11095
|
|
|
11091
11096
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
11092
11097
|
|
|
11093
11098
|
The configuration of a network availability monitor request.
|
|
11094
11099
|
|
|
11095
|
-
| Name | Type
|
|
11096
|
-
| -------------------------------- |
|
|
11097
|
-
| constraints<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>
|
|
11098
|
-
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolrequestconfigurationdtoproperties">SyntheticMultiProtocolRequestConfigurationDtoProperties</a> | |
|
|
11099
|
-
|
|
11100
|
-
### SyntheticMultiProtocolRequestConfigurationDtoProperties
|
|
11101
|
-
|
|
11102
|
-
Request properties.
|
|
11100
|
+
| Name | Type | Description |
|
|
11101
|
+
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -------------------- |
|
|
11102
|
+
| constraints<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>> | Request constraints. |
|
|
11103
11103
|
|
|
11104
11104
|
### SyntheticOnDemandBatchStatus
|
|
11105
11105
|
|
|
@@ -11128,24 +11128,24 @@ String to string map of metadata properties for batch
|
|
|
11128
11128
|
|
|
11129
11129
|
Describes the status of an on-demand execution.
|
|
11130
11130
|
|
|
11131
|
-
| Name | Type
|
|
11132
|
-
| ------------------------------------------ |
|
|
11133
|
-
| batchId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11134
|
-
| customizedScript |
|
|
11135
|
-
| dataDeliveryTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11136
|
-
| executionId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11137
|
-
| executionStage<sup>\*required</sup> | SyntheticOnDemandExecutionExecutionStage
|
|
11138
|
-
| executionTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
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>
|
|
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>
|
|
11143
|
-
| nextExecutionId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11144
|
-
| processingMode<sup>\*required</sup> | SyntheticOnDemandExecutionProcessingMode
|
|
11145
|
-
| schedulingTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
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>
|
|
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 | ObjectNode | |
|
|
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. |
|
|
11149
11149
|
|
|
11150
11150
|
### SyntheticOnDemandExecutionMetadata
|
|
11151
11151
|
|
|
@@ -11187,7 +11187,7 @@ Contains monitors to be executed on demand from the locations specified.
|
|
|
11187
11187
|
|
|
11188
11188
|
| Name | Type | Description |
|
|
11189
11189
|
| ------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11190
|
-
| customizedScript |
|
|
11190
|
+
| customizedScript | SyntheticOnDemandExecutionRequestMonitorCustomizedScript | |
|
|
11191
11191
|
| 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
11192
|
| locations | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | The locations from where the monitor is to be executed. |
|
|
11193
11193
|
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier. |
|
|
@@ -11264,14 +11264,15 @@ Configuration of a private synthetic location
|
|
|
11264
11264
|
| -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11265
11265
|
| 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
11266
|
| 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>).
|
|
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. |
|
|
11268
11268
|
| 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
11269
|
| city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
|
|
11270
11270
|
| 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
11271
|
| 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
11272
|
| 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.
|
|
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. |
|
|
11274
11274
|
| 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
|
+
| namExecutionSupported | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes if icmp monitors will be executed on this location:</p> <ul> <li><code>false</code>: Icmp monitor executions disabled.</li> <li><code>true</code>: Icmp monitor executions enabled.</li> </ul> |
|
|
11275
11276
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
|
|
11276
11277
|
| nodes | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <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> |
|
|
11277
11278
|
| 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> |
|
|
@@ -12052,7 +12053,7 @@ The type of code level vulnerability.
|
|
|
12052
12053
|
|
|
12053
12054
|
<div class="padding-left--md">
|
|
12054
12055
|
|
|
12055
|
-
`CmdInjection` | `ImproperInputValidation` | `SqlInjection`
|
|
12056
|
+
`CmdInjection` | `ImproperInputValidation` | `SqlInjection` | `Ssrf`
|
|
12056
12057
|
|
|
12057
12058
|
</div>
|
|
12058
12059
|
|
|
@@ -13195,7 +13196,7 @@ The name of the monitoring state.
|
|
|
13195
13196
|
|
|
13196
13197
|
<div class="padding-left--md">
|
|
13197
13198
|
|
|
13198
|
-
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
13199
|
+
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
13199
13200
|
|
|
13200
13201
|
</div>
|
|
13201
13202
|
|
|
@@ -14222,24 +14223,6 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
14222
14223
|
|
|
14223
14224
|
</div>
|
|
14224
14225
|
|
|
14225
|
-
### SyntheticMonitorOutageHandlingSettingsDtoType
|
|
14226
|
-
|
|
14227
|
-
<div class="padding-left--md">
|
|
14228
|
-
|
|
14229
|
-
Defines the actual set of fields depending on the value. See one of the following objects:
|
|
14230
|
-
|
|
14231
|
-
- `MULTI_PROTOCOL` -> SyntheticMultiProtocolMonitorUpdateDto
|
|
14232
|
-
|
|
14233
|
-
#### Enum keys
|
|
14234
|
-
|
|
14235
|
-
<div class="padding-left--md">
|
|
14236
|
-
|
|
14237
|
-
`MultiProtocol`
|
|
14238
|
-
|
|
14239
|
-
</div>
|
|
14240
|
-
|
|
14241
|
-
</div>
|
|
14242
|
-
|
|
14243
14226
|
### SyntheticMonitorSummaryDtoType
|
|
14244
14227
|
|
|
14245
14228
|
<div class="padding-left--md">
|
|
@@ -14518,7 +14501,7 @@ The type of the input.
|
|
|
14518
14501
|
|
|
14519
14502
|
<div class="padding-left--md">
|
|
14520
14503
|
|
|
14521
|
-
`Command` | `Jndi` | `SqlStatement`
|
|
14504
|
+
`Command` | `HttpClient` | `Jndi` | `SqlStatement`
|
|
14522
14505
|
|
|
14523
14506
|
</div>
|
|
14524
14507
|
|