@dynatrace-sdk/client-classic-environment-v2 1.7.0 → 1.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/README.md +1 -1
- package/cjs/index.js +2901 -2654
- package/docs/DOCS.md +491 -412
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +2901 -2654
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +29 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +6 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/{synthetic-multi-protocol-monitors-api.d.ts → synthetic-network-availability-monitors-api.d.ts} +26 -26
- 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/api-token-create-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +2 -0
- 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/credentials-response-element.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.transformation.d.ts +1 -0
- 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/event-ingest-properties.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto-actions.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto-actions.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-response.transformation.d.ts +6 -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 +6 -0
- 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/log-records-list.d.ts +1 -1
- 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/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-multi-protocol-monitor-constraint-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-request-configuration-dto.d.ts +1 -1
- 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/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.8.2">
|
|
30
|
+
v1.8.2
|
|
31
|
+
</a>
|
|
28
32
|
</div>
|
|
29
33
|
</div>
|
|
30
34
|
|
|
@@ -196,7 +200,7 @@ Deletes an ActiveGate token
|
|
|
196
200
|
| ----------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
197
201
|
| config.activeGateTokenIdentifier<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ActiveGate token identifier, consisting of <a href="https://dt-url.net/rn00tjg">prefix and public part</a> of the token to be deleted. |
|
|
198
202
|
|
|
199
|
-
|
|
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
|
|
|
@@ -2213,6 +2217,56 @@ const data = await extensions_2_0Client.deleteEnvironmentConfiguration({
|
|
|
2213
2217
|
|
|
2214
2218
|
</div>
|
|
2215
2219
|
|
|
2220
|
+
### executeExtensionMonitoringConfigurationActions
|
|
2221
|
+
|
|
2222
|
+
<div class="padding-bottom--md">
|
|
2223
|
+
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse">ExecuteActionsResponse</a>></strong>
|
|
2224
|
+
|
|
2225
|
+
<div class="padding-left--md">
|
|
2226
|
+
|
|
2227
|
+
Executes Data Source action of Active Gate or Host
|
|
2228
|
+
|
|
2229
|
+
**Required scope:** environment-api:extension-configuration-actions:write
|
|
2230
|
+
**One of the following permissions is required:**
|
|
2231
|
+
|
|
2232
|
+
- environment:roles:manage-settings
|
|
2233
|
+
- extensions:configuration.actions:write
|
|
2234
|
+
|
|
2235
|
+
</div>
|
|
2236
|
+
|
|
2237
|
+
#### Parameters
|
|
2238
|
+
|
|
2239
|
+
| Name | Type | Description |
|
|
2240
|
+
| ------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
2241
|
+
| config.body<sup>\*required</sup> | <a href="#executeactionsdto">ExecuteActionsDto</a> | |
|
|
2242
|
+
| 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. |
|
|
2243
|
+
| 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. |
|
|
2244
|
+
|
|
2245
|
+
#### Returns
|
|
2246
|
+
|
|
2247
|
+
Accepted. Response doesn't have a body.
|
|
2248
|
+
|
|
2249
|
+
<details>
|
|
2250
|
+
<summary>
|
|
2251
|
+
Code example
|
|
2252
|
+
|
|
2253
|
+
</summary>
|
|
2254
|
+
|
|
2255
|
+
```ts
|
|
2256
|
+
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2257
|
+
|
|
2258
|
+
const data =
|
|
2259
|
+
await extensions_2_0Client.executeExtensionMonitoringConfigurationActions({
|
|
2260
|
+
extensionName: "...",
|
|
2261
|
+
configurationId: "...",
|
|
2262
|
+
body: {},
|
|
2263
|
+
});
|
|
2264
|
+
```
|
|
2265
|
+
|
|
2266
|
+
</details>
|
|
2267
|
+
|
|
2268
|
+
</div>
|
|
2269
|
+
|
|
2216
2270
|
### extensionConfigurationSchema
|
|
2217
2271
|
|
|
2218
2272
|
<div class="padding-bottom--md">
|
|
@@ -2650,7 +2704,7 @@ const data =
|
|
|
2650
2704
|
### getSchemaFile
|
|
2651
2705
|
|
|
2652
2706
|
<div class="padding-bottom--md">
|
|
2653
|
-
<strong>extensions_2_0Client.getSchemaFile(config): Promise<
|
|
2707
|
+
<strong>extensions_2_0Client.getSchemaFile(config): Promise<JsonNode></strong>
|
|
2654
2708
|
|
|
2655
2709
|
<div class="padding-left--md">
|
|
2656
2710
|
|
|
@@ -2941,7 +2995,7 @@ Lists all the extension 2.0 schemas versions available in your environment
|
|
|
2941
2995
|
|
|
2942
2996
|
</div>
|
|
2943
2997
|
|
|
2944
|
-
|
|
2998
|
+
{/* no parameters */}
|
|
2945
2999
|
|
|
2946
3000
|
#### Returns
|
|
2947
3001
|
|
|
@@ -3081,7 +3135,7 @@ Deletes the specified monitoring configuration
|
|
|
3081
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. |
|
|
3082
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. |
|
|
3083
3137
|
|
|
3084
|
-
|
|
3138
|
+
{/* no returns */}
|
|
3085
3139
|
|
|
3086
3140
|
<details>
|
|
3087
3141
|
<summary>
|
|
@@ -3260,7 +3314,7 @@ import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
|
3260
3314
|
|
|
3261
3315
|
Exports log records | maturity=EARLY_ADOPTER
|
|
3262
3316
|
|
|
3263
|
-
**Required scope:**
|
|
3317
|
+
**Required scope:** storage:logs:read
|
|
3264
3318
|
**Required permission:** environment:roles:logviewer
|
|
3265
3319
|
|
|
3266
3320
|
Returns the first _X_ records (specified in the **pageSize** query parameter).
|
|
@@ -3322,7 +3376,7 @@ It is possible that the timeframe covered by results exceeds the specified timef
|
|
|
3322
3376
|
|
|
3323
3377
|
If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OAuth token (with _storage:logs:read_ and _storage:buckets:read_ scopes) needs to be used for authentication.
|
|
3324
3378
|
|
|
3325
|
-
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication
|
|
3379
|
+
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication.
|
|
3326
3380
|
|
|
3327
3381
|
</div>
|
|
3328
3382
|
|
|
@@ -3371,13 +3425,13 @@ Reads log records | maturity=EARLY_ADOPTER
|
|
|
3371
3425
|
|
|
3372
3426
|
Returns the first _X_ records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
|
|
3373
3427
|
|
|
3374
|
-
If the query is too large to be processed in a single request, it is divided into slices. In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
|
|
3428
|
+
If the query is too large to be processed in a single request, it is divided into slices (slices are unsupported on _Log Management and Analytics, powered by Grail_). In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
|
|
3375
3429
|
|
|
3376
3430
|
Results can be distributed unevenly between slices and some slices might be empty.
|
|
3377
3431
|
|
|
3378
3432
|
If _Log Management and Analytics, powered by Grail_ is enabled, then a bearer OAuth token (with _storage:logs:read_ and _storage:buckets:read_ scopes) needs to be used for authentication.
|
|
3379
3433
|
|
|
3380
|
-
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication
|
|
3434
|
+
Please note that _Dynatrace API explorer_ does not currently support OAuth authentication.
|
|
3381
3435
|
|
|
3382
3436
|
</div>
|
|
3383
3437
|
|
|
@@ -3387,7 +3441,7 @@ Please note that _Dynatrace API explorer_ does not currently support OAuth authe
|
|
|
3387
3441
|
| ------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3388
3442
|
| 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> |
|
|
3389
3443
|
| config.limit | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p> <i>default:</i> <code>1000</code> |
|
|
3390
|
-
| config.nextSliceKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next slice of results. You can find it in the <strong>nextSliceKey</strong> field of the previous response.</p> <p>The first slice is always returned if you don't specify this parameter.</p> <p>If this parameter is set, all other query parameters are ignored.</p>
|
|
3444
|
+
| config.nextSliceKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next slice of results. You can find it in the <strong>nextSliceKey</strong> field of the previous response.</p> <p>The first slice is always returned if you don't specify this parameter.</p> <p>If this parameter is set, all other query parameters are ignored.</p> <p>Unsupported on <em>Log Management and Analytics, powered by Grail</em>.</p> |
|
|
3391
3445
|
| config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f">Dynatrace search query language</a>.</p> <i>default:</i> <code>""</code> |
|
|
3392
3446
|
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> <i>default:</i> <code>"-timestamp"</code> |
|
|
3393
3447
|
| 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> |
|
|
@@ -3462,7 +3516,7 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
|
|
|
3462
3516
|
|
|
3463
3517
|
</div>
|
|
3464
3518
|
|
|
3465
|
-
|
|
3519
|
+
{/* no parameters */}
|
|
3466
3520
|
|
|
3467
3521
|
#### Returns
|
|
3468
3522
|
|
|
@@ -3542,7 +3596,7 @@ You can additionally limit the output by using pagination:
|
|
|
3542
3596
|
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
|
|
3543
3597
|
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of metric properties included in the response.</p> <p><code>metricId</code> is <strong>always</strong> included in the result. The following additional properties are available:</p> <ul> <li><code>displayName</code>: The name of the metric in the user interface. Enabled by default.</li> <li><code>description</code>: A short description of the metric. Enabled by default.</li> <li><code>unit</code>: The unit of the metric. Enabled by default.</li> <li><code>tags</code>: The tags of the metric.</li> </ul> <ul> <li><code>dduBillable</code>: An indicator whether the usage of metric consumes <a href="https://dt-url.net/ddu">Davis data units</a>. Deprecated and always <code>false</code> for Dynatrace Platform Subscription. Superseded by <code>billable</code>.</li> <li><code>billable</code>: An indicator whether the usage of metric is billable.</li> </ul> <ul> <li><code>created</code>: The timestamp (UTC milliseconds) when the metrics has been created.</li> <li><code>lastWritten</code>: The timestamp (UTC milliseconds) when metric data points have been written for the last time.</li> <li><code>aggregationTypes</code>: The list of allowed aggregations for the metric. Note that it may be different after a <a href="https://dt-url.net/metricSelector">transformation</a> is applied.</li> <li><code>defaultAggregation</code>: The default aggregation of the metric. It is used when no aggregation is specified or the <code>:auto</code> transformation is set.</li> <li><code>dimensionDefinitions</code>: The fine metric division (for example, process group and process ID for some process-related metric).</li> <li><code>transformations</code>: A list of <a href="https://dt-url.net/metricSelector">transformations</a> that can be applied to the metric.</li> <li><code>entityType</code>: A list of entity types supported by the metric.</li> <li><code>minimumValue</code>: The minimum allowed value of the metric.</li> <li><code>maximumValue</code>: The maximum allowed value of the metric.</li> <li><code>rootCauseRelevant</code>: Whether (true or false) the metric is related to a root cause of a problem. A root-cause relevant metric represents a strong indicator for a faulty component.</li> <li><code>impactRelevant</code>: Whether (true or false) the metric is relevant to a problem's impact. An impact-relevant metric is highly dependent on other metrics and changes because an underlying root-cause metric has changed.</li> <li><code>metricValueType</code>: The type of the metric's value. You have these options: <ul> <li><code>score</code>: A score metric is a metric where high values indicate a good situation, while low values indicate trouble. An example of such a metric is a success rate.</li> <li><code>error</code>: An error metric is a metric where high values indicate trouble, while low values indicate a good situation. An example of such a metric is an error count.</li> </ul> </li> <li><code>latency</code>: The latency of the metric, in minutes. The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace. The allowed value range is from <code>1</code> to <code>60</code> minutes.</li> <li><code>metricSelector</code>: The underlying metric selector used by a func: metric.</li> <li><code>scalar</code>: Indicates whether the metric expression resolves to a scalar (<code>true</code>) or to a series (<code>false</code>). A scalar result always contains one data point. The amount of data points in a series result depends on the resolution you're using.</li> <li><code>resolutionInfSupported</code>: If <code>true</code>, resolution=Inf can be applied to the metric query.</li> </ul> <p>To add properties, list them with leading plus <code>+</code>. To exclude default properties, list them with leading minus <code>-</code>.</p> <p>To specify several properties, join them with a comma (for example <code>fields=+aggregationTypes,-description</code>).</p> <p>If you specify just one property, the response contains the metric key and the specified property. To return metric keys only, specify <code>metricId</code> here.</p> |
|
|
3544
3598
|
| config.metadataSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The metadata scope of the query. Only metrics with specified properties are included to the response.</p> <p>You can set one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li> <p><code>unit("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> |
|
|
3545
|
-
| 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
|
|
3599
|
+
| config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Selects metrics for the query by their keys.</p> <p>You can specify multiple metric keys separated by commas (for example, <code>metrickey1,metrickey2</code>). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the <code>builtin:host.cpu.idle</code> and <code>builtin:host.cpu.user</code> metric, write: <code>builtin:host.cpu.(idle,user)</code>.</p> <p>You can select a full set of related metrics by using a trailing asterisk (<code>\*</code>) wildcard. For example, <code>builtin:host.\*</code> selects all host-based metrics and <code>builtin:\*</code> selects all Dynatrace-provided metrics.</p> <p>You can set additional transformation operators, separated by a colon (<code>:</code>). See <a href="https://dt-url.net/metricSelector">Metrics selector transformations</a> in Dynatrace Documentation for additional information on available result transformations and syntax.</p> <p>Only <code>aggregation</code>, <code>merge</code>, <code>parents</code>, and <code>splitBy</code> transformations are supported by this endpoint.</p> <p>If the metric key contains any symbols you must quote (<code>"</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> |
|
|
3546
3600
|
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
3547
3601
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of metric schemata in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> <p>If a value higher than 500 is used, only 500 results per page are returned.</p> |
|
|
3548
3602
|
| config.text | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Metric registry search term. Only show metrics that contain the term in their key, display name, or description. Use the <code>metricSelector</code> parameter instead of this one to select a complete metric hierarchy instead of doing a text-based search. |
|
|
@@ -3592,7 +3646,7 @@ Deletion cannot be undone! You can't delete a metric if it has data points inges
|
|
|
3592
3646
|
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------- |
|
|
3593
3647
|
| config.metricKey<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The key of the required metric. |
|
|
3594
3648
|
|
|
3595
|
-
|
|
3649
|
+
{/* no returns */}
|
|
3596
3650
|
|
|
3597
3651
|
<details>
|
|
3598
3652
|
<summary>
|
|
@@ -3724,15 +3778,15 @@ The **dimensionCountRatio** specifies the ratio of queried dimension tuples divi
|
|
|
3724
3778
|
|
|
3725
3779
|
#### Parameters
|
|
3726
3780
|
|
|
3727
|
-
| Name | Type | Description
|
|
3728
|
-
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
3729
|
-
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" |
|
|
3730
|
-
| 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
|
|
3731
|
-
| 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>
|
|
3732
|
-
| 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
|
|
3733
|
-
| 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>
|
|
3734
|
-
| 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>
|
|
3735
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
3781
|
+
| Name | Type | Description |
|
|
3782
|
+
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3783
|
+
| config.acceptType<sup>\*required</sup> | "application/json; charset=utf-8" | "text/csv; header=absent; charset=utf-8" | "text/csv; header=present; charset=utf-8" | |
|
|
3784
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the entity scope of the query. Only data points delivered by matched entities are included in response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
3785
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
3786
|
+
| config.metricSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Selects metrics for the query by their keys. You can select up to 10 metrics for one query.</p> <p>You can specify multiple metric keys separated by commas (for example, <code>metrickey1,metrickey2</code>). To select multiple metrics belonging to the same parent, list the last part of the required metric keys in parentheses, separated by commas, while keeping the common part untouched. For example, to list the <code>builtin:host.cpu.idle</code> and <code>builtin:host.cpu.user</code> metric, write: <code>builtin:host.cpu.(idle,user)</code>.</p> <p>If the metric key contains any symbols you must quote (<code>"</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> |
|
|
3787
|
+
| config.mzSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The management zone scope of the query. Only metrics data relating to the specified management zones are included to the response.</p> <p>You can set one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li><code>mzId(123,456)</code></li> <li><code>mzName("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> |
|
|
3788
|
+
| config.resolution | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The desired resolution of data points.</p> <p>You can use one of the following options:</p> <ul> <li>The desired amount of data points. This is the default option. This is a reference number of points, which is not necessarily equal to the number of the returned data points.</li> <li>The desired timespan between data points. This is a reference timespan, which is not necessarily equal to the returned timespan. To use this option, specify the unit of the timespan.</li> </ul> <p>Valid units for the timespan are:</p> <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>q</code>: quarters</li> <li><code>y</code>: years</li> </ul> <p>If not set, the default is <strong>120 data points</strong>.</p> <p>For example:</p> <ul> <li>Get data points which are 10 minutes apart: <code>resolution=10m</code></li> <li>Get data points which are 3 weeks apart: <code>resolution=3w</code></li> </ul> |
|
|
3789
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3736
3790
|
|
|
3737
3791
|
#### Returns
|
|
3738
3792
|
|
|
@@ -3930,15 +3984,15 @@ You can limit the output by using pagination:
|
|
|
3930
3984
|
|
|
3931
3985
|
#### Parameters
|
|
3932
3986
|
|
|
3933
|
-
| Name | Type | Description
|
|
3934
|
-
| --------------------- | ----------------------------------------------------------------------------- |
|
|
3935
|
-
| 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
|
|
3936
|
-
| 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>
|
|
3937
|
-
| 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>
|
|
3938
|
-
| 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>
|
|
3939
|
-
| 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>
|
|
3940
|
-
| 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>
|
|
3941
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
3987
|
+
| Name | Type | Description |
|
|
3988
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3989
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only entities matching the specified criteria are included into response.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
3990
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the list of entity properties included in the response. The ID and the name of an entity are <strong>always</strong> included to the response.</p> <p>To add properties, list them with leading plus <code>+</code>. You can specify several properties, separated by a comma (for example <code>fields=+lastSeenTms,+properties.BITNESS</code>).</p> <p>Use the <a href="https://dt-url.net/2ka3ivt">GET entity type</a> request to fetch the list of properties available for your entity type. Fields from the <strong>properties</strong> object must be specified in the <code>properties.FIELD</code> format (for example, <code>properties.BITNESS</code>).</p> <p>When requesting large amounts of relationship fields, throttling can apply.</p> |
|
|
3991
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of three days is used (<code>now-3d</code>).</p> |
|
|
3992
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
3993
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of entities.</p> <p>If not set, 50 is used.</p> |
|
|
3994
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the ordering of the entities returned.</p> <p>This field is <strong>optional</strong>, each field has a sign prefix (+/-), which corresponds to sorting order ( + for ascending and - for descending). If no sign prefix is set, then default ascending sorting order will be applied.</p> <p>Currently ordering is only available for the display name (for example <code>sort=name or sort =+name for ascending, sort=-name for descending</code>)</p> |
|
|
3995
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
3942
3996
|
|
|
3943
3997
|
#### Returns
|
|
3944
3998
|
|
|
@@ -4157,14 +4211,14 @@ Deletes the specified tag from the specified entities
|
|
|
4157
4211
|
|
|
4158
4212
|
#### Parameters
|
|
4159
4213
|
|
|
4160
|
-
| Name | Type | Description
|
|
4161
|
-
| ------------------------------------------ | ------------------------------------------------------------------------------- |
|
|
4162
|
-
| 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>
|
|
4163
|
-
| 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
|
|
4164
|
-
| 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>
|
|
4165
|
-
| 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>
|
|
4166
|
-
| 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>
|
|
4167
|
-
| config.value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The value of the tag to be deleted. The value is ignored if <strong>deleteAllWithKey</strong> is <code>true</code>.</p> <p>For value-only tags, specify the value in the <strong>key</strong> parameter.</p>
|
|
4214
|
+
| Name | Type | Description |
|
|
4215
|
+
| ------------------------------------------ | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4216
|
+
| config.deleteAllWithKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <ul> <li>If <code>true</code>, all tags with the specified key are deleted, regardless of the value.</li> <li>If <code>false</code>, only tags with exact match of key <strong>and</strong> value are deleted.</li> </ul> <p>If not set, <code>false</code> is used.</p> |
|
|
4217
|
+
| config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the entities where you want to delete tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
4218
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
4219
|
+
| config.key<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The key of the tag to be deleted.</p> <p>If <strong>deleteAllWithKey</strong> is <code>true</code>, then all tags with this key are deleted. Otherwise, only tags with exact match of key <strong>and</strong> value are deleted.</p> <p>For value-only tags, specify the value here.</p> |
|
|
4220
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
4221
|
+
| config.value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The value of the tag to be deleted. The value is ignored if <strong>deleteAllWithKey</strong> is <code>true</code>.</p> <p>For value-only tags, specify the value in the <strong>key</strong> parameter.</p> |
|
|
4168
4222
|
|
|
4169
4223
|
#### Returns
|
|
4170
4224
|
|
|
@@ -4207,11 +4261,11 @@ Automatically applied tags and imported tags are not included.
|
|
|
4207
4261
|
|
|
4208
4262
|
#### Parameters
|
|
4209
4263
|
|
|
4210
|
-
| Name | Type | Description
|
|
4211
|
-
| ------------------------------------------ | ----------------------------------------------------------------------------- |
|
|
4212
|
-
| 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
|
|
4213
|
-
| 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>
|
|
4214
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
4264
|
+
| Name | Type | Description |
|
|
4265
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4266
|
+
| config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the entities where you want to read tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
4267
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
4268
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
4215
4269
|
|
|
4216
4270
|
#### Returns
|
|
4217
4271
|
|
|
@@ -4253,12 +4307,12 @@ All existing tags remain unaffected.
|
|
|
4253
4307
|
|
|
4254
4308
|
#### Parameters
|
|
4255
4309
|
|
|
4256
|
-
| Name | Type | Description
|
|
4257
|
-
| ------------------------------------------ | ----------------------------------------------------------------------------- |
|
|
4258
|
-
| config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> |
|
|
4259
|
-
| 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
|
|
4260
|
-
| 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>
|
|
4261
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
4310
|
+
| Name | Type | Description |
|
|
4311
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4312
|
+
| config.body<sup>\*required</sup> | <a href="#addentitytags">AddEntityTags</a> | |
|
|
4313
|
+
| config.entitySelector<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the entities where you want to update tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
4314
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of 24 hours is used (<code>now-24h</code>).</p> |
|
|
4315
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
4262
4316
|
|
|
4263
4317
|
#### Returns
|
|
4264
4318
|
|
|
@@ -4307,11 +4361,11 @@ Only process group instances are supported.
|
|
|
4307
4361
|
|
|
4308
4362
|
#### Parameters
|
|
4309
4363
|
|
|
4310
|
-
| Name | Type | Description
|
|
4311
|
-
| --------------------- | ----------------------------------------------------------------------------- |
|
|
4312
|
-
| 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
|
|
4313
|
-
| 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>
|
|
4314
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p>
|
|
4364
|
+
| Name | Type | Description |
|
|
4365
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4366
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
4367
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
4368
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
|
|
4315
4369
|
|
|
4316
4370
|
#### Returns
|
|
4317
4371
|
|
|
@@ -4411,7 +4465,7 @@ If the network zone is used as an alternative zone for any OneAgent, it will be
|
|
|
4411
4465
|
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
4412
4466
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the network zone to be deleted. |
|
|
4413
4467
|
|
|
4414
|
-
|
|
4468
|
+
{/* no returns */}
|
|
4415
4469
|
|
|
4416
4470
|
<details>
|
|
4417
4471
|
<summary>
|
|
@@ -4445,7 +4499,7 @@ Lists all existing network zones
|
|
|
4445
4499
|
|
|
4446
4500
|
</div>
|
|
4447
4501
|
|
|
4448
|
-
|
|
4502
|
+
{/* no parameters */}
|
|
4449
4503
|
|
|
4450
4504
|
#### Returns
|
|
4451
4505
|
|
|
@@ -4524,7 +4578,7 @@ Gets the global configuration of network zones
|
|
|
4524
4578
|
|
|
4525
4579
|
</div>
|
|
4526
4580
|
|
|
4527
|
-
|
|
4581
|
+
{/* no parameters */}
|
|
4528
4582
|
|
|
4529
4583
|
#### Returns
|
|
4530
4584
|
|
|
@@ -4608,7 +4662,7 @@ Updates the global configuration of network zones
|
|
|
4608
4662
|
| -------------------------------- | ------------------------------------------------------ |
|
|
4609
4663
|
| config.body<sup>\*required</sup> | <a href="#networkzonesettings">NetworkZoneSettings</a> |
|
|
4610
4664
|
|
|
4611
|
-
|
|
4665
|
+
{/* no returns */}
|
|
4612
4666
|
|
|
4613
4667
|
<details>
|
|
4614
4668
|
<summary>
|
|
@@ -4699,7 +4753,7 @@ Adds a new comment on the specified problem
|
|
|
4699
4753
|
| config.body<sup>\*required</sup> | <a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a> | |
|
|
4700
4754
|
| config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
|
|
4701
4755
|
|
|
4702
|
-
|
|
4756
|
+
{/* no returns */}
|
|
4703
4757
|
|
|
4704
4758
|
<details>
|
|
4705
4759
|
<summary>
|
|
@@ -4741,7 +4795,7 @@ Deletes the specified comment from a problem
|
|
|
4741
4795
|
| config.commentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required comment. |
|
|
4742
4796
|
| config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
|
|
4743
4797
|
|
|
4744
|
-
|
|
4798
|
+
{/* no returns */}
|
|
4745
4799
|
|
|
4746
4800
|
<details>
|
|
4747
4801
|
<summary>
|
|
@@ -4909,16 +4963,16 @@ Lists problems observed within the specified timeframe
|
|
|
4909
4963
|
|
|
4910
4964
|
#### Parameters
|
|
4911
4965
|
|
|
4912
|
-
| Name | Type | Description
|
|
4913
|
-
| ---------------------- | ----------------------------------------------------------------------------- |
|
|
4914
|
-
| 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
|
|
4915
|
-
| 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>
|
|
4916
|
-
| 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>
|
|
4917
|
-
| 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>
|
|
4918
|
-
| 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>
|
|
4919
|
-
| 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
|
|
4920
|
-
| 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>
|
|
4921
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
4966
|
+
| Name | Type | Description |
|
|
4967
|
+
| ---------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4968
|
+
| config.entitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("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> |
|
|
4969
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>evidenceDetails</code>: The details of the root cause.</li> <li><code>impactAnalysis</code>: The impact analysis of the problem on other entities/users.</li> <li><code>recentComments</code>: A list of the most recent comments to the problem.</li> </ul> <p>To add properties, specify them as a comma-separated list (for example, <code>evidenceDetails,impactAnalysis</code>).</p> <p>The field is valid only for the current page of results. You must set it for each page you're requesting.</p> |
|
|
4970
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
4971
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters except the optional <strong>fields</strong> parameter.</p> |
|
|
4972
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 50 is used.</p> |
|
|
4973
|
+
| config.problemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only problems matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies. All values must be quoted.</p> <ul> <li>Status: <code>status("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> |
|
|
4974
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies a set of comma-separated (<code>,</code>) fields for sorting in the problem list.</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: problem status (<code>+</code> open problems first or <code>-</code> closed problems first)</li> <li><code>startTime</code>: problem start time (<code>+</code> old problems first or <code>-</code> new problems first)</li> <li><code>relevance</code>: problem relevance (<code>+</code> least relevant problems first or <code>-</code> most relevant problems first) - can be used only in combination with text search</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> <p>You can specify several levels of sorting. For example, <code>+status,-startTime</code> sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.</p> |
|
|
4975
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
4922
4976
|
|
|
4923
4977
|
#### Returns
|
|
4924
4978
|
|
|
@@ -4962,7 +5016,7 @@ Updates the specified comment on a problem
|
|
|
4962
5016
|
| config.commentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required comment. |
|
|
4963
5017
|
| config.problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required problem. |
|
|
4964
5018
|
|
|
4965
|
-
|
|
5019
|
+
{/* no returns */}
|
|
4966
5020
|
|
|
4967
5021
|
<details>
|
|
4968
5022
|
<summary>
|
|
@@ -5006,15 +5060,15 @@ Returns all releases
|
|
|
5006
5060
|
|
|
5007
5061
|
#### Parameters
|
|
5008
5062
|
|
|
5009
|
-
| Name | Type | Description
|
|
5010
|
-
| ----------------------- | ------------------------------------------------------------------------------- |
|
|
5011
|
-
| 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>
|
|
5012
|
-
| 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>
|
|
5013
|
-
| 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>
|
|
5014
|
-
| 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>
|
|
5015
|
-
| 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
|
|
5016
|
-
| 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>
|
|
5017
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
5063
|
+
| Name | Type | Description |
|
|
5064
|
+
| ----------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5065
|
+
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>). <i>default:</i> <code>false</code> |
|
|
5066
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
5067
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
5068
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
|
|
5069
|
+
| config.releasesSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName("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> |
|
|
5070
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p> <i>default:</i> <code>"name"</code> |
|
|
5071
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5018
5072
|
|
|
5019
5073
|
#### Returns
|
|
5020
5074
|
|
|
@@ -5327,10 +5381,10 @@ Lists remediation items of a third-party security problem
|
|
|
5327
5381
|
|
|
5328
5382
|
#### Parameters
|
|
5329
5383
|
|
|
5330
|
-
| Name | Type | Description
|
|
5331
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5332
|
-
| 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.
|
|
5333
|
-
| 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
|
|
5384
|
+
| Name | Type | Description |
|
|
5385
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5386
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5387
|
+
| config.remediationItemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediable entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Vulnerability state: <code>vulnerabilityState("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> |
|
|
5334
5388
|
|
|
5335
5389
|
#### Returns
|
|
5336
5390
|
|
|
@@ -5373,11 +5427,11 @@ Lists remediation progress entities
|
|
|
5373
5427
|
|
|
5374
5428
|
#### Parameters
|
|
5375
5429
|
|
|
5376
|
-
| Name | Type | Description
|
|
5377
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5378
|
-
| 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.
|
|
5379
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5380
|
-
| 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
|
|
5430
|
+
| Name | Type | Description |
|
|
5431
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5432
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5433
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5434
|
+
| config.remediationProgressEntitySelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only remediation progress entities matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>State: <code>state("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> |
|
|
5381
5435
|
|
|
5382
5436
|
#### Returns
|
|
5383
5437
|
|
|
@@ -5468,15 +5522,15 @@ Lists all security problems
|
|
|
5468
5522
|
|
|
5469
5523
|
#### Parameters
|
|
5470
5524
|
|
|
5471
|
-
| Name | Type | Description
|
|
5472
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5473
|
-
| 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>
|
|
5474
|
-
| 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>
|
|
5475
|
-
| 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>
|
|
5476
|
-
| 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>
|
|
5477
|
-
| 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
|
|
5478
|
-
| 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>
|
|
5479
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> <p>The end of the timeframe must not be older than 365 days.</p>
|
|
5525
|
+
| Name | Type | Description |
|
|
5526
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5527
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
|
|
5528
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of thirty days is used (<code>now-30d</code>).</p> |
|
|
5529
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
5530
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of security problems in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
5531
|
+
| config.securityProblemSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only security problems matching the specified criteria are included in the response.</p> <p>You can add one or more of the following criteria. Values are <em>not</em> case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Status: <code>status("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> |
|
|
5532
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Specifies one or more fields for sorting the security problem list. Multiple fields can be concatenated using a comma (<code>,</code>) as a separator (e.g. <code>+status,-timestamp</code>).</p> <p>You can sort by the following properties with a sign prefix for the sorting order.</p> <ul> <li><code>status</code>: The security problem status (<code>+</code> open first or <code>-</code> resolved first)</li> <li><code>muted</code>: The security problem mute state (<code>+</code> unmuted first or <code>-</code> muted first)</li> <li><code>technology</code>: The security problem technology</li> <li><code>firstSeenTimestamp</code>: The timestamp of the first occurrence of the security problem (<code>+</code> new problems first or <code>-</code> old problems first)</li> <li><code>lastUpdatedTimestamp</code>: The timestamp of the last update of the security problem (<code>+</code> recently updated problems first or <code>-</code> earlier updated problems first)</li> <li><code>securityProblemId</code>: The auto-generated ID of the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>externalVulnerabilityId</code>: The ID of the external vulnerability (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>displayId</code>: The display ID (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>riskAssessment.riskScore</code>: Davis Security Score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.riskLevel</code>: Davis Security Score level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.exposure</code>: Whether the problem is exposed to the internet</li> <li><code>riskAssessment.baseRiskScore</code>: The CVSS score (<code>+</code> lower score first or <code>-</code> higher score first)</li> <li><code>riskAssessment.baseRiskLevel</code>: The CVSS level (<code>+</code> lower level first or <code>-</code> higher level first)</li> <li><code>riskAssessment.dataAssets</code>: Whether data assets are affected</li> <li><code>riskAssessment.vulnerableFunctionUsage</code>: Whether vulnerable functions are used</li> <li><code>riskAssessment.assessmentAccuracy</code>: The assessments accuracy (<code>+</code> less accuracy first or <code>-</code> more accuracy first)</li> <li><code>globalCounts.affectedNodes</code>: Number of affected nodes (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroupInstances</code>: Number of affected process group instances (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.affectedProcessGroups</code>: Number of affected process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.exposedProcessGroups</code>: Number of exposed process groups (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.reachableDataAssets</code>: Number of reachable data assets (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedApplications</code>: Number of related applications (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedAttacks</code>: Number of attacks on the security problem (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedHosts</code>: Number of related hosts (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesClusters</code>: Number of related Kubernetes cluster (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedKubernetesWorkloads</code>: Number of related Kubernetes workloads (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.relatedServices</code>: Number of related services (<code>+</code> lower number first or <code>-</code> higher number first)</li> <li><code>globalCounts.vulnerableComponents</code>: Number of vulnerable components (<code>+</code> lower number first or <code>-</code> higher number first)</li> </ul> <p>If no prefix is set, <code>+</code> is used.</p> |
|
|
5533
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> <p>The end of the timeframe must not be older than 365 days.</p> |
|
|
5480
5534
|
|
|
5481
5535
|
#### Returns
|
|
5482
5536
|
|
|
@@ -5517,11 +5571,11 @@ Lists all vulnerable functions and their usage for a third-party security proble
|
|
|
5517
5571
|
|
|
5518
5572
|
#### Parameters
|
|
5519
5573
|
|
|
5520
|
-
| Name | Type | Description
|
|
5521
|
-
| ---------------------------------- | ----------------------------------------------------------------------------- |
|
|
5522
|
-
| 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>
|
|
5523
|
-
| 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.
|
|
5524
|
-
| 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
|
|
5574
|
+
| Name | Type | Description |
|
|
5575
|
+
| ---------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5576
|
+
| config.groupBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines additional grouping types in which vulnerable functions should be displayed.</p> <p>You can add one of the following grouping types.</p> <ul> <li>Process group: <code>PROCESS_GROUP</code></li> </ul> |
|
|
5577
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5578
|
+
| config.vulnerableFunctionsSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Defines the scope of the query. Only vulnerable functions matching the specified criteria are included in the response.</p> <p>You can add the following criteria. Values are <em>not</em> case sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Management zone ID: <code>managementZoneIds("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> |
|
|
5525
5579
|
|
|
5526
5580
|
#### Returns
|
|
5527
5581
|
|
|
@@ -5566,7 +5620,7 @@ Mutes a security problem
|
|
|
5566
5620
|
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> | |
|
|
5567
5621
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5568
5622
|
|
|
5569
|
-
|
|
5623
|
+
{/* no returns */}
|
|
5570
5624
|
|
|
5571
5625
|
<details>
|
|
5572
5626
|
<summary>
|
|
@@ -5609,7 +5663,7 @@ Sets the mute state of a remediation item
|
|
|
5609
5663
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5610
5664
|
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5611
5665
|
|
|
5612
|
-
|
|
5666
|
+
{/* no returns */}
|
|
5613
5667
|
|
|
5614
5668
|
<details>
|
|
5615
5669
|
<summary>
|
|
@@ -5652,7 +5706,7 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
|
|
|
5652
5706
|
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a> | |
|
|
5653
5707
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested third-party security problem. |
|
|
5654
5708
|
|
|
5655
|
-
|
|
5709
|
+
{/* no returns */}
|
|
5656
5710
|
|
|
5657
5711
|
<details>
|
|
5658
5712
|
<summary>
|
|
@@ -5694,7 +5748,7 @@ Un-mutes a security problem
|
|
|
5694
5748
|
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> | |
|
|
5695
5749
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the requested security problem. |
|
|
5696
5750
|
|
|
5697
|
-
|
|
5751
|
+
{/* no returns */}
|
|
5698
5752
|
|
|
5699
5753
|
<details>
|
|
5700
5754
|
<summary>
|
|
@@ -5794,7 +5848,7 @@ Creates a new SLO
|
|
|
5794
5848
|
| -------------------------------- | -------------------------------------------------------- |
|
|
5795
5849
|
| config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> |
|
|
5796
5850
|
|
|
5797
|
-
|
|
5851
|
+
{/* no returns */}
|
|
5798
5852
|
|
|
5799
5853
|
<details>
|
|
5800
5854
|
<summary>
|
|
@@ -5842,7 +5896,7 @@ Deletes an SLO
|
|
|
5842
5896
|
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5843
5897
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> |
|
|
5844
5898
|
|
|
5845
|
-
|
|
5899
|
+
{/* no returns */}
|
|
5846
5900
|
|
|
5847
5901
|
<details>
|
|
5848
5902
|
<summary>
|
|
@@ -5886,19 +5940,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
|
|
|
5886
5940
|
|
|
5887
5941
|
#### Parameters
|
|
5888
5942
|
|
|
5889
|
-
| Name | Type | Description
|
|
5890
|
-
| --------------------- | ------------------------------------------------------------------------------- |
|
|
5891
|
-
| 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>
|
|
5892
|
-
| 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>
|
|
5893
|
-
| 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>
|
|
5894
|
-
| 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>
|
|
5895
|
-
| 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>
|
|
5896
|
-
| 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>
|
|
5897
|
-
| 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>
|
|
5898
|
-
| 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
|
|
5899
|
-
| 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>
|
|
5900
|
-
| 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>
|
|
5901
|
-
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>
|
|
5943
|
+
| Name | Type | Description |
|
|
5944
|
+
| --------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5945
|
+
| config.demo | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). <i>default:</i> <code>false</code> |
|
|
5946
|
+
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). <i>default:</i> <code>"true"</code> |
|
|
5947
|
+
| config.evaluate | GetSloQueryEvaluate | Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. <i>default:</i> <code>"false"</code> |
|
|
5948
|
+
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p> |
|
|
5949
|
+
| config.nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. You can find it in the <strong>nextPageKey</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>nextPageKey</strong> query parameter.</p> <p>When the <strong>nextPageKey</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p> |
|
|
5950
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
|
|
5951
|
+
| config.showGlobalSlos | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). <i>default:</i> <code>true</code> |
|
|
5952
|
+
| config.sloSelector | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("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> |
|
|
5953
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> <i>default:</i> <code>"name"</code> |
|
|
5954
|
+
| config.timeFrame | GetSloQueryTimeFrame | <p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> <i>default:</i> <code>"CURRENT"</code> |
|
|
5955
|
+
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5902
5956
|
|
|
5903
5957
|
#### Returns
|
|
5904
5958
|
|
|
@@ -5994,7 +6048,7 @@ Updates an existing SLO
|
|
|
5994
6048
|
| config.body<sup>\*required</sup> | <a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a> | |
|
|
5995
6049
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
|
|
5996
6050
|
|
|
5997
|
-
|
|
6051
|
+
{/* no returns */}
|
|
5998
6052
|
|
|
5999
6053
|
<details>
|
|
6000
6054
|
<summary>
|
|
@@ -6050,7 +6104,7 @@ Deletes the specified settings object
|
|
|
6050
6104
|
| config.objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required settings object. |
|
|
6051
6105
|
| config.updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
6052
6106
|
|
|
6053
|
-
|
|
6107
|
+
{/* no returns */}
|
|
6054
6108
|
|
|
6055
6109
|
<details>
|
|
6056
6110
|
<summary>
|
|
@@ -6351,7 +6405,7 @@ Lists available settings schemas
|
|
|
6351
6405
|
|
|
6352
6406
|
</div>
|
|
6353
6407
|
|
|
6354
|
-
|
|
6408
|
+
{/* no parameters */}
|
|
6355
6409
|
|
|
6356
6410
|
#### Returns
|
|
6357
6411
|
|
|
@@ -6532,7 +6586,7 @@ Gets set of synthetic related parameters defined for whole tenant (affects all m
|
|
|
6532
6586
|
|
|
6533
6587
|
</div>
|
|
6534
6588
|
|
|
6535
|
-
|
|
6589
|
+
{/* no parameters */}
|
|
6536
6590
|
|
|
6537
6591
|
#### Returns
|
|
6538
6592
|
|
|
@@ -6787,7 +6841,7 @@ Checks the status of public synthetic locations
|
|
|
6787
6841
|
|
|
6788
6842
|
</div>
|
|
6789
6843
|
|
|
6790
|
-
|
|
6844
|
+
{/* no parameters */}
|
|
6791
6845
|
|
|
6792
6846
|
#### Returns
|
|
6793
6847
|
|
|
@@ -6866,7 +6920,7 @@ Lists all synthetic nodes available in your environment
|
|
|
6866
6920
|
|
|
6867
6921
|
</div>
|
|
6868
6922
|
|
|
6869
|
-
|
|
6923
|
+
{/* no parameters */}
|
|
6870
6924
|
|
|
6871
6925
|
#### Returns
|
|
6872
6926
|
|
|
@@ -6908,7 +6962,7 @@ Deletes the specified private synthetic location
|
|
|
6908
6962
|
| -------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
6909
6963
|
| config.locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the private synthetic location to be deleted. |
|
|
6910
6964
|
|
|
6911
|
-
|
|
6965
|
+
{/* no returns */}
|
|
6912
6966
|
|
|
6913
6967
|
<details>
|
|
6914
6968
|
<summary>
|
|
@@ -6994,7 +7048,7 @@ For public locations you can only change the location status.
|
|
|
6994
7048
|
| config.body<sup>\*required</sup> | <a href="#syntheticlocationupdate">SyntheticLocationUpdate</a> | |
|
|
6995
7049
|
| config.locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the synthetic location to be updated. |
|
|
6996
7050
|
|
|
6997
|
-
|
|
7051
|
+
{/* no returns */}
|
|
6998
7052
|
|
|
6999
7053
|
<details>
|
|
7000
7054
|
<summary>
|
|
@@ -7034,7 +7088,7 @@ Changes the status of public synthetic locations
|
|
|
7034
7088
|
| -------------------------------- | ---------------------------------------------------------------------------- |
|
|
7035
7089
|
| config.body<sup>\*required</sup> | <a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a> |
|
|
7036
7090
|
|
|
7037
|
-
|
|
7091
|
+
{/* no returns */}
|
|
7038
7092
|
|
|
7039
7093
|
<details>
|
|
7040
7094
|
<summary>
|
|
@@ -7055,20 +7109,20 @@ const data =
|
|
|
7055
7109
|
|
|
7056
7110
|
</div>
|
|
7057
7111
|
|
|
7058
|
-
##
|
|
7112
|
+
## syntheticNetworkAvailabilityMonitorsClient
|
|
7059
7113
|
|
|
7060
7114
|
```js
|
|
7061
|
-
import {
|
|
7115
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7062
7116
|
```
|
|
7063
7117
|
|
|
7064
7118
|
### createMonitor
|
|
7065
7119
|
|
|
7066
7120
|
<div class="padding-bottom--md">
|
|
7067
|
-
<strong>
|
|
7121
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto">MonitorEntityIdDto</a>></strong>
|
|
7068
7122
|
|
|
7069
7123
|
<div class="padding-left--md">
|
|
7070
7124
|
|
|
7071
|
-
Creates a synthetic monitor definition. Currently
|
|
7125
|
+
Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
7072
7126
|
|
|
7073
7127
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
7074
7128
|
**Required permission:** environment:roles:viewer
|
|
@@ -7092,9 +7146,9 @@ Code example
|
|
|
7092
7146
|
</summary>
|
|
7093
7147
|
|
|
7094
7148
|
```ts
|
|
7095
|
-
import {
|
|
7149
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7096
7150
|
|
|
7097
|
-
const data = await
|
|
7151
|
+
const data = await syntheticNetworkAvailabilityMonitorsClient.createMonitor({});
|
|
7098
7152
|
```
|
|
7099
7153
|
|
|
7100
7154
|
</details>
|
|
@@ -7104,11 +7158,11 @@ const data = await syntheticMultiProtocolMonitorsClient.createMonitor({});
|
|
|
7104
7158
|
### deleteMonitor
|
|
7105
7159
|
|
|
7106
7160
|
<div class="padding-bottom--md">
|
|
7107
|
-
<strong>
|
|
7161
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.deleteMonitor(config): Promise<void></strong>
|
|
7108
7162
|
|
|
7109
7163
|
<div class="padding-left--md">
|
|
7110
7164
|
|
|
7111
|
-
Deletes a synthetic monitor definition for the given monitor ID. Currently
|
|
7165
|
+
Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
7112
7166
|
|
|
7113
7167
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
7114
7168
|
**Required permission:** environment:roles:viewer
|
|
@@ -7121,7 +7175,7 @@ Deletes a synthetic monitor definition for the given monitor ID. Currently multi
|
|
|
7121
7175
|
| ------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------ |
|
|
7122
7176
|
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7123
7177
|
|
|
7124
|
-
|
|
7178
|
+
{/* no returns */}
|
|
7125
7179
|
|
|
7126
7180
|
<details>
|
|
7127
7181
|
<summary>
|
|
@@ -7130,9 +7184,9 @@ Code example
|
|
|
7130
7184
|
</summary>
|
|
7131
7185
|
|
|
7132
7186
|
```ts
|
|
7133
|
-
import {
|
|
7187
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7134
7188
|
|
|
7135
|
-
const data = await
|
|
7189
|
+
const data = await syntheticNetworkAvailabilityMonitorsClient.deleteMonitor({
|
|
7136
7190
|
monitorId: "...",
|
|
7137
7191
|
});
|
|
7138
7192
|
```
|
|
@@ -7144,11 +7198,11 @@ const data = await syntheticMultiProtocolMonitorsClient.deleteMonitor({
|
|
|
7144
7198
|
### getMonitor
|
|
7145
7199
|
|
|
7146
7200
|
<div class="padding-bottom--md">
|
|
7147
|
-
<strong>
|
|
7201
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticmultiprotocolmonitordto">SyntheticMultiProtocolMonitorDto</a>></strong>
|
|
7148
7202
|
|
|
7149
7203
|
<div class="padding-left--md">
|
|
7150
7204
|
|
|
7151
|
-
Gets a synthetic monitor definition for the given monitor ID. Currently
|
|
7205
|
+
Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
7152
7206
|
|
|
7153
7207
|
**Required scope:** environment-api:synthetic-monitors:read
|
|
7154
7208
|
**Required permission:** environment:roles:viewer
|
|
@@ -7172,9 +7226,9 @@ Code example
|
|
|
7172
7226
|
</summary>
|
|
7173
7227
|
|
|
7174
7228
|
```ts
|
|
7175
|
-
import {
|
|
7229
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7176
7230
|
|
|
7177
|
-
const data = await
|
|
7231
|
+
const data = await syntheticNetworkAvailabilityMonitorsClient.getMonitor({
|
|
7178
7232
|
monitorId: "...",
|
|
7179
7233
|
});
|
|
7180
7234
|
```
|
|
@@ -7186,11 +7240,11 @@ const data = await syntheticMultiProtocolMonitorsClient.getMonitor({
|
|
|
7186
7240
|
### getMonitors
|
|
7187
7241
|
|
|
7188
7242
|
<div class="padding-bottom--md">
|
|
7189
|
-
<strong>
|
|
7243
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto">SyntheticMonitorListDto</a>></strong>
|
|
7190
7244
|
|
|
7191
7245
|
<div class="padding-left--md">
|
|
7192
7246
|
|
|
7193
|
-
Gets all synthetic monitors. Currently
|
|
7247
|
+
Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
7194
7248
|
|
|
7195
7249
|
**Required scope:** environment-api:synthetic-monitors:read
|
|
7196
7250
|
**Required permission:** environment:roles:viewer
|
|
@@ -7214,9 +7268,9 @@ Code example
|
|
|
7214
7268
|
</summary>
|
|
7215
7269
|
|
|
7216
7270
|
```ts
|
|
7217
|
-
import {
|
|
7271
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7218
7272
|
|
|
7219
|
-
const data = await
|
|
7273
|
+
const data = await syntheticNetworkAvailabilityMonitorsClient.getMonitors();
|
|
7220
7274
|
```
|
|
7221
7275
|
|
|
7222
7276
|
</details>
|
|
@@ -7226,11 +7280,11 @@ const data = await syntheticMultiProtocolMonitorsClient.getMonitors();
|
|
|
7226
7280
|
### updateMonitor
|
|
7227
7281
|
|
|
7228
7282
|
<div class="padding-bottom--md">
|
|
7229
|
-
<strong>
|
|
7283
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.updateMonitor(config): Promise<void></strong>
|
|
7230
7284
|
|
|
7231
7285
|
<div class="padding-left--md">
|
|
7232
7286
|
|
|
7233
|
-
Updates a synthetic monitor definition for the given monitor ID. Currently
|
|
7287
|
+
Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
|
|
7234
7288
|
|
|
7235
7289
|
**Required scope:** environment-api:synthetic-monitors:write
|
|
7236
7290
|
**Required permission:** environment:roles:viewer
|
|
@@ -7244,7 +7298,7 @@ Updates a synthetic monitor definition for the given monitor ID. Currently multi
|
|
|
7244
7298
|
| config.body<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a> | |
|
|
7245
7299
|
| config.monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
7246
7300
|
|
|
7247
|
-
|
|
7301
|
+
{/* no returns */}
|
|
7248
7302
|
|
|
7249
7303
|
<details>
|
|
7250
7304
|
<summary>
|
|
@@ -7253,9 +7307,9 @@ Code example
|
|
|
7253
7307
|
</summary>
|
|
7254
7308
|
|
|
7255
7309
|
```ts
|
|
7256
|
-
import {
|
|
7310
|
+
import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7257
7311
|
|
|
7258
|
-
const data = await
|
|
7312
|
+
const data = await syntheticNetworkAvailabilityMonitorsClient.updateMonitor({
|
|
7259
7313
|
monitorId: "...",
|
|
7260
7314
|
});
|
|
7261
7315
|
```
|
|
@@ -7728,31 +7782,31 @@ Short representation of the alerting profile.
|
|
|
7728
7782
|
|
|
7729
7783
|
Metadata of an API token.
|
|
7730
7784
|
|
|
7731
|
-
| Name | Type
|
|
7732
|
-
| ------------------- |
|
|
7733
|
-
| additionalMetadata |
|
|
7734
|
-
| creationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7735
|
-
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7736
|
-
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7737
|
-
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7738
|
-
| lastUsedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7739
|
-
| lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7740
|
-
| modifiedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7741
|
-
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7742
|
-
| owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7743
|
-
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7744
|
-
| scopes | Array<ApiTokenScopesItem>
|
|
7785
|
+
| Name | Type | Description |
|
|
7786
|
+
| ------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7787
|
+
| additionalMetadata | ApiTokenAdditionalMetadata | |
|
|
7788
|
+
| creationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token creation date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
|
|
7789
|
+
| enabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
7790
|
+
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Token expiration date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).</p> <p>If not set, the token never expires.</p> |
|
|
7791
|
+
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the token, consisting of prefix and public part of the token. |
|
|
7792
|
+
| lastUsedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
|
|
7793
|
+
| lastUsedIpAddress | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last used IP address. |
|
|
7794
|
+
| modifiedDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token last modified date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>). Updating scopes or name counts as modification, enabling or disabling a token does not. |
|
|
7795
|
+
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7796
|
+
| owner | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the token. |
|
|
7797
|
+
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The token is a <a href="https://dt-url.net/wm03sop">personal access token</a> (<code>true</code>) or an API token (<code>false</code>). |
|
|
7798
|
+
| scopes | Array<ApiTokenScopesItem> | A list of scopes assigned to the token. |
|
|
7745
7799
|
|
|
7746
7800
|
### ApiTokenCreate
|
|
7747
7801
|
|
|
7748
7802
|
Parameters of a new API token.
|
|
7749
7803
|
|
|
7750
|
-
| Name | Type | Description
|
|
7751
|
-
| --------------------------- | ------------------------------------------------------------------------------- |
|
|
7752
|
-
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The expiration date of the token.</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 token never expires.</p>
|
|
7753
|
-
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token.
|
|
7754
|
-
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p>
|
|
7755
|
-
| scopes<sup>\*required</sup> | Array<ApiTokenCreateScopesItem> | <p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7804
|
+
| Name | Type | Description |
|
|
7805
|
+
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7806
|
+
| expirationDate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The expiration date of the token.</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 token never expires. Ensure that the expiration date is not set in the past.</p> |
|
|
7807
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7808
|
+
| personalAccessToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p> |
|
|
7809
|
+
| scopes<sup>\*required</sup> | Array<ApiTokenCreateScopesItem> | <p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7756
7810
|
|
|
7757
7811
|
### ApiTokenCreated
|
|
7758
7812
|
|
|
@@ -7785,11 +7839,11 @@ A list of API tokens.
|
|
|
7785
7839
|
|
|
7786
7840
|
The update of the API token.
|
|
7787
7841
|
|
|
7788
|
-
| Name | Type | Description
|
|
7789
|
-
| ------- | ------------------------------------------------------------------------------- |
|
|
7790
|
-
| 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>)
|
|
7791
|
-
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token.
|
|
7792
|
-
| scopes | Array<ApiTokenUpdateScopesItem> | <p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7842
|
+
| Name | Type | Description |
|
|
7843
|
+
| ------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7844
|
+
| 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>) |
|
|
7845
|
+
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the token. |
|
|
7846
|
+
| scopes | Array<ApiTokenUpdateScopesItem> | <p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> </ul> |
|
|
7793
7847
|
|
|
7794
7848
|
### ApplicationImpact
|
|
7795
7849
|
|
|
@@ -7855,20 +7909,20 @@ The audit log of your environment.
|
|
|
7855
7909
|
|
|
7856
7910
|
An entry of the audit log.
|
|
7857
7911
|
|
|
7858
|
-
| Name | Type
|
|
7859
|
-
| ---------------------------------- |
|
|
7860
|
-
| category<sup>\*required</sup> | AuditLogEntryCategory
|
|
7861
|
-
| entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7862
|
-
| environmentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7863
|
-
| eventType<sup>\*required</sup> | AuditLogEntryEventType
|
|
7864
|
-
| logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7865
|
-
| message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7866
|
-
| patch |
|
|
7867
|
-
| success<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
7868
|
-
| timestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
7869
|
-
| user<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7870
|
-
| userOrigin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
7871
|
-
| userType<sup>\*required</sup> | AuditLogEntryUserType
|
|
7912
|
+
| Name | Type | Description |
|
|
7913
|
+
| ---------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
7914
|
+
| category<sup>\*required</sup> | AuditLogEntryCategory | |
|
|
7915
|
+
| entityId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of an entity from the <strong>category</strong>.</p> <p>For example, it can be config ID for the <code>CONFIG</code> category or token ID for the <code>TOKEN</code> category.</p> |
|
|
7916
|
+
| environmentId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the Dynatrace environment where the recorded operation occurred. |
|
|
7917
|
+
| eventType<sup>\*required</sup> | AuditLogEntryEventType | |
|
|
7918
|
+
| logId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the log entry. |
|
|
7919
|
+
| message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The logged message. |
|
|
7920
|
+
| patch | AuditLogEntryPatch | |
|
|
7921
|
+
| success<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The recorded operation is successful (<code>true</code>) or failed (<code>false</code>). |
|
|
7922
|
+
| timestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the record creation, in UTC milliseconds. |
|
|
7923
|
+
| user<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the user who performed the recorded operation. |
|
|
7924
|
+
| userOrigin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin and the IP address of the <strong>user</strong>. |
|
|
7925
|
+
| userType<sup>\*required</sup> | AuditLogEntryUserType | |
|
|
7872
7926
|
|
|
7873
7927
|
### AuthorDto
|
|
7874
7928
|
|
|
@@ -8009,6 +8063,7 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
8009
8063
|
|
|
8010
8064
|
| Name | Type | Description |
|
|
8011
8065
|
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
8066
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
8012
8067
|
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
8013
8068
|
| certificate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The certificate in the string format. |
|
|
8014
8069
|
| certificateFormat | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The certificate format. |
|
|
@@ -8025,20 +8080,20 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
8025
8080
|
|
|
8026
8081
|
CloudEvents is a [specification](https://github.com/cloudevents/spec/blob/v1.0/spec.json) for describing event data in common formats to provide interoperability across services, platforms and systems.
|
|
8027
8082
|
|
|
8028
|
-
| Name | Type
|
|
8029
|
-
| -------------------------------- |
|
|
8030
|
-
| data | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a
|
|
8031
|
-
| data_base64 | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8032
|
-
| datacontenttype | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8033
|
-
| dataschema | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8034
|
-
| dtcontext | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8035
|
-
| id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8036
|
-
| source<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8037
|
-
| specversion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8038
|
-
| subject | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8039
|
-
| time | Date
|
|
8040
|
-
| traceparent | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8041
|
-
| type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8083
|
+
| Name | Type | Description |
|
|
8084
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8085
|
+
| data | Record<<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>> | |
|
|
8086
|
+
| data_base64 | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8087
|
+
| datacontenttype | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8088
|
+
| dataschema | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8089
|
+
| dtcontext | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Dynatrace context |
|
|
8090
|
+
| id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8091
|
+
| source<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8092
|
+
| specversion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8093
|
+
| subject | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8094
|
+
| time | Date | |
|
|
8095
|
+
| traceparent | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Trace related to this event. See <a href="https://github.com/cloudevents/spec/blob/main/cloudevents/extensions/distributed-tracing.md">distributed tracing</a> for further information. |
|
|
8096
|
+
| type<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
8042
8097
|
|
|
8043
8098
|
### CodeLevelVulnerabilityDetails
|
|
8044
8099
|
|
|
@@ -8161,6 +8216,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
8161
8216
|
|
|
8162
8217
|
| Name | Type | Description |
|
|
8163
8218
|
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
8219
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
8164
8220
|
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
8165
8221
|
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
8166
8222
|
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the credentials set. |
|
|
@@ -8247,19 +8303,20 @@ A list of credentials sets for Synthetic monitors.
|
|
|
8247
8303
|
|
|
8248
8304
|
Metadata of the credentials set.
|
|
8249
8305
|
|
|
8250
|
-
| Name | Type | Description
|
|
8251
|
-
| ------------------------------------------- | ------------------------------------------------------------------------------- |
|
|
8252
|
-
|
|
|
8253
|
-
|
|
|
8254
|
-
|
|
|
8255
|
-
|
|
|
8256
|
-
|
|
|
8257
|
-
|
|
|
8258
|
-
|
|
|
8259
|
-
|
|
|
8260
|
-
|
|
|
8261
|
-
|
|
|
8262
|
-
|
|
|
8306
|
+
| Name | Type | Description |
|
|
8307
|
+
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
8308
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope). |
|
|
8309
|
+
| allowedEntities<sup>\*required</sup> | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
8310
|
+
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
8311
|
+
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
8312
|
+
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
8313
|
+
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the credentials set. |
|
|
8314
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the credentials set. |
|
|
8315
|
+
| owner<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The owner of the credential (user for which used API token was created). |
|
|
8316
|
+
| ownerAccessOnly<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Flag indicating that this credential is visible only to the owner. |
|
|
8317
|
+
| scope | CredentialsResponseElementScope | |
|
|
8318
|
+
| scopes | Array<CredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
8319
|
+
| type<sup>\*required</sup> | CredentialsResponseElementType | |
|
|
8263
8320
|
|
|
8264
8321
|
### CustomApplicationImpact
|
|
8265
8322
|
|
|
@@ -8457,18 +8514,18 @@ A constraint on the values that are going to be deleted.
|
|
|
8457
8514
|
|
|
8458
8515
|
An effective settings value.
|
|
8459
8516
|
|
|
8460
|
-
| Name | Type
|
|
8461
|
-
| ------------- |
|
|
8462
|
-
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8463
|
-
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
8464
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8465
|
-
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
8466
|
-
| origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8467
|
-
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8468
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8469
|
-
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8470
|
-
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8471
|
-
| value |
|
|
8517
|
+
| Name | Type | Description |
|
|
8518
|
+
| ------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
8519
|
+
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
|
|
8520
|
+
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
|
|
8521
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
|
|
8522
|
+
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
|
|
8523
|
+
| origin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The origin of the settings value. |
|
|
8524
|
+
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
|
|
8525
|
+
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
|
|
8526
|
+
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
|
|
8527
|
+
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
|
|
8528
|
+
| value | SettingsValue | |
|
|
8472
8529
|
|
|
8473
8530
|
### EffectiveSettingsValuesList
|
|
8474
8531
|
|
|
@@ -8643,13 +8700,13 @@ Definition of an enum property.
|
|
|
8643
8700
|
|
|
8644
8701
|
An allowed value for an enum property.
|
|
8645
8702
|
|
|
8646
|
-
| Name | Type
|
|
8647
|
-
| -------------------------------- |
|
|
8648
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8649
|
-
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8650
|
-
| enumInstance | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8651
|
-
| icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8652
|
-
| value<sup>\*required</sup> |
|
|
8703
|
+
| Name | Type | Description |
|
|
8704
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
8705
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the value. |
|
|
8706
|
+
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the value. |
|
|
8707
|
+
| enumInstance | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the value in an existing Java enum class. |
|
|
8708
|
+
| icon | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The icon of the value. |
|
|
8709
|
+
| value<sup>\*required</sup> | EnumValueValue | |
|
|
8653
8710
|
|
|
8654
8711
|
### Error
|
|
8655
8712
|
|
|
@@ -8730,6 +8787,8 @@ All other keys are interpreted as user-defined event properties.
|
|
|
8730
8787
|
|
|
8731
8788
|
Values of Dynatrace-reserved properties must fulfill the requirements of the respective property.
|
|
8732
8789
|
|
|
8790
|
+
A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.
|
|
8791
|
+
|
|
8733
8792
|
### EventIngestResult
|
|
8734
8793
|
|
|
8735
8794
|
The result of a created event report.
|
|
@@ -8837,6 +8896,22 @@ The evidence details of a problem.
|
|
|
8837
8896
|
| details<sup>\*required</sup> | Array<<a href="#evidence">Evidence</a>> | A list of all evidence. |
|
|
8838
8897
|
| totalCount<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of evidence of a problem. |
|
|
8839
8898
|
|
|
8899
|
+
### ExecuteActionsDto
|
|
8900
|
+
|
|
8901
|
+
| Name | Type |
|
|
8902
|
+
| ------- | ---------------------------------------------------------------- |
|
|
8903
|
+
| actions | <a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a> |
|
|
8904
|
+
|
|
8905
|
+
### ExecuteActionsDtoActions
|
|
8906
|
+
|
|
8907
|
+
Data Source defined action objects
|
|
8908
|
+
|
|
8909
|
+
### ExecuteActionsResponse
|
|
8910
|
+
|
|
8911
|
+
| Name | Type | Description |
|
|
8912
|
+
| ---- | ----------------------------------------------------------------------------- | -------------------- |
|
|
8913
|
+
| code | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP Status code |
|
|
8914
|
+
|
|
8840
8915
|
### ExecutionFullResults
|
|
8841
8916
|
|
|
8842
8917
|
Contains extended monitor's execution details.
|
|
@@ -8983,11 +9058,11 @@ A list of extensions with additional metadata.
|
|
|
8983
9058
|
|
|
8984
9059
|
### ExtensionMonitoringConfiguration
|
|
8985
9060
|
|
|
8986
|
-
| Name | Type
|
|
8987
|
-
| ----------------------------- |
|
|
8988
|
-
| objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8989
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
8990
|
-
| value<sup>\*required</sup> |
|
|
9061
|
+
| Name | Type | Description |
|
|
9062
|
+
| ----------------------------- | ----------------------------------------------------------------------------- | ------------------- |
|
|
9063
|
+
| objectId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration id |
|
|
9064
|
+
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Configuration scope |
|
|
9065
|
+
| value<sup>\*required</sup> | ExtensionMonitoringConfigurationValue | |
|
|
8991
9066
|
|
|
8992
9067
|
### ExtensionMonitoringConfigurationsList
|
|
8993
9068
|
|
|
@@ -9313,11 +9388,11 @@ Additional columns of the log record.
|
|
|
9313
9388
|
|
|
9314
9389
|
A list of retrieved log records.
|
|
9315
9390
|
|
|
9316
|
-
| Name | Type | Description
|
|
9317
|
-
| ------------ | ----------------------------------------------------------------------------- |
|
|
9318
|
-
| nextSliceKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The cursor for the next slice of log records. |
|
|
9319
|
-
| results | Array<<a href="#logrecord">LogRecord</a>> | A list of retrieved log records.
|
|
9320
|
-
| sliceSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of records in a slice.
|
|
9391
|
+
| Name | Type | Description |
|
|
9392
|
+
| ------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
9393
|
+
| nextSliceKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The cursor for the next slice of log records. Always null on <em>Log Management and Analytics, powered by Grail</em>. |
|
|
9394
|
+
| results | Array<<a href="#logrecord">LogRecord</a>> | A list of retrieved log records. |
|
|
9395
|
+
| sliceSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of records in a slice. |
|
|
9321
9396
|
|
|
9322
9397
|
### METag
|
|
9323
9398
|
|
|
@@ -9656,10 +9731,10 @@ A list of entities and their monitoring states.
|
|
|
9656
9731
|
|
|
9657
9732
|
### MonitoringConfigurationDto
|
|
9658
9733
|
|
|
9659
|
-
| Name | Type
|
|
9660
|
-
| -------------------------- |
|
|
9661
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9662
|
-
| value |
|
|
9734
|
+
| Name | Type | Description |
|
|
9735
|
+
| -------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------- |
|
|
9736
|
+
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope this monitoring configuration will be defined for |
|
|
9737
|
+
| value | JsonNode | |
|
|
9663
9738
|
|
|
9664
9739
|
### MonitoringConfigurationResponse
|
|
9665
9740
|
|
|
@@ -9670,9 +9745,9 @@ A list of entities and their monitoring states.
|
|
|
9670
9745
|
|
|
9671
9746
|
### MonitoringConfigurationUpdateDto
|
|
9672
9747
|
|
|
9673
|
-
| Name | Type
|
|
9674
|
-
| ----- |
|
|
9675
|
-
| value |
|
|
9748
|
+
| Name | Type |
|
|
9749
|
+
| ----- | -------- |
|
|
9750
|
+
| value | JsonNode |
|
|
9676
9751
|
|
|
9677
9752
|
### MuteState
|
|
9678
9753
|
|
|
@@ -9793,15 +9868,15 @@ A list of settings objects.
|
|
|
9793
9868
|
|
|
9794
9869
|
A precondition for visibility of a property.
|
|
9795
9870
|
|
|
9796
|
-
| Name | Type
|
|
9797
|
-
| ------------------------- |
|
|
9798
|
-
| expectedValue |
|
|
9799
|
-
| 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> |
|
|
9800
|
-
| pattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9801
|
-
| precondition | <a href="#precondition">Precondition</a>
|
|
9802
|
-
| preconditions | Array<<a href="#precondition">Precondition</a>>
|
|
9803
|
-
| property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9804
|
-
| type<sup>\*required</sup> | PreconditionType
|
|
9871
|
+
| Name | Type | Description |
|
|
9872
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9873
|
+
| expectedValue | PreconditionExpectedValue | |
|
|
9874
|
+
| 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> |
|
|
9875
|
+
| pattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The Regular expression which is matched against the property.</p> <p>Only applicable to properties of the <code>REGEX_MATCH</code> type.</p> |
|
|
9876
|
+
| precondition | <a href="#precondition">Precondition</a> | |
|
|
9877
|
+
| preconditions | Array<<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> |
|
|
9878
|
+
| property | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The property to be evaluated. |
|
|
9879
|
+
| type<sup>\*required</sup> | PreconditionType | |
|
|
9805
9880
|
|
|
9806
9881
|
### PrivateSyntheticLocation
|
|
9807
9882
|
|
|
@@ -9809,26 +9884,26 @@ Configuration of a private synthetic location.
|
|
|
9809
9884
|
|
|
9810
9885
|
Some fields are inherited from the base _SyntheticLocation_ object.
|
|
9811
9886
|
|
|
9812
|
-
| Name | Type | Description
|
|
9813
|
-
| -------------------------------- | ------------------------------------------------------------------------------------------ |
|
|
9814
|
-
| 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>).
|
|
9815
|
-
| 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.
|
|
9816
|
-
| 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>).
|
|
9817
|
-
| 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.
|
|
9818
|
-
| city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location.
|
|
9819
|
-
| 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>
|
|
9820
|
-
| 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>
|
|
9821
|
-
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location.
|
|
9822
|
-
| geoLocationId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location.
|
|
9823
|
-
| 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.
|
|
9824
|
-
| 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.
|
|
9825
|
-
| 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.
|
|
9826
|
-
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location.
|
|
9827
|
-
| 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>
|
|
9828
|
-
| 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>
|
|
9829
|
-
| status | SyntheticLocationStatus |
|
|
9830
|
-
| type<sup>\*required</sup> | SyntheticLocationType |
|
|
9831
|
-
| useNewKubernetesVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul>
|
|
9887
|
+
| Name | Type | Description |
|
|
9888
|
+
| -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9889
|
+
| autoUpdateChromium | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Auto upgrade of Chromium is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
9890
|
+
| availabilityLocationOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
|
|
9891
|
+
| availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
|
|
9892
|
+
| availabilityNotificationsEnabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
|
|
9893
|
+
| city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
|
|
9894
|
+
| countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go">GET all countries</a> request.</p> |
|
|
9895
|
+
| deploymentType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
|
|
9896
|
+
| entityId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace entity ID of the location. |
|
|
9897
|
+
| geoLocationId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The Dynatrace GeoLocation ID of the location. |
|
|
9898
|
+
| latitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The latitude of the location in <code>DDD.dddd</code> format. |
|
|
9899
|
+
| locationNodeOutageDelayInMinutes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
|
|
9900
|
+
| longitude<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The longitude of the location in <code>DDD.dddd</code> format. |
|
|
9901
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
|
|
9902
|
+
| nodes | Array<<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> |
|
|
9903
|
+
| regionCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0">GET regions of the country</a> request.</p> |
|
|
9904
|
+
| status | SyntheticLocationStatus | |
|
|
9905
|
+
| type<sup>\*required</sup> | SyntheticLocationType | |
|
|
9906
|
+
| useNewKubernetesVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
|
|
9832
9907
|
|
|
9833
9908
|
### Problem
|
|
9834
9909
|
|
|
@@ -9899,27 +9974,27 @@ The vulnerable functions of a process group including their usage.
|
|
|
9899
9974
|
|
|
9900
9975
|
Configuration of a property in a settings schema.
|
|
9901
9976
|
|
|
9902
|
-
| Name | Type
|
|
9903
|
-
| ------------------------------- |
|
|
9904
|
-
| constraints | Array<<a href="#constraint">Constraint</a>>
|
|
9905
|
-
| datasource | <a href="#datasourcedefinition">DatasourceDefinition</a>
|
|
9906
|
-
| default |
|
|
9907
|
-
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9908
|
-
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9909
|
-
| documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9910
|
-
| forceSecretResubmission | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
9911
|
-
| items | <a href="#item">Item</a>
|
|
9912
|
-
| maxObjects<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
9913
|
-
| metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>
|
|
9914
|
-
| migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9915
|
-
| minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
9916
|
-
| modificationPolicy | PropertyDefinitionModificationPolicy
|
|
9917
|
-
| nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a>
|
|
9918
|
-
| precondition | <a href="#precondition">Precondition</a>
|
|
9919
|
-
| referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9920
|
-
| subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
9921
|
-
| type<sup>\*required</sup> | PropertyDefinitionType
|
|
9922
|
-
| uiCustomization | <a href="#uicustomization">UiCustomization</a>
|
|
9977
|
+
| Name | Type | Description |
|
|
9978
|
+
| ------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9979
|
+
| constraints | Array<<a href="#constraint">Constraint</a>> | A list of constraints limiting the values to be accepted. |
|
|
9980
|
+
| datasource | <a href="#datasourcedefinition">DatasourceDefinition</a> | |
|
|
9981
|
+
| default | PropertyDefinitionDefault | |
|
|
9982
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the property. |
|
|
9983
|
+
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The display name of the property. |
|
|
9984
|
+
| documentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | An extended description and/or links to documentation. |
|
|
9985
|
+
| forceSecretResubmission | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Defines if value is allowed to be modified when secret properties are not |
|
|
9986
|
+
| items | <a href="#item">Item</a> | |
|
|
9987
|
+
| maxObjects<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
|
|
9988
|
+
| metadata | <a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a> | |
|
|
9989
|
+
| migrationPattern | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Pattern with references to properties to create a new value. |
|
|
9990
|
+
| minObjects | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The minimum number of <strong>objects</strong> in a collection property. |
|
|
9991
|
+
| modificationPolicy | PropertyDefinitionModificationPolicy | |
|
|
9992
|
+
| nullable<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
|
|
9993
|
+
| precondition | <a href="#precondition">Precondition</a> | |
|
|
9994
|
+
| referencedType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The type referenced by the property value |
|
|
9995
|
+
| subType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The subtype of the property's value. |
|
|
9996
|
+
| type<sup>\*required</sup> | PropertyDefinitionType | |
|
|
9997
|
+
| uiCustomization | <a href="#uicustomization">UiCustomization</a> | |
|
|
9923
9998
|
|
|
9924
9999
|
### PropertyDefinitionMetadata
|
|
9925
10000
|
|
|
@@ -9931,6 +10006,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
9931
10006
|
|
|
9932
10007
|
| Name | Type | Description |
|
|
9933
10008
|
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
10009
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
9934
10010
|
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
9935
10011
|
| certificate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The certificate in the string format. |
|
|
9936
10012
|
| certificateFormat | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The certificate format. |
|
|
@@ -10057,7 +10133,7 @@ A Release is a combination of a component and a version.
|
|
|
10057
10133
|
A Component can be any form of deployable that can be associated with a version.
|
|
10058
10134
|
In the first draft, a Component is always a Service.
|
|
10059
10135
|
|
|
10060
|
-
The tuple
|
|
10136
|
+
The tuple <name, product, stage, version> is always unique.
|
|
10061
10137
|
|
|
10062
10138
|
| Name | Type | Description |
|
|
10063
10139
|
| --------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
@@ -10726,60 +10802,60 @@ Analysis of problem impact to a service.
|
|
|
10726
10802
|
|
|
10727
10803
|
A settings object.
|
|
10728
10804
|
|
|
10729
|
-
| Name | Type
|
|
10730
|
-
| ---------------- |
|
|
10731
|
-
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10732
|
-
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10733
|
-
| createdBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10734
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10735
|
-
| modificationInfo | <a href="#modificationinfo">ModificationInfo</a>
|
|
10736
|
-
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10737
|
-
| modifiedBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10738
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10739
|
-
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10740
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10741
|
-
| scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10742
|
-
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10743
|
-
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10744
|
-
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10745
|
-
| value |
|
|
10805
|
+
| Name | Type | Description |
|
|
10806
|
+
| ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10807
|
+
| author | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user (identified by a user ID or a public token ID) who performed that most recent modification. |
|
|
10808
|
+
| created | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the creation. |
|
|
10809
|
+
| createdBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who created the settings object. |
|
|
10810
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The external identifier of the settings object. |
|
|
10811
|
+
| modificationInfo | <a href="#modificationinfo">ModificationInfo</a> | |
|
|
10812
|
+
| modified | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp of the last modification. |
|
|
10813
|
+
| modifiedBy | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier of the user who performed the most recent modification. |
|
|
10814
|
+
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the settings object. |
|
|
10815
|
+
| schemaId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
|
|
10816
|
+
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
|
|
10817
|
+
| scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
|
|
10818
|
+
| searchSummary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A searchable summary string of the setting value. Plain text without Markdown. |
|
|
10819
|
+
| summary | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
|
|
10820
|
+
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
10821
|
+
| value | SettingsValue | |
|
|
10746
10822
|
|
|
10747
10823
|
### SettingsObjectCreate
|
|
10748
10824
|
|
|
10749
10825
|
Configuration of a new settings object.
|
|
10750
10826
|
|
|
10751
|
-
| Name | Type
|
|
10752
|
-
| ----------------------------- |
|
|
10753
|
-
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10754
|
-
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10755
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10756
|
-
| schemaId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10757
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10758
|
-
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10759
|
-
| value<sup>\*required</sup> |
|
|
10827
|
+
| Name | Type | Description |
|
|
10828
|
+
| ----------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10829
|
+
| externalId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | External identifier for the object being created |
|
|
10830
|
+
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the new object. The new object will be added after the specified one.</p> <p>If <code>null</code>, the new object will be placed in the last position.</p> <p>If set to empty string, the new object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <code>ordered</code> parameter is set to <code>true</code>).</p> |
|
|
10831
|
+
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The ID of the settings object that should be replaced.</p> <p>Only applicable if an external identifier is provided.</p> |
|
|
10832
|
+
| schemaId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The schema on which the object is based. |
|
|
10833
|
+
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
|
|
10834
|
+
| scope<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>. |
|
|
10835
|
+
| value<sup>\*required</sup> | SettingsValue | |
|
|
10760
10836
|
|
|
10761
10837
|
### SettingsObjectResponse
|
|
10762
10838
|
|
|
10763
10839
|
The response to a creation- or update-request.
|
|
10764
10840
|
|
|
10765
|
-
| Name | Type
|
|
10766
|
-
| ------------------------- |
|
|
10767
|
-
| code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
10768
|
-
| error | <a href="#error">Error</a>
|
|
10769
|
-
| invalidValue |
|
|
10770
|
-
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10841
|
+
| Name | Type | Description |
|
|
10842
|
+
| ------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
10843
|
+
| code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP status code for the object. |
|
|
10844
|
+
| error | <a href="#error">Error</a> | |
|
|
10845
|
+
| invalidValue | SettingsValue | |
|
|
10846
|
+
| objectId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | For a successful request, the ID of the created or modified settings object. |
|
|
10771
10847
|
|
|
10772
10848
|
### SettingsObjectUpdate
|
|
10773
10849
|
|
|
10774
10850
|
An update of a settings object.
|
|
10775
10851
|
|
|
10776
|
-
| Name | Type
|
|
10777
|
-
| -------------------------- |
|
|
10778
|
-
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10779
|
-
| insertBefore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10780
|
-
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10781
|
-
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
10782
|
-
| value<sup>\*required</sup> |
|
|
10852
|
+
| Name | Type | Description |
|
|
10853
|
+
| -------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10854
|
+
| insertAfter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved behind the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertBefore</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the first position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
|
|
10855
|
+
| insertBefore | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The position of the updated object. The new object will be moved in front of the specified one.</p> <p><strong>insertAfter</strong> and <strong>insertBefore</strong> are evaluated together and only one of both can be set.</p> <p>If <code>null</code> and <strong>insertAfter</strong> 'null', the existing object keeps the current position.</p> <p>If set to empty string, the updated object will be placed in the last position.</p> <p>Only applicable for objects based on schemas with ordered objects (schema's <strong>ordered</strong> parameter is set to <code>true</code>).</p> |
|
|
10856
|
+
| schemaVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the schema on which the object is based. |
|
|
10857
|
+
| updateToken | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
10858
|
+
| value<sup>\*required</sup> | SettingsValue | |
|
|
10783
10859
|
|
|
10784
10860
|
### SloBurnRate
|
|
10785
10861
|
|
|
@@ -10946,7 +11022,7 @@ Basic monitor data.
|
|
|
10946
11022
|
|
|
10947
11023
|
### SyntheticMultiProtocolMonitorConstraintDto
|
|
10948
11024
|
|
|
10949
|
-
The
|
|
11025
|
+
The network availability monitor constraint.
|
|
10950
11026
|
|
|
10951
11027
|
| Name | Type | Description |
|
|
10952
11028
|
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ---------------- |
|
|
@@ -10959,7 +11035,7 @@ The properties of the constraint.
|
|
|
10959
11035
|
|
|
10960
11036
|
### SyntheticMultiProtocolMonitorDto
|
|
10961
11037
|
|
|
10962
|
-
|
|
11038
|
+
Network Availability monitor.
|
|
10963
11039
|
|
|
10964
11040
|
| Name | Type | Description |
|
|
10965
11041
|
| -------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -10980,11 +11056,12 @@ The properties of the monitor.
|
|
|
10980
11056
|
|
|
10981
11057
|
### SyntheticMultiProtocolMonitorStepDto
|
|
10982
11058
|
|
|
10983
|
-
The step of a
|
|
11059
|
+
The step of a network availability monitor.
|
|
10984
11060
|
|
|
10985
11061
|
| Name | Type | Description |
|
|
10986
11062
|
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
|
|
10987
11063
|
| constraints<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>> | The list of constraints which apply to all requests in the step. |
|
|
11064
|
+
| name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Step name. |
|
|
10988
11065
|
| properties<sup>\*required</sup> | <a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a> | |
|
|
10989
11066
|
| requestConfigurations<sup>\*required</sup> | Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>> | Request configurations. |
|
|
10990
11067
|
| requestType<sup>\*required</sup> | SyntheticMultiProtocolMonitorStepDtoRequestType | |
|
|
@@ -10997,7 +11074,7 @@ The properties which apply to all requests in the step.
|
|
|
10997
11074
|
|
|
10998
11075
|
### SyntheticMultiProtocolMonitorUpdateDto
|
|
10999
11076
|
|
|
11000
|
-
|
|
11077
|
+
Network availability monitor.
|
|
11001
11078
|
|
|
11002
11079
|
| Name | Type | Description |
|
|
11003
11080
|
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -11017,7 +11094,7 @@ The properties of the monitor.
|
|
|
11017
11094
|
|
|
11018
11095
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
11019
11096
|
|
|
11020
|
-
The configuration of a
|
|
11097
|
+
The configuration of a network availability monitor request.
|
|
11021
11098
|
|
|
11022
11099
|
| Name | Type | Description |
|
|
11023
11100
|
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- |
|
|
@@ -11055,24 +11132,24 @@ String to string map of metadata properties for batch
|
|
|
11055
11132
|
|
|
11056
11133
|
Describes the status of an on-demand execution.
|
|
11057
11134
|
|
|
11058
|
-
| Name | Type
|
|
11059
|
-
| ------------------------------------------ |
|
|
11060
|
-
| batchId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11061
|
-
| customizedScript |
|
|
11062
|
-
| dataDeliveryTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11063
|
-
| executionId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11064
|
-
| executionStage<sup>\*required</sup> | SyntheticOnDemandExecutionExecutionStage
|
|
11065
|
-
| executionTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11066
|
-
| fullResults | <a href="#executionfullresults">ExecutionFullResults</a>
|
|
11067
|
-
| locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11068
|
-
| metadata | <a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>
|
|
11069
|
-
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11070
|
-
| nextExecutionId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11071
|
-
| processingMode<sup>\*required</sup> | SyntheticOnDemandExecutionProcessingMode
|
|
11072
|
-
| schedulingTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a>
|
|
11073
|
-
| simpleResults | <a href="#executionsimpleresults">ExecutionSimpleResults</a>
|
|
11074
|
-
| source<sup>\*required</sup> | SyntheticOnDemandExecutionSource
|
|
11075
|
-
| userId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
|
|
11135
|
+
| Name | Type | Description |
|
|
11136
|
+
| ------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
|
11137
|
+
| batchId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the batch. |
|
|
11138
|
+
| customizedScript | ObjectNode | |
|
|
11139
|
+
| dataDeliveryTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when whole data set has been collected on server, in UTC milliseconds. |
|
|
11140
|
+
| executionId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the execution. |
|
|
11141
|
+
| executionStage<sup>\*required</sup> | SyntheticOnDemandExecutionExecutionStage | |
|
|
11142
|
+
| executionTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp when execution was finished, in UTC milliseconds. |
|
|
11143
|
+
| fullResults | <a href="#executionfullresults">ExecutionFullResults</a> | |
|
|
11144
|
+
| locationId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the location from where the monitor is to be executed. |
|
|
11145
|
+
| metadata | <a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a> | |
|
|
11146
|
+
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The identifier of the monitor. |
|
|
11147
|
+
| nextExecutionId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Next execution id for sequential mode. |
|
|
11148
|
+
| processingMode<sup>\*required</sup> | SyntheticOnDemandExecutionProcessingMode | |
|
|
11149
|
+
| schedulingTimestamp<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The scheduling timestamp, in UTC milliseconds. |
|
|
11150
|
+
| simpleResults | <a href="#executionsimpleresults">ExecutionSimpleResults</a> | |
|
|
11151
|
+
| source<sup>\*required</sup> | SyntheticOnDemandExecutionSource | |
|
|
11152
|
+
| userId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the user who triggered the on-demand execution. |
|
|
11076
11153
|
|
|
11077
11154
|
### SyntheticOnDemandExecutionMetadata
|
|
11078
11155
|
|
|
@@ -11114,7 +11191,7 @@ Contains monitors to be executed on demand from the locations specified.
|
|
|
11114
11191
|
|
|
11115
11192
|
| Name | Type | Description |
|
|
11116
11193
|
| ------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11117
|
-
| customizedScript |
|
|
11194
|
+
| customizedScript | SyntheticOnDemandExecutionRequestMonitorCustomizedScript | |
|
|
11118
11195
|
| executionCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. <i>default:</i> <code>1</code> |
|
|
11119
11196
|
| 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. |
|
|
11120
11197
|
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier. |
|
|
@@ -11191,13 +11268,13 @@ Configuration of a private synthetic location
|
|
|
11191
11268
|
| -------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11192
11269
|
| autoUpdateChromium | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Auto upgrade of Chromium is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
11193
11270
|
| availabilityLocationOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for location outage is enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
|
|
11194
|
-
| 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>).
|
|
11271
|
+
| availabilityNodeOutage | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Alerting for node outage is enabled (<code>true</code>) or disabled (<code>false</code>). \\n\\n If enabled, the outage of <em>any</em> node in the location triggers an alert. Supported only for private Synthetic locations. |
|
|
11195
11272
|
| availabilityNotificationsEnabled | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Notifications for location and node outage are enabled (<code>true</code>) or disabled (<code>false</code>). Supported only for private Synthetic locations. |
|
|
11196
11273
|
| city | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The city of the location. |
|
|
11197
11274
|
| countryCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The country code of the location.</p> <p>To fetch the list of available country codes, use the <a href="https://dt-url.net/37030go">GET all countries</a> request.</p> |
|
|
11198
11275
|
| deploymentType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The deployment type of the location:</p> <ul> <li><code>STANDARD</code>: The location is deployed on Windows or Linux.</li> <li><code>KUBERNETES</code>: The location is deployed on Kubernetes.</li> </ul> |
|
|
11199
11276
|
| latitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The latitude of the location in <code>DDD.dddd</code> format. |
|
|
11200
|
-
| 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.
|
|
11277
|
+
| locationNodeOutageDelayInMinutes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Alert if location or node outage lasts longer than <em>X</em> minutes. \\n\\n Only applicable when <code>availabilityLocationOutage</code> or <code>availabilityNodeOutage</code> is set to <code>true</code>. Supported only for private Synthetic locations. |
|
|
11201
11278
|
| longitude | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The longitude of the location in <code>DDD.dddd</code> format. |
|
|
11202
11279
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the location. |
|
|
11203
11280
|
| 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> |
|
|
@@ -11274,6 +11351,7 @@ A credentials set of the `TOKEN` type.
|
|
|
11274
11351
|
|
|
11275
11352
|
| Name | Type | Description |
|
|
11276
11353
|
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
11354
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
11277
11355
|
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
11278
11356
|
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
11279
11357
|
| externalVault | <a href="#externalvault">ExternalVault</a> | |
|
|
@@ -11507,6 +11585,7 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
11507
11585
|
|
|
11508
11586
|
| Name | Type | Description |
|
|
11509
11587
|
| --------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
11588
|
+
| allowContextlessRequests | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
11510
11589
|
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
11511
11590
|
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
11512
11591
|
| externalVault | <a href="#externalvault">ExternalVault</a> | |
|
|
@@ -11869,7 +11948,7 @@ The type of the ActiveGate.
|
|
|
11869
11948
|
|
|
11870
11949
|
<div class="padding-left--md">
|
|
11871
11950
|
|
|
11872
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11951
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11873
11952
|
|
|
11874
11953
|
</div>
|
|
11875
11954
|
|
|
@@ -11883,7 +11962,7 @@ The type of the ActiveGate.
|
|
|
11883
11962
|
|
|
11884
11963
|
<div class="padding-left--md">
|
|
11885
11964
|
|
|
11886
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
11965
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
11887
11966
|
|
|
11888
11967
|
</div>
|
|
11889
11968
|
|
|
@@ -11897,7 +11976,7 @@ The type of the ActiveGate.
|
|
|
11897
11976
|
|
|
11898
11977
|
<div class="padding-left--md">
|
|
11899
11978
|
|
|
11900
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11979
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
11901
11980
|
|
|
11902
11981
|
</div>
|
|
11903
11982
|
|
|
@@ -11913,7 +11992,7 @@ The type of the asset.
|
|
|
11913
11992
|
|
|
11914
11993
|
<div class="padding-left--md">
|
|
11915
11994
|
|
|
11916
|
-
`Alert` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
11995
|
+
`Alert` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DqlLogProcessingRule` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `LqlLogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
11917
11996
|
|
|
11918
11997
|
</div>
|
|
11919
11998
|
|