@dynatrace-sdk/client-classic-environment-v2 1.3.0 → 1.4.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 +3187 -2920
- package/docs/DOCS.md +393 -188
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3187 -2920
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +91 -23
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +18 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +36 -14
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +29 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.d.ts +7 -17
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.transformation.d.ts +5 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group-info-dto.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups-info-dto.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups-info-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-info-dto.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-architecture.d.ts +1 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-certificate-response-element.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-certificate-response-element.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-username-password-response-element.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-details-username-password-response-element.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +16 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/main-event.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto-updates.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto-updates.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link-update.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link-update.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tracking-link.transformation.d.ts +9 -0
- package/types/packages/http-client/src/lib/platform/http-client-response-error.d.ts +4 -1
- package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts +2 -0
- package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts +3 -0
- package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +3 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-scopes-item.d.ts +0 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-scopes-item.transformation.d.ts +0 -4
package/docs/DOCS.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: Classic Environment V2
|
|
2
|
+
title: "Classic Environment V2"
|
|
3
3
|
description: Client for the Dynatrace Environment API v2
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -24,7 +24,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
|
|
|
24
24
|
</a>
|
|
25
25
|
</div>
|
|
26
26
|
<div class="col" style={{textAlign: 'right'}}>
|
|
27
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.
|
|
27
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.4.2">v1.4.2</a>
|
|
28
28
|
</div>
|
|
29
29
|
</div>
|
|
30
30
|
|
|
@@ -380,7 +380,7 @@ You can limit the output by using pagination:
|
|
|
380
380
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters tokens based on the last usage time. 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> |
|
|
381
381
|
| 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> |
|
|
382
382
|
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of API tokens in a single response payload.</p> <p>The maximal allowed page size is 10000 and the minimal allowed page size is 100.</p> <p>If not set, 200 is used.</p> |
|
|
383
|
-
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p>
|
|
383
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p> <i>default:</i> <code>"-creationDate"</code> |
|
|
384
384
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters tokens based on the last usage time. 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> |
|
|
385
385
|
|
|
386
386
|
#### Returns
|
|
@@ -977,11 +977,11 @@ The response includes ActiveGates that have both completed (successful and faile
|
|
|
977
977
|
| Name | Type | Description |
|
|
978
978
|
| ------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
979
979
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe for update jobs.</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 one day is used (<code>now-1d</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
980
|
-
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
980
|
+
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. <i>default:</i> <code>false</code> |
|
|
981
981
|
| config.startVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
982
|
-
| config.startVersionCompareType | GetAllUpdateJobListQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
982
|
+
| config.startVersionCompareType | GetAllUpdateJobListQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
983
983
|
| config.targetVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
984
|
-
| config.targetVersionCompareType | GetAllUpdateJobListQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
984
|
+
| config.targetVersionCompareType | GetAllUpdateJobListQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
985
985
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe for update jobs.</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> |
|
|
986
986
|
| config.updateType | GetAllUpdateJobListQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
|
|
987
987
|
|
|
@@ -1071,11 +1071,11 @@ The job can update the ActiveGate to the specified version or the latest availab
|
|
|
1071
1071
|
| -------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1072
1072
|
| config.agId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required ActiveGate. |
|
|
1073
1073
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The start of the requested timeframe for update jobs.</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 one week is used (<code>now-1w</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
1074
|
-
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
1074
|
+
| config.lastUpdates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. <i>default:</i> <code>false</code> |
|
|
1075
1075
|
| config.startVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
1076
|
-
| config.startVersionCompareType | GetUpdateJobListByAgIdQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
1076
|
+
| config.startVersionCompareType | GetUpdateJobListByAgIdQueryStartVersionCompareType | <p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1077
1077
|
| config.targetVersion | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
1078
|
-
| config.targetVersionCompareType | GetUpdateJobListByAgIdQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
1078
|
+
| config.targetVersionCompareType | GetUpdateJobListByAgIdQueryTargetVersionCompareType | <p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1079
1079
|
| config.to | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The end of the requested timeframe for update jobs.</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> |
|
|
1080
1080
|
| config.updateType | GetUpdateJobListByAgIdQueryUpdateType | Filters the resulting set of update-jobs by the update type. |
|
|
1081
1081
|
|
|
@@ -1186,7 +1186,7 @@ The response includes all ActiveGates that are currently connected to the enviro
|
|
|
1186
1186
|
| config.type | GetAllActiveGatesQueryType | Filters the resulting set of ActiveGates by the ActiveGate type. |
|
|
1187
1187
|
| config.updateStatus | GetAllActiveGatesQueryUpdateStatus | Filters the resulting set of ActiveGates by the auto-update status. |
|
|
1188
1188
|
| config.version | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the version in <code><major>.<minor>.<revision></code> format (for example, <code>1.195.0</code>) here.</p> |
|
|
1189
|
-
| config.versionCompareType | GetAllActiveGatesQueryVersionCompareType | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p>
|
|
1189
|
+
| config.versionCompareType | GetAllActiveGatesQueryVersionCompareType | <p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p> <i>default:</i> <code>"EQUAL"</code> |
|
|
1190
1190
|
|
|
1191
1191
|
#### Returns
|
|
1192
1192
|
|
|
@@ -1323,7 +1323,7 @@ You can limit the output by using pagination:
|
|
|
1323
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
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
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>
|
|
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
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> |
|
|
1328
1328
|
|
|
1329
1329
|
#### Returns
|
|
@@ -1364,7 +1364,7 @@ Ingests a business event
|
|
|
1364
1364
|
**Required scope:** storage:events:write
|
|
1365
1365
|
**Required permission:** storage:events:write
|
|
1366
1366
|
|
|
1367
|
-
The ingestion of business events
|
|
1367
|
+
The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
1368
1368
|
|
|
1369
1369
|
</div>
|
|
1370
1370
|
|
|
@@ -1555,7 +1555,7 @@ const data = await credentialVaultClient.getCredentialsDetails({
|
|
|
1555
1555
|
|
|
1556
1556
|
<div class="padding-left--md">
|
|
1557
1557
|
|
|
1558
|
-
Lists all sets of credentials
|
|
1558
|
+
Lists all sets of credentials in your environment.
|
|
1559
1559
|
|
|
1560
1560
|
**Required scope:** environment-api:credentials:read
|
|
1561
1561
|
**Required permission:** environment:roles:viewer
|
|
@@ -1764,7 +1764,7 @@ Ingests a custom event
|
|
|
1764
1764
|
- environment:roles:viewer
|
|
1765
1765
|
- storage:events:write
|
|
1766
1766
|
|
|
1767
|
-
The ingestion of custom events
|
|
1767
|
+
The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
|
|
1768
1768
|
|
|
1769
1769
|
</div>
|
|
1770
1770
|
|
|
@@ -2065,7 +2065,10 @@ import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-
|
|
|
2065
2065
|
Activates the environment configuration from the specified version of the extension 2.0
|
|
2066
2066
|
|
|
2067
2067
|
**Required scope:** environment-api:extensions:write
|
|
2068
|
-
**
|
|
2068
|
+
**One of the following permissions is required:**
|
|
2069
|
+
|
|
2070
|
+
- environment:roles:manage-settings
|
|
2071
|
+
- extensions:definitions:write
|
|
2069
2072
|
|
|
2070
2073
|
</div>
|
|
2071
2074
|
|
|
@@ -2110,7 +2113,10 @@ const data =
|
|
|
2110
2113
|
Creates new monitoring configuration for the specified extension 2.0
|
|
2111
2114
|
|
|
2112
2115
|
**Required scope:** environment-api:extension-configurations:write
|
|
2113
|
-
**
|
|
2116
|
+
**One of the following permissions is required:**
|
|
2117
|
+
|
|
2118
|
+
- environment:roles:manage-settings
|
|
2119
|
+
- extensions:configurations:write
|
|
2114
2120
|
|
|
2115
2121
|
</div>
|
|
2116
2122
|
|
|
@@ -2172,7 +2178,10 @@ const data = await extensions_2_0Client.createMonitoringConfiguration({
|
|
|
2172
2178
|
Deactivates the environment configuration of the specified extension 2.0
|
|
2173
2179
|
|
|
2174
2180
|
**Required scope:** environment-api:extensions:write
|
|
2175
|
-
**
|
|
2181
|
+
**One of the following permissions is required:**
|
|
2182
|
+
|
|
2183
|
+
- environment:roles:manage-settings
|
|
2184
|
+
- extensions:definitions:write
|
|
2176
2185
|
|
|
2177
2186
|
</div>
|
|
2178
2187
|
|
|
@@ -2214,7 +2223,10 @@ const data = await extensions_2_0Client.deleteEnvironmentConfiguration({
|
|
|
2214
2223
|
Gets the configuration schema of the specified version of the extension 2.0
|
|
2215
2224
|
|
|
2216
2225
|
**Required scope:** environment-api:extension-configurations:read
|
|
2217
|
-
**
|
|
2226
|
+
**One of the following permissions is required:**
|
|
2227
|
+
|
|
2228
|
+
- environment:roles:manage-settings
|
|
2229
|
+
- extensions:definitions:read
|
|
2218
2230
|
|
|
2219
2231
|
</div>
|
|
2220
2232
|
|
|
@@ -2258,7 +2270,10 @@ const data = await extensions_2_0Client.extensionConfigurationSchema({
|
|
|
2258
2270
|
Gets details of the specified version of the extension 2.0
|
|
2259
2271
|
|
|
2260
2272
|
**Required scope:** environment-api:extensions:read
|
|
2261
|
-
**
|
|
2273
|
+
**One of the following permissions is required:**
|
|
2274
|
+
|
|
2275
|
+
- environment:roles:manage-settings
|
|
2276
|
+
- extensions:definitions:read
|
|
2262
2277
|
|
|
2263
2278
|
</div>
|
|
2264
2279
|
|
|
@@ -2304,7 +2319,10 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
2304
2319
|
Lists all the monitoring configurations of the specified extension 2.0
|
|
2305
2320
|
|
|
2306
2321
|
**Required scope:** environment-api:extension-configurations:read
|
|
2307
|
-
**
|
|
2322
|
+
**One of the following permissions is required:**
|
|
2323
|
+
|
|
2324
|
+
- environment:roles:manage-settings
|
|
2325
|
+
- extensions:configurations:read
|
|
2308
2326
|
|
|
2309
2327
|
</div>
|
|
2310
2328
|
|
|
@@ -2350,7 +2368,10 @@ const data = await extensions_2_0Client.extensionMonitoringConfigurations({
|
|
|
2350
2368
|
Gets the active environment configuration version of the specified extension 2.0
|
|
2351
2369
|
|
|
2352
2370
|
**Required scope:** environment-api:extensions:read
|
|
2353
|
-
**
|
|
2371
|
+
**One of the following permissions is required:**
|
|
2372
|
+
|
|
2373
|
+
- environment:roles:manage-settings
|
|
2374
|
+
- extensions:definitions:read
|
|
2354
2375
|
|
|
2355
2376
|
</div>
|
|
2356
2377
|
|
|
@@ -2382,6 +2403,47 @@ const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
|
|
|
2382
2403
|
|
|
2383
2404
|
</div>
|
|
2384
2405
|
|
|
2406
|
+
### getActiveGateGroupsInfo
|
|
2407
|
+
|
|
2408
|
+
<div class="padding-bottom--md">
|
|
2409
|
+
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto">ActiveGateGroupsInfoDto</a>></strong>
|
|
2410
|
+
|
|
2411
|
+
<div class="padding-left--md">
|
|
2412
|
+
|
|
2413
|
+
List all ActiveGate groups available for extension | maturity=IN_DEVELOPMENT
|
|
2414
|
+
|
|
2415
|
+
</div>
|
|
2416
|
+
|
|
2417
|
+
#### Parameters
|
|
2418
|
+
|
|
2419
|
+
| Name | Type | Description |
|
|
2420
|
+
| -------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------ |
|
|
2421
|
+
| 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. |
|
|
2422
|
+
| config.extensionVersion<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the requested extension 2.0 |
|
|
2423
|
+
|
|
2424
|
+
#### Returns
|
|
2425
|
+
|
|
2426
|
+
Success
|
|
2427
|
+
|
|
2428
|
+
<details>
|
|
2429
|
+
<summary>
|
|
2430
|
+
Code example
|
|
2431
|
+
|
|
2432
|
+
</summary>
|
|
2433
|
+
|
|
2434
|
+
```ts
|
|
2435
|
+
import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
2436
|
+
|
|
2437
|
+
const data = await extensions_2_0Client.getActiveGateGroupsInfo({
|
|
2438
|
+
extensionName: "...",
|
|
2439
|
+
extensionVersion: "...",
|
|
2440
|
+
});
|
|
2441
|
+
```
|
|
2442
|
+
|
|
2443
|
+
</details>
|
|
2444
|
+
|
|
2445
|
+
</div>
|
|
2446
|
+
|
|
2385
2447
|
### getEnvironmentConfigurationAssetsInfo
|
|
2386
2448
|
|
|
2387
2449
|
<div class="padding-bottom--md">
|
|
@@ -2392,7 +2454,10 @@ const data = await extensions_2_0Client.getActiveEnvironmentConfiguration({
|
|
|
2392
2454
|
Gets the information about assets in an active extension 2.0
|
|
2393
2455
|
|
|
2394
2456
|
**Required scope:** environment-api:extensions:read
|
|
2395
|
-
**
|
|
2457
|
+
**One of the following permissions is required:**
|
|
2458
|
+
|
|
2459
|
+
- environment:roles:manage-settings
|
|
2460
|
+
- extensions:definitions:read
|
|
2396
2461
|
|
|
2397
2462
|
</div>
|
|
2398
2463
|
|
|
@@ -2434,7 +2499,10 @@ const data = await extensions_2_0Client.getEnvironmentConfigurationAssetsInfo({
|
|
|
2434
2499
|
List of the latest extension environment configuration events
|
|
2435
2500
|
|
|
2436
2501
|
**Required scope:** environment-api:extensions:read
|
|
2437
|
-
**
|
|
2502
|
+
**One of the following permissions is required:**
|
|
2503
|
+
|
|
2504
|
+
- environment:roles:manage-settings
|
|
2505
|
+
- extensions:definitions:read
|
|
2438
2506
|
|
|
2439
2507
|
</div>
|
|
2440
2508
|
|
|
@@ -2480,7 +2548,10 @@ const data = await extensions_2_0Client.getEnvironmentConfigurationEvents({
|
|
|
2480
2548
|
Gets the list of the events linked to specific monitoring configuration
|
|
2481
2549
|
|
|
2482
2550
|
**Required scope:** environment-api:extension-configurations:read
|
|
2483
|
-
**
|
|
2551
|
+
**One of the following permissions is required:**
|
|
2552
|
+
|
|
2553
|
+
- environment:roles:manage-settings
|
|
2554
|
+
- extensions:configurations:read
|
|
2484
2555
|
|
|
2485
2556
|
</div>
|
|
2486
2557
|
|
|
@@ -2532,7 +2603,10 @@ const data =
|
|
|
2532
2603
|
Gets the most recent status of the execution of given monitoring configuration
|
|
2533
2604
|
|
|
2534
2605
|
**Required scope:** environment-api:extension-configurations:read
|
|
2535
|
-
**
|
|
2606
|
+
**One of the following permissions is required:**
|
|
2607
|
+
|
|
2608
|
+
- environment:roles:manage-settings
|
|
2609
|
+
- extensions:configurations:read
|
|
2536
2610
|
|
|
2537
2611
|
</div>
|
|
2538
2612
|
|
|
@@ -2577,7 +2651,10 @@ const data =
|
|
|
2577
2651
|
Gets the extension 2.0 schema file in the specified version
|
|
2578
2652
|
|
|
2579
2653
|
**Required scope:** environment-api:extensions:read
|
|
2580
|
-
**
|
|
2654
|
+
**One of the following permissions is required:**
|
|
2655
|
+
|
|
2656
|
+
- environment:roles:manage-settings
|
|
2657
|
+
- extensions:definitions:read
|
|
2581
2658
|
|
|
2582
2659
|
</div>
|
|
2583
2660
|
|
|
@@ -2621,7 +2698,10 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
2621
2698
|
Lists all versions of the extension 2.0
|
|
2622
2699
|
|
|
2623
2700
|
**Required scope:** environment-api:extensions:read
|
|
2624
|
-
**
|
|
2701
|
+
**One of the following permissions is required:**
|
|
2702
|
+
|
|
2703
|
+
- environment:roles:manage-settings
|
|
2704
|
+
- extensions:definitions:read
|
|
2625
2705
|
|
|
2626
2706
|
</div>
|
|
2627
2707
|
|
|
@@ -2665,7 +2745,10 @@ const data = await extensions_2_0Client.listExtensionVersions({
|
|
|
2665
2745
|
Lists all the extensions 2.0 available in your environment
|
|
2666
2746
|
|
|
2667
2747
|
**Required scope:** environment-api:extensions:read
|
|
2668
|
-
**
|
|
2748
|
+
**One of the following permissions is required:**
|
|
2749
|
+
|
|
2750
|
+
- environment:roles:manage-settings
|
|
2751
|
+
- extensions:definitions:read
|
|
2669
2752
|
|
|
2670
2753
|
</div>
|
|
2671
2754
|
|
|
@@ -2707,7 +2790,10 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
2707
2790
|
Lists all the files available for the specified extension 2.0 schema version
|
|
2708
2791
|
|
|
2709
2792
|
**Required scope:** environment-api:extensions:read
|
|
2710
|
-
**
|
|
2793
|
+
**One of the following permissions is required:**
|
|
2794
|
+
|
|
2795
|
+
- environment:roles:manage-settings
|
|
2796
|
+
- extensions:definitions:read
|
|
2711
2797
|
|
|
2712
2798
|
</div>
|
|
2713
2799
|
|
|
@@ -2751,7 +2837,10 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
2751
2837
|
Lists all the extension 2.0 schemas versions available in your environment
|
|
2752
2838
|
|
|
2753
2839
|
**Required scope:** environment-api:extensions:read
|
|
2754
|
-
**
|
|
2840
|
+
**One of the following permissions is required:**
|
|
2841
|
+
|
|
2842
|
+
- environment:roles:manage-settings
|
|
2843
|
+
- extensions:definitions:read
|
|
2755
2844
|
|
|
2756
2845
|
</div>
|
|
2757
2846
|
|
|
@@ -2787,7 +2876,10 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
2787
2876
|
Gets the details of the specified monitoring configuration
|
|
2788
2877
|
|
|
2789
2878
|
**Required scope:** environment-api:extension-configurations:read
|
|
2790
|
-
**
|
|
2879
|
+
**One of the following permissions is required:**
|
|
2880
|
+
|
|
2881
|
+
- environment:roles:manage-settings
|
|
2882
|
+
- extensions:configurations:read
|
|
2791
2883
|
|
|
2792
2884
|
</div>
|
|
2793
2885
|
|
|
@@ -2831,7 +2923,10 @@ const data = await extensions_2_0Client.monitoringConfigurationDetails({
|
|
|
2831
2923
|
Deletes the specified version of the extension 2.0
|
|
2832
2924
|
|
|
2833
2925
|
**Required scope:** environment-api:extensions:write
|
|
2834
|
-
**
|
|
2926
|
+
**One of the following permissions is required:**
|
|
2927
|
+
|
|
2928
|
+
- environment:roles:manage-settings
|
|
2929
|
+
- extensions:definitions:write
|
|
2835
2930
|
|
|
2836
2931
|
</div>
|
|
2837
2932
|
|
|
@@ -2875,7 +2970,10 @@ const data = await extensions_2_0Client.removeExtension({
|
|
|
2875
2970
|
Deletes the specified monitoring configuration
|
|
2876
2971
|
|
|
2877
2972
|
**Required scope:** environment-api:extension-configurations:write
|
|
2878
|
-
**
|
|
2973
|
+
**One of the following permissions is required:**
|
|
2974
|
+
|
|
2975
|
+
- environment:roles:manage-settings
|
|
2976
|
+
- extensions:configurations:write
|
|
2879
2977
|
|
|
2880
2978
|
</div>
|
|
2881
2979
|
|
|
@@ -2917,7 +3015,10 @@ const data = await extensions_2_0Client.removeMonitoringConfiguration({
|
|
|
2917
3015
|
Updates the active environment configuration version of the extension 2.0
|
|
2918
3016
|
|
|
2919
3017
|
**Required scope:** environment-api:extensions:write
|
|
2920
|
-
**
|
|
3018
|
+
**One of the following permissions is required:**
|
|
3019
|
+
|
|
3020
|
+
- environment:roles:manage-settings
|
|
3021
|
+
- extensions:definitions:write
|
|
2921
3022
|
|
|
2922
3023
|
</div>
|
|
2923
3024
|
|
|
@@ -2960,7 +3061,10 @@ const data = await extensions_2_0Client.updateExtensionEnvironmentConfiguration(
|
|
|
2960
3061
|
Updates the specified monitoring configuration
|
|
2961
3062
|
|
|
2962
3063
|
**Required scope:** environment-api:extension-configurations:write
|
|
2963
|
-
**
|
|
3064
|
+
**One of the following permissions is required:**
|
|
3065
|
+
|
|
3066
|
+
- environment:roles:manage-settings
|
|
3067
|
+
- extensions:configurations:write
|
|
2964
3068
|
|
|
2965
3069
|
</div>
|
|
2966
3070
|
|
|
@@ -3006,17 +3110,20 @@ const data = await extensions_2_0Client.updateMonitoringConfiguration({
|
|
|
3006
3110
|
Uploads or verifies a new extension 2.0
|
|
3007
3111
|
|
|
3008
3112
|
**Required scope:** environment-api:extensions:write
|
|
3009
|
-
**
|
|
3113
|
+
**One of the following permissions is required:**
|
|
3114
|
+
|
|
3115
|
+
- environment:roles:manage-settings
|
|
3116
|
+
- extensions:definitions:write
|
|
3010
3117
|
|
|
3011
3118
|
</div>
|
|
3012
3119
|
|
|
3013
3120
|
#### Parameters
|
|
3014
3121
|
|
|
3015
|
-
| Name | Type | Description
|
|
3016
|
-
| -------------------------------- | ------------------------------------------------------------------------------- |
|
|
3017
|
-
| config.body<sup>\*required</sup> | Blob |
|
|
3018
|
-
| config.type<sup>\*required</sup> | "application/octet-stream" | "multipart/form-data" |
|
|
3019
|
-
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Only run validation but do not persist the extension even if validation was successful. |
|
|
3122
|
+
| Name | Type | Description |
|
|
3123
|
+
| -------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
3124
|
+
| config.body<sup>\*required</sup> | Blob | |
|
|
3125
|
+
| config.type<sup>\*required</sup> | "application/octet-stream" | "multipart/form-data" | |
|
|
3126
|
+
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Only run validation but do not persist the extension even if validation was successful. <i>default:</i> <code>false</code> |
|
|
3020
3127
|
|
|
3021
3128
|
#### Returns
|
|
3022
3129
|
|
|
@@ -3075,9 +3182,9 @@ Disabled on _Log Management and Analytics, powered by Grail_.
|
|
|
3075
3182
|
| ------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3076
3183
|
| 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> |
|
|
3077
3184
|
| 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> |
|
|
3078
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of results per result page.
|
|
3079
|
-
| 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>
|
|
3080
|
-
| 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>
|
|
3185
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of results per result page. <i>default:</i> <code>1000</code> |
|
|
3186
|
+
| 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> |
|
|
3187
|
+
| 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> |
|
|
3081
3188
|
| 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> |
|
|
3082
3189
|
|
|
3083
3190
|
#### Returns
|
|
@@ -3116,7 +3223,7 @@ Returns the aggregated number of occurrences of log values divided into time slo
|
|
|
3116
3223
|
|
|
3117
3224
|
It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
|
|
3118
3225
|
|
|
3119
|
-
If _Log Management and Analytics, powered by Grail_ is enabled, then
|
|
3226
|
+
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.
|
|
3120
3227
|
|
|
3121
3228
|
</div>
|
|
3122
3229
|
|
|
@@ -3126,9 +3233,9 @@ If _Log Management and Analytics, powered by Grail_ is enabled, then an OAuth to
|
|
|
3126
3233
|
| --------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3127
3234
|
| 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> |
|
|
3128
3235
|
| config.groupBy | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>The groupings to be included in the response.</p> <p>You can specify several groups in the following format: <code>groupBy=status&groupBy=log.source</code>.</p> <p>If not set, all possible groups are returned. You can use this option to check for possible grouping values.</p> <p>Unique log data attributes (high-cardinality attributes) for example, <code>span_id</code> or <code>trace_id</code> cannot be used for grouping.</p> |
|
|
3129
|
-
| config.maxGroupValues | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p>
|
|
3130
|
-
| 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>
|
|
3131
|
-
| config.timeBuckets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p>
|
|
3236
|
+
| config.maxGroupValues | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p> <i>default:</i> <code>10</code> |
|
|
3237
|
+
| 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> |
|
|
3238
|
+
| config.timeBuckets | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p> <i>default:</i> <code>1</code> |
|
|
3132
3239
|
| 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> |
|
|
3133
3240
|
|
|
3134
3241
|
#### Returns
|
|
@@ -3169,7 +3276,7 @@ If the query is too large to be processed in a single request, it is divided int
|
|
|
3169
3276
|
|
|
3170
3277
|
Results can be distributed unevenly between slices and some slices might be empty.
|
|
3171
3278
|
|
|
3172
|
-
If _Log Management and Analytics, powered by Grail_ is enabled, then
|
|
3279
|
+
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.
|
|
3173
3280
|
|
|
3174
3281
|
</div>
|
|
3175
3282
|
|
|
@@ -3178,10 +3285,10 @@ If _Log Management and Analytics, powered by Grail_ is enabled, then an OAuth to
|
|
|
3178
3285
|
| Name | Type | Description |
|
|
3179
3286
|
| ------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3180
3287
|
| 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> |
|
|
3181
|
-
| 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>
|
|
3288
|
+
| 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> |
|
|
3182
3289
|
| 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> |
|
|
3183
|
-
| 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>
|
|
3184
|
-
| 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>
|
|
3290
|
+
| 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> |
|
|
3291
|
+
| 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> |
|
|
3185
3292
|
| 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> |
|
|
3186
3293
|
|
|
3187
3294
|
#### Returns
|
|
@@ -4099,9 +4206,11 @@ Only process group instances are supported.
|
|
|
4099
4206
|
|
|
4100
4207
|
#### Parameters
|
|
4101
4208
|
|
|
4102
|
-
| Name
|
|
4103
|
-
|
|
|
4104
|
-
| config.entitySelector
|
|
4209
|
+
| Name | Type | Description |
|
|
4210
|
+
| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
4211
|
+
| 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> |
|
|
4212
|
+
| 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> |
|
|
4213
|
+
| 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> |
|
|
4105
4214
|
|
|
4106
4215
|
#### Returns
|
|
4107
4216
|
|
|
@@ -4116,9 +4225,7 @@ Code example
|
|
|
4116
4225
|
```ts
|
|
4117
4226
|
import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
4118
4227
|
|
|
4119
|
-
const data = await monitoredEntitiesMonitoringStateClient.getStates(
|
|
4120
|
-
entitySelector: "...",
|
|
4121
|
-
});
|
|
4228
|
+
const data = await monitoredEntitiesMonitoringStateClient.getStates();
|
|
4122
4229
|
```
|
|
4123
4230
|
|
|
4124
4231
|
</details>
|
|
@@ -4275,10 +4382,10 @@ Gets the statistics about hosts using the network zone
|
|
|
4275
4382
|
|
|
4276
4383
|
#### Parameters
|
|
4277
4384
|
|
|
4278
|
-
| Name | Type | Description
|
|
4279
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
4280
|
-
| config.filter | GetHostStatsQueryFilter | <p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p> |
|
|
4281
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required network zone.
|
|
4385
|
+
| Name | Type | Description |
|
|
4386
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4387
|
+
| config.filter | GetHostStatsQueryFilter | <p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p> <i>default:</i> <code>"all"</code> |
|
|
4388
|
+
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required network zone. |
|
|
4282
4389
|
|
|
4283
4390
|
#### Returns
|
|
4284
4391
|
|
|
@@ -4798,15 +4905,15 @@ Returns all releases
|
|
|
4798
4905
|
|
|
4799
4906
|
#### Parameters
|
|
4800
4907
|
|
|
4801
|
-
| Name | Type | Description
|
|
4802
|
-
| ----------------------- | ------------------------------------------------------------------------------- |
|
|
4803
|
-
| 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>).
|
|
4804
|
-
| 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>
|
|
4805
|
-
| 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>
|
|
4806
|
-
| 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>
|
|
4807
|
-
| 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> |
|
|
4808
|
-
| 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>
|
|
4809
|
-
| 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>
|
|
4908
|
+
| Name | Type | Description |
|
|
4909
|
+
| ----------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4910
|
+
| 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> |
|
|
4911
|
+
| 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> |
|
|
4912
|
+
| 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> |
|
|
4913
|
+
| 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> |
|
|
4914
|
+
| 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> |
|
|
4915
|
+
| 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> |
|
|
4916
|
+
| 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> |
|
|
4810
4917
|
|
|
4811
4918
|
#### Returns
|
|
4812
4919
|
|
|
@@ -4850,10 +4957,10 @@ Mutes several remediation items
|
|
|
4850
4957
|
|
|
4851
4958
|
#### Parameters
|
|
4852
4959
|
|
|
4853
|
-
| Name | Type | Description
|
|
4854
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
4855
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a> |
|
|
4856
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
4960
|
+
| Name | Type | Description |
|
|
4961
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
4962
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a> | |
|
|
4963
|
+
| 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. |
|
|
4857
4964
|
|
|
4858
4965
|
#### Returns
|
|
4859
4966
|
|
|
@@ -4936,10 +5043,10 @@ Un-mutes several remediation items
|
|
|
4936
5043
|
|
|
4937
5044
|
#### Parameters
|
|
4938
5045
|
|
|
4939
|
-
| Name | Type | Description
|
|
4940
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
4941
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a> |
|
|
4942
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5046
|
+
| Name | Type | Description |
|
|
5047
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5048
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a> | |
|
|
5049
|
+
| 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. |
|
|
4943
5050
|
|
|
4944
5051
|
#### Returns
|
|
4945
5052
|
|
|
@@ -5028,7 +5135,7 @@ Lists all events of a security problem
|
|
|
5028
5135
|
| Name | Type | Description |
|
|
5029
5136
|
| ------------------------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5030
5137
|
| 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> |
|
|
5031
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5138
|
+
| 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. |
|
|
5032
5139
|
| 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> |
|
|
5033
5140
|
|
|
5034
5141
|
#### Returns
|
|
@@ -5072,10 +5179,10 @@ Gets parameters of a remediation item of a security problem
|
|
|
5072
5179
|
|
|
5073
5180
|
#### Parameters
|
|
5074
5181
|
|
|
5075
|
-
| Name | Type | Description
|
|
5076
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5077
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5078
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5182
|
+
| Name | Type | Description |
|
|
5183
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5184
|
+
| 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. |
|
|
5185
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5079
5186
|
|
|
5080
5187
|
#### Returns
|
|
5081
5188
|
|
|
@@ -5119,10 +5226,10 @@ Lists remediation items of a third-party security problem
|
|
|
5119
5226
|
|
|
5120
5227
|
#### Parameters
|
|
5121
5228
|
|
|
5122
|
-
| Name | Type | Description
|
|
5123
|
-
| ------------------------------ | ----------------------------------------------------------------------------- |
|
|
5124
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5125
|
-
| 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 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> </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> |
|
|
5229
|
+
| Name | Type | Description |
|
|
5230
|
+
| ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5231
|
+
| 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. |
|
|
5232
|
+
| 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 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> |
|
|
5126
5233
|
|
|
5127
5234
|
#### Returns
|
|
5128
5235
|
|
|
@@ -5167,7 +5274,7 @@ Lists remediation progress entities
|
|
|
5167
5274
|
|
|
5168
5275
|
| Name | Type | Description |
|
|
5169
5276
|
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5170
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5277
|
+
| 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. |
|
|
5171
5278
|
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5172
5279
|
| 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 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> |
|
|
5173
5280
|
|
|
@@ -5217,7 +5324,7 @@ Gets parameters of a security problem
|
|
|
5217
5324
|
| ------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5218
5325
|
| 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> <li><code>filteredCounts</code>: Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.</li> <li><code>description</code>: The description of the vulnerability.</li> <li><code>events</code>: The security problem's last 10 events within the last 365 days, sorted from newest to oldest.</li> <li><code>vulnerableComponents</code>: A list of vulnerable components of the security problem within the provided filter range.</li> <li><code>affectedEntities</code>: A list of affected entities of the security problem within the provided filter range.</li> <li><code>exposedEntities</code>: A list of exposed entities of the security problem within the provided filter range.</li> <li><code>reachableDataAssets</code>: A list of data assets reachable by affected entities of the security problem within the provided filter range.</li> <li><code>relatedEntities</code>: A list of related entities of the security problem within the provided filter range.</li> <li><code>relatedContainerImages</code>: A list of related container images of the security problem within the provided filter range.</li> <li><code>relatedAttacks</code>: A list of attacks detected on the exposed security problem.</li> <li><code>entryPoints</code>: A list of entry points and a flag which indicates whether this list was truncated or not.</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> |
|
|
5219
5326
|
| config.from | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>Based on the timeframe start the affected-, related- and vulnerable entities are being calculated. 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 default timeframe start of 24 hours in the past is used (<code>now-24h</code>).</p> <p>The timeframe start must not be older than 365 days.</p> |
|
|
5220
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5327
|
+
| 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. |
|
|
5221
5328
|
|
|
5222
5329
|
#### Returns
|
|
5223
5330
|
|
|
@@ -5267,7 +5374,7 @@ Lists all security problems
|
|
|
5267
5374
|
| 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> |
|
|
5268
5375
|
| 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> |
|
|
5269
5376
|
| 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> |
|
|
5270
|
-
| 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>:
|
|
5377
|
+
| 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> |
|
|
5271
5378
|
| 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> |
|
|
5272
5379
|
|
|
5273
5380
|
#### Returns
|
|
@@ -5312,7 +5419,7 @@ Lists all vulnerable functions and their usage for a third-party security proble
|
|
|
5312
5419
|
| Name | Type | Description |
|
|
5313
5420
|
| ---------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
5314
5421
|
| 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> |
|
|
5315
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5422
|
+
| 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. |
|
|
5316
5423
|
| 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> |
|
|
5317
5424
|
|
|
5318
5425
|
#### Returns
|
|
@@ -5353,10 +5460,10 @@ Mutes a security problem
|
|
|
5353
5460
|
|
|
5354
5461
|
#### Parameters
|
|
5355
5462
|
|
|
5356
|
-
| Name | Type | Description
|
|
5357
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
5358
|
-
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> |
|
|
5359
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5463
|
+
| Name | Type | Description |
|
|
5464
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
5465
|
+
| config.body<sup>\*required</sup> | <a href="#securityproblemmute">SecurityProblemMute</a> | |
|
|
5466
|
+
| 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. |
|
|
5360
5467
|
|
|
5361
5468
|
<!-- no returns -->
|
|
5362
5469
|
|
|
@@ -5395,11 +5502,11 @@ Sets the mute state of a remediation item
|
|
|
5395
5502
|
|
|
5396
5503
|
#### Parameters
|
|
5397
5504
|
|
|
5398
|
-
| Name | Type | Description
|
|
5399
|
-
| --------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
5400
|
-
| config.body<sup>\*required</sup> | <a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a> |
|
|
5401
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5402
|
-
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item.
|
|
5505
|
+
| Name | Type | Description |
|
|
5506
|
+
| --------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5507
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a> | |
|
|
5508
|
+
| 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. |
|
|
5509
|
+
| config.remediationItemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the remediation item. |
|
|
5403
5510
|
|
|
5404
5511
|
<!-- no returns -->
|
|
5405
5512
|
|
|
@@ -5423,6 +5530,48 @@ const data = await securityProblemsClient.setRemediationItemMuteState({
|
|
|
5423
5530
|
|
|
5424
5531
|
</div>
|
|
5425
5532
|
|
|
5533
|
+
### trackingLinkBulkUpdateAndDelete
|
|
5534
|
+
|
|
5535
|
+
<div class="padding-bottom--md">
|
|
5536
|
+
<strong>securityProblemsClient.trackingLinkBulkUpdateAndDelete(config): Promise<void></strong>
|
|
5537
|
+
|
|
5538
|
+
<div class="padding-left--md">
|
|
5539
|
+
|
|
5540
|
+
Updates the external tracking links of the remediation items. | maturity=EARLY_ADOPTER
|
|
5541
|
+
|
|
5542
|
+
**Required scope:** environment-api:security-problems:write
|
|
5543
|
+
**Required permission:** environment:roles:manage-security-problems
|
|
5544
|
+
|
|
5545
|
+
</div>
|
|
5546
|
+
|
|
5547
|
+
#### Parameters
|
|
5548
|
+
|
|
5549
|
+
| Name | Type | Description |
|
|
5550
|
+
| -------------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------- |
|
|
5551
|
+
| config.body<sup>\*required</sup> | <a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a> | |
|
|
5552
|
+
| 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. |
|
|
5553
|
+
|
|
5554
|
+
<!-- no returns -->
|
|
5555
|
+
|
|
5556
|
+
<details>
|
|
5557
|
+
<summary>
|
|
5558
|
+
Code example
|
|
5559
|
+
|
|
5560
|
+
</summary>
|
|
5561
|
+
|
|
5562
|
+
```ts
|
|
5563
|
+
import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
5564
|
+
|
|
5565
|
+
const data = await securityProblemsClient.trackingLinkBulkUpdateAndDelete({
|
|
5566
|
+
id: "...",
|
|
5567
|
+
body: {},
|
|
5568
|
+
});
|
|
5569
|
+
```
|
|
5570
|
+
|
|
5571
|
+
</details>
|
|
5572
|
+
|
|
5573
|
+
</div>
|
|
5574
|
+
|
|
5426
5575
|
### unmuteSecurityProblem
|
|
5427
5576
|
|
|
5428
5577
|
<div class="padding-bottom--md">
|
|
@@ -5439,10 +5588,10 @@ Un-mutes a security problem
|
|
|
5439
5588
|
|
|
5440
5589
|
#### Parameters
|
|
5441
5590
|
|
|
5442
|
-
| Name | Type | Description
|
|
5443
|
-
| -------------------------------- | ----------------------------------------------------------------------------- |
|
|
5444
|
-
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> |
|
|
5445
|
-
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the
|
|
5591
|
+
| Name | Type | Description |
|
|
5592
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------- |
|
|
5593
|
+
| config.body<sup>\*required</sup> | <a href="#securityproblemunmute">SecurityProblemUnmute</a> | |
|
|
5594
|
+
| 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. |
|
|
5446
5595
|
|
|
5447
5596
|
<!-- no returns -->
|
|
5448
5597
|
|
|
@@ -5495,7 +5644,7 @@ Creates an alert of the provided alert type for an SLO
|
|
|
5495
5644
|
| config.body<sup>\*required</sup> | <a href="#abstractsloalertdto">AbstractSloAlertDto</a> | |
|
|
5496
5645
|
| 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> |
|
|
5497
5646
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
|
|
5498
|
-
| config.timeFrame | CreateAlertQueryTimeFrame | <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>
|
|
5647
|
+
| config.timeFrame | CreateAlertQueryTimeFrame | <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> |
|
|
5499
5648
|
| 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> |
|
|
5500
5649
|
|
|
5501
5650
|
#### Returns
|
|
@@ -5636,19 +5785,19 @@ By default the values are calculated for the SLO's own timeframe. You can use a
|
|
|
5636
5785
|
|
|
5637
5786
|
#### Parameters
|
|
5638
5787
|
|
|
5639
|
-
| Name | Type | Description
|
|
5640
|
-
| --------------------- | ------------------------------------------------------------------------------- |
|
|
5641
|
-
| 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>).
|
|
5642
|
-
| config.enabledSlos | GetSloQueryEnabledSlos | Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>).
|
|
5643
|
-
| 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.
|
|
5644
|
-
| 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>
|
|
5645
|
-
| 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>
|
|
5646
|
-
| 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>
|
|
5647
|
-
| 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>).
|
|
5648
|
-
| 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.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID.</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> |
|
|
5649
|
-
| 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>
|
|
5650
|
-
| 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>
|
|
5651
|
-
| 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>
|
|
5788
|
+
| Name | Type | Description |
|
|
5789
|
+
| --------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5790
|
+
| 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> |
|
|
5791
|
+
| 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> |
|
|
5792
|
+
| 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> |
|
|
5793
|
+
| 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> |
|
|
5794
|
+
| 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> |
|
|
5795
|
+
| 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> |
|
|
5796
|
+
| 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> |
|
|
5797
|
+
| 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> |
|
|
5798
|
+
| 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> |
|
|
5799
|
+
| 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> |
|
|
5800
|
+
| 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> |
|
|
5652
5801
|
|
|
5653
5802
|
#### Returns
|
|
5654
5803
|
|
|
@@ -5695,7 +5844,7 @@ If **from** and **to** parameters are provided, the SLO is calculated for that t
|
|
|
5695
5844
|
| ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5696
5845
|
| 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> |
|
|
5697
5846
|
| config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the required SLO. |
|
|
5698
|
-
| config.timeFrame | GetSloByIdQueryTimeFrame | <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>
|
|
5847
|
+
| config.timeFrame | GetSloByIdQueryTimeFrame | <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> |
|
|
5699
5848
|
| 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> |
|
|
5700
5849
|
|
|
5701
5850
|
#### Returns
|
|
@@ -5845,13 +5994,13 @@ If no object along the hierarchy is persisted, the default value as defined in t
|
|
|
5845
5994
|
|
|
5846
5995
|
#### Parameters
|
|
5847
5996
|
|
|
5848
|
-
| Name | Type | Description
|
|
5849
|
-
| ------------------ | ----------------------------------------------------------------------------- |
|
|
5850
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
5851
|
-
| 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>
|
|
5852
|
-
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p>
|
|
5853
|
-
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p>
|
|
5854
|
-
| config.scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scope. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p>
|
|
5997
|
+
| Name | Type | Description |
|
|
5998
|
+
| ------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5999
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"origin,value"</code> |
|
|
6000
|
+
| 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> |
|
|
6001
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
6002
|
+
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
6003
|
+
| config.scope | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The scope that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scope. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p> |
|
|
5855
6004
|
|
|
5856
6005
|
#### Returns
|
|
5857
6006
|
|
|
@@ -5943,14 +6092,16 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
5943
6092
|
|
|
5944
6093
|
#### Parameters
|
|
5945
6094
|
|
|
5946
|
-
| Name | Type | Description
|
|
5947
|
-
| ------------------ | ----------------------------------------------------------------------------- |
|
|
5948
|
-
| config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p>
|
|
5949
|
-
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p>
|
|
5950
|
-
| config.
|
|
5951
|
-
| config.
|
|
5952
|
-
| config.
|
|
5953
|
-
| config.
|
|
6095
|
+
| Name | Type | Description |
|
|
6096
|
+
| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6097
|
+
| config.externalIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated external IDs that the requested objects have.</p> <p>Each external ID has a maximum length of 500 characters.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
6098
|
+
| config.fields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> <i>default:</i> <code>"objectId,value"</code> |
|
|
6099
|
+
| config.filter | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 512.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
|
|
6100
|
+
| 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> |
|
|
6101
|
+
| config.pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | <p>The amount of settings objects in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 100 is used.</p> |
|
|
6102
|
+
| config.schemaIds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>scopes</strong> is required.</p> <p>To load all objects belonging to the given schema IDs leave the <strong>scopes</strong> parameter empty.</p> |
|
|
6103
|
+
| config.scopes | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>A list of comma-separated scopes, that the requested objects target.</p> <p>The selection only matches objects directly targeting the specified scopes. For example, <code>environment</code> will not match objects that target a host within environment. For more details, please see <a href="https://dt-url.net/ky03459">Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, either this parameter or <strong>schemaIds</strong> is required.</p> <p>To load all objects belonging to the given scopes leave the <strong>schemaIds</strong> parameter empty.</p> |
|
|
6104
|
+
| config.sort | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering">here</a>.</p> <p>Sorting is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code></li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp</code>)</li> </ul> <p>Note that only fields included to the response via <code>fields</code> can be used for sorting.</p> |
|
|
5954
6105
|
|
|
5955
6106
|
#### Returns
|
|
5956
6107
|
|
|
@@ -5993,10 +6144,10 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
5993
6144
|
|
|
5994
6145
|
#### Parameters
|
|
5995
6146
|
|
|
5996
|
-
| Name | Type | Description
|
|
5997
|
-
| -------------------------------- | ------------------------------------------------------------------------------- |
|
|
5998
|
-
| config.body<sup>\*required</sup> | Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>> |
|
|
5999
|
-
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. |
|
|
6147
|
+
| Name | Type | Description |
|
|
6148
|
+
| -------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6149
|
+
| config.body<sup>\*required</sup> | Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>> | |
|
|
6150
|
+
| config.validateOnly | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. <i>default:</i> <code>false</code> |
|
|
6000
6151
|
|
|
6001
6152
|
#### Returns
|
|
6002
6153
|
|
|
@@ -6698,7 +6849,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
6698
6849
|
|
|
6699
6850
|
#### Returns
|
|
6700
6851
|
|
|
6701
|
-
Success. The set of synthetic related parameters has been updated. Response doesn
|
|
6852
|
+
Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
|
|
6702
6853
|
|
|
6703
6854
|
<details>
|
|
6704
6855
|
<summary>
|
|
@@ -6831,7 +6982,7 @@ Triggers on-demand executions for synthetic monitors
|
|
|
6831
6982
|
|
|
6832
6983
|
#### Returns
|
|
6833
6984
|
|
|
6834
|
-
Success. The monitor
|
|
6985
|
+
Success. The monitor's execution response details
|
|
6835
6986
|
|
|
6836
6987
|
<details>
|
|
6837
6988
|
<summary>
|
|
@@ -7037,7 +7188,6 @@ Credentials set.
|
|
|
7037
7188
|
|
|
7038
7189
|
| Name | Type | Description |
|
|
7039
7190
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7040
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7041
7191
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7042
7192
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7043
7193
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7046,7 +7196,6 @@ Credentials set.
|
|
|
7046
7196
|
| 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). |
|
|
7047
7197
|
| 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. |
|
|
7048
7198
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7049
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7050
7199
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7051
7200
|
|
|
7052
7201
|
### AbstractSloAlertDto
|
|
@@ -7110,6 +7259,33 @@ Global configuration of ActiveGates auto-update.
|
|
|
7110
7259
|
| globalSetting<sup>\*required</sup> | ActiveGateGlobalAutoUpdateConfigGlobalSetting |
|
|
7111
7260
|
| metadata | <a href="#configurationmetadata">ConfigurationMetadata</a> |
|
|
7112
7261
|
|
|
7262
|
+
### ActiveGateGroupInfoDto
|
|
7263
|
+
|
|
7264
|
+
Metadata for each ActiveGate group.
|
|
7265
|
+
|
|
7266
|
+
| Name | Type | Description |
|
|
7267
|
+
| -------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------- |
|
|
7268
|
+
| activeGates | Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>> | ActiveGates in group. |
|
|
7269
|
+
| availableActiveGates | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Number of ActiveGates in group available for Extension. |
|
|
7270
|
+
| groupName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ActiveGate group name. |
|
|
7271
|
+
|
|
7272
|
+
### ActiveGateGroupsInfoDto
|
|
7273
|
+
|
|
7274
|
+
ActiveGate groups metadata for extensions.
|
|
7275
|
+
|
|
7276
|
+
| Name | Type | Description |
|
|
7277
|
+
| ------------------------------------- | ------------------------------------------------------------------------- | ----------------------------------- |
|
|
7278
|
+
| activeGateGroups<sup>\*required</sup> | Array<<a href="#activegategroupinfodto">ActiveGateGroupInfoDto</a>> | Metadata for each ActiveGate group. |
|
|
7279
|
+
|
|
7280
|
+
### ActiveGateInfoDto
|
|
7281
|
+
|
|
7282
|
+
ActiveGates in group.
|
|
7283
|
+
|
|
7284
|
+
| Name | Type | Description |
|
|
7285
|
+
| ------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
|
|
7286
|
+
| errors | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | List of errors if Extension cannot be run on the ActiveGate |
|
|
7287
|
+
| id | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ActiveGate ID. |
|
|
7288
|
+
|
|
7113
7289
|
### ActiveGateList
|
|
7114
7290
|
|
|
7115
7291
|
A list of ActiveGates.
|
|
@@ -7690,7 +7866,6 @@ Details of certificate credentials set.
|
|
|
7690
7866
|
|
|
7691
7867
|
| Name | Type | Description |
|
|
7692
7868
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7693
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7694
7869
|
| certificate | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Base64 encoded certificate bytes |
|
|
7695
7870
|
| certificateType | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Certificate type: PEM, PKCS12 or UNKNOWN |
|
|
7696
7871
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
@@ -7702,7 +7877,6 @@ Details of certificate credentials set.
|
|
|
7702
7877
|
| 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. |
|
|
7703
7878
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Base64 encoded password |
|
|
7704
7879
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7705
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7706
7880
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7707
7881
|
|
|
7708
7882
|
### CredentialsDetailsTokenResponseElement
|
|
@@ -7711,7 +7885,6 @@ Details of the token credentials set.
|
|
|
7711
7885
|
|
|
7712
7886
|
| Name | Type | Description |
|
|
7713
7887
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7714
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7715
7888
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7716
7889
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7717
7890
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7720,7 +7893,6 @@ Details of the token credentials set.
|
|
|
7720
7893
|
| 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). |
|
|
7721
7894
|
| 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. |
|
|
7722
7895
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7723
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7724
7896
|
| token | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text token value |
|
|
7725
7897
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7726
7898
|
|
|
@@ -7730,7 +7902,6 @@ Details of username and password credentials set.
|
|
|
7730
7902
|
|
|
7731
7903
|
| Name | Type | Description |
|
|
7732
7904
|
| ------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|
|
7733
|
-
| allowedEntities | Array<<a href="#credentialaccessdata">CredentialAccessData</a>> | The set of entities allowed to use the credential. |
|
|
7734
7905
|
| credentialUsageSummary<sup>\*required</sup> | Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>> | The list contains summary data related to the use of credentials. |
|
|
7735
7906
|
| description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | A short description of the credentials set. |
|
|
7736
7907
|
| externalVault | <a href="#externalvaultconfig">ExternalVaultConfig</a> | |
|
|
@@ -7740,7 +7911,6 @@ Details of username and password credentials set.
|
|
|
7740
7911
|
| 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. |
|
|
7741
7912
|
| password | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text password value |
|
|
7742
7913
|
| scope | AbstractCredentialsResponseElementScope | |
|
|
7743
|
-
| scopes | Array<AbstractCredentialsResponseElementScopesItem> | The set of scopes of the credentials set. |
|
|
7744
7914
|
| type<sup>\*required</sup> | AbstractCredentialsResponseElementType | |
|
|
7745
7915
|
| username | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Plain text username value |
|
|
7746
7916
|
|
|
@@ -8826,6 +8996,15 @@ The tag of a monitored entity.
|
|
|
8826
8996
|
| stringRepresentation | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The string representation of the tag. |
|
|
8827
8997
|
| value | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The value of the tag. |
|
|
8828
8998
|
|
|
8999
|
+
### MainEvent
|
|
9000
|
+
|
|
9001
|
+
The main event of a problem, determined by matching root cause entity id or first event.
|
|
9002
|
+
|
|
9003
|
+
| Name | Type | Description |
|
|
9004
|
+
| ----------- | ----------------------------------------------------------------------------- | ----------------------------- |
|
|
9005
|
+
| description | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the event. |
|
|
9006
|
+
| title | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The title of the event. |
|
|
9007
|
+
|
|
8829
9008
|
### MaintenanceWindowEvidence
|
|
8830
9009
|
|
|
8831
9010
|
The maintenance window evidence of the problem.
|
|
@@ -9135,10 +9314,12 @@ Monitoring state of the process group instance.
|
|
|
9135
9314
|
|
|
9136
9315
|
A list of entities and their monitoring states.
|
|
9137
9316
|
|
|
9138
|
-
| Name | Type | Description
|
|
9139
|
-
| ---------------- | ----------------------------------------------------------------------------- |
|
|
9140
|
-
| monitoringStates | Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>> | A list of process group instances and their monitoring states.
|
|
9141
|
-
|
|
|
9317
|
+
| Name | Type | Description |
|
|
9318
|
+
| ---------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9319
|
+
| monitoringStates | Array<<a href="#monitoredentitystates">MonitoredEntityStates</a>> | A list of process group instances and their monitoring states. |
|
|
9320
|
+
| nextPageKey | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p> |
|
|
9321
|
+
| pageSize | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The number of entries per page. |
|
|
9322
|
+
| totalCount | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The total number of entities in the response. |
|
|
9142
9323
|
|
|
9143
9324
|
### MonitoringConfigurationDto
|
|
9144
9325
|
|
|
@@ -9331,6 +9512,7 @@ The properties of a problem.
|
|
|
9331
9512
|
| impactLevel<sup>\*required</sup> | ProblemImpactLevel | |
|
|
9332
9513
|
| impactedEntities<sup>\*required</sup> | Array<<a href="#entitystub">EntityStub</a>> | A list of all entities that are impacted by the problem. |
|
|
9333
9514
|
| linkedProblemInfo | <a href="#linkedproblem">LinkedProblem</a> | |
|
|
9515
|
+
| mainEvent | <a href="#mainevent">MainEvent</a> | |
|
|
9334
9516
|
| managementZones<sup>\*required</sup> | Array<<a href="#managementzone">ManagementZone</a>> | A list of all management zones that the problem belongs to. |
|
|
9335
9517
|
| problemFilters<sup>\*required</sup> | Array<<a href="#alertingprofilestub">AlertingProfileStub</a>> | A list of alerting profiles that match the problem. |
|
|
9336
9518
|
| problemId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The ID of the problem. |
|
|
@@ -9598,6 +9780,7 @@ Detailed information of a remediation item for a security problem.
|
|
|
9598
9780
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
9599
9781
|
| remediationProgress | <a href="#remediationprogress">RemediationProgress</a> | |
|
|
9600
9782
|
| resolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | |
|
|
9783
|
+
| trackingLink | <a href="#trackinglink">TrackingLink</a> | |
|
|
9601
9784
|
| vulnerabilityState | RemediationDetailsItemVulnerabilityState | |
|
|
9602
9785
|
| vulnerableComponents | Array<<a href="#remediationitemdetailsvulnerablecomponent">RemediationItemDetailsVulnerableComponent</a>> | <p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
9603
9786
|
|
|
@@ -9615,6 +9798,7 @@ A possible remediation for a security problem.
|
|
|
9615
9798
|
| name | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | |
|
|
9616
9799
|
| remediationProgress | <a href="#remediationprogress">RemediationProgress</a> | |
|
|
9617
9800
|
| resolvedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | |
|
|
9801
|
+
| trackingLink | <a href="#trackinglink">TrackingLink</a> | |
|
|
9618
9802
|
| vulnerabilityState | RemediationItemVulnerabilityState | |
|
|
9619
9803
|
| vulnerableComponents | Array<<a href="#vulnerablecomponent">VulnerableComponent</a>> | <p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
9620
9804
|
|
|
@@ -9708,6 +9892,23 @@ Response of un-muting several remediation items.
|
|
|
9708
9892
|
| ---------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
9709
9893
|
| summary<sup>\*required</sup> | Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>> | The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
9710
9894
|
|
|
9895
|
+
### RemediationItemsBulkUpdateDeleteDto
|
|
9896
|
+
|
|
9897
|
+
Contains the external tracking link associations to be applied to the remediation items of the security problem.
|
|
9898
|
+
|
|
9899
|
+
| Name | Type | Description |
|
|
9900
|
+
| ------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9901
|
+
| deletes | Array<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>> | <p>Tracking links to remove from the security problem.</p> <p>List of remediation item IDs of the security problem for which to remove the tracking links.</p> |
|
|
9902
|
+
| updates | <a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a> | |
|
|
9903
|
+
|
|
9904
|
+
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
9905
|
+
|
|
9906
|
+
Tracking links to set for the security problem.
|
|
9907
|
+
|
|
9908
|
+
Map of remediation item ID to tracking link objects.
|
|
9909
|
+
|
|
9910
|
+
Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.
|
|
9911
|
+
|
|
9711
9912
|
### RemediationProgress
|
|
9712
9913
|
|
|
9713
9914
|
The progress of this remediation item. It contains affected and unaffected entities.
|
|
@@ -10404,16 +10605,16 @@ Metadata map for the execution batch.
|
|
|
10404
10605
|
|
|
10405
10606
|
Contains parameters for the on-demand execution of monitors identified by tags, applications, or services.
|
|
10406
10607
|
|
|
10407
|
-
| Name | Type | Description
|
|
10408
|
-
| ------------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
10409
|
-
| failOnPerformanceIssue | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the execution will fail in case of performance issue. |
|
|
10410
|
-
| failOnSslWarning | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. |
|
|
10411
|
-
| group | <a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a> |
|
|
10412
|
-
| metadata | <a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a> |
|
|
10413
|
-
| monitors | Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>> | List of monitors to be triggered.
|
|
10414
|
-
| processingMode | SyntheticOnDemandExecutionRequestProcessingMode |
|
|
10415
|
-
| stopOnProblem | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, no executions will be scheduled if a problem occurs.
|
|
10416
|
-
| takeScreenshotsOnSuccess | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the screenshots will be taken during the execution of a browser monitor.
|
|
10608
|
+
| Name | Type | Description |
|
|
10609
|
+
| ------------------------ | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
10610
|
+
| failOnPerformanceIssue | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code> |
|
|
10611
|
+
| failOnSslWarning | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code> |
|
|
10612
|
+
| group | <a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a> | |
|
|
10613
|
+
| metadata | <a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a> | |
|
|
10614
|
+
| monitors | Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>> | List of monitors to be triggered. |
|
|
10615
|
+
| processingMode | SyntheticOnDemandExecutionRequestProcessingMode | <i>default:</i> <code>"STANDARD"</code> |
|
|
10616
|
+
| stopOnProblem | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code> |
|
|
10617
|
+
| takeScreenshotsOnSuccess | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code> |
|
|
10417
10618
|
|
|
10418
10619
|
### SyntheticOnDemandExecutionRequestGroup
|
|
10419
10620
|
|
|
@@ -10434,13 +10635,13 @@ String to string map of metadata properties for execution
|
|
|
10434
10635
|
|
|
10435
10636
|
Contains monitors to be executed on demand from the locations specified.
|
|
10436
10637
|
|
|
10437
|
-
| Name | Type | Description
|
|
10438
|
-
| ------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
10439
|
-
| customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> |
|
|
10440
|
-
| 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. |
|
|
10441
|
-
| 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.
|
|
10442
|
-
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier.
|
|
10443
|
-
| repeatMode | SyntheticOnDemandExecutionRequestMonitorRepeatMode |
|
|
10638
|
+
| Name | Type | Description |
|
|
10639
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10640
|
+
| customizedScript | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | |
|
|
10641
|
+
| 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> |
|
|
10642
|
+
| 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. |
|
|
10643
|
+
| monitorId<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The monitor identifier. |
|
|
10644
|
+
| repeatMode | SyntheticOnDemandExecutionRequestMonitorRepeatMode | <i>default:</i> <code>"SEQUENTIAL"</code> |
|
|
10444
10645
|
|
|
10445
10646
|
### SyntheticOnDemandExecutionResult
|
|
10446
10647
|
|
|
@@ -10596,6 +10797,26 @@ A credentials set of the `TOKEN` type.
|
|
|
10596
10797
|
| token | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Token in the string format. |
|
|
10597
10798
|
| type | CredentialsType | |
|
|
10598
10799
|
|
|
10800
|
+
### TrackingLink
|
|
10801
|
+
|
|
10802
|
+
External tracking link URL associated with the remediable entity of the security problem.
|
|
10803
|
+
|
|
10804
|
+
| Name | Type | Description |
|
|
10805
|
+
| -------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
10806
|
+
| displayName | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Display name (title) set for the tracking link, e.g. 'ISSUE-123'. |
|
|
10807
|
+
| lastUpdatedTimestamp | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The timestamp (UTC milliseconds) of the last update of the tracking link. |
|
|
10808
|
+
| url | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | URL set for the tracking link, e.g. https://example.com/ISSUE-123 |
|
|
10809
|
+
| user | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The user who last changed the tracking link. |
|
|
10810
|
+
|
|
10811
|
+
### TrackingLinkUpdate
|
|
10812
|
+
|
|
10813
|
+
External tracking link URL association to be set for the remediable entity of the security problem.
|
|
10814
|
+
|
|
10815
|
+
| Name | Type | Description |
|
|
10816
|
+
| -------------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10817
|
+
| displayName<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The desired tracking link display name (title) set for the remediation item, e.g. 'ISSUE-123'. |
|
|
10818
|
+
| url<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <p>The desired tracking link url set for the remediation item, e.g. https://example.com/ISSUE-123</p> <p>Note that only valid URLs with 'http' or 'https' protocols are supported.</p> |
|
|
10819
|
+
|
|
10599
10820
|
### TransactionalEvidence
|
|
10600
10821
|
|
|
10601
10822
|
The transactional evidence of the problem.
|
|
@@ -10914,22 +11135,6 @@ The scope of the credentials set.
|
|
|
10914
11135
|
|
|
10915
11136
|
</div>
|
|
10916
11137
|
|
|
10917
|
-
### AbstractCredentialsResponseElementScopesItem
|
|
10918
|
-
|
|
10919
|
-
<div class="padding-left--md">
|
|
10920
|
-
|
|
10921
|
-
The set of scopes of the credentials set.
|
|
10922
|
-
|
|
10923
|
-
#### Enum keys
|
|
10924
|
-
|
|
10925
|
-
<div class="padding-left--md">
|
|
10926
|
-
|
|
10927
|
-
`All` | `Extension` | `Synthetic` | `Unknown`
|
|
10928
|
-
|
|
10929
|
-
</div>
|
|
10930
|
-
|
|
10931
|
-
</div>
|
|
10932
|
-
|
|
10933
11138
|
### AbstractCredentialsResponseElementType
|
|
10934
11139
|
|
|
10935
11140
|
<div class="padding-left--md">
|
|
@@ -11066,7 +11271,7 @@ The OS architecture that the ActiveGate is running on.
|
|
|
11066
11271
|
|
|
11067
11272
|
<div class="padding-left--md">
|
|
11068
11273
|
|
|
11069
|
-
`
|
|
11274
|
+
`S390` | `X86`
|
|
11070
11275
|
|
|
11071
11276
|
</div>
|
|
11072
11277
|
|
|
@@ -12427,7 +12632,7 @@ The name of the monitoring state.
|
|
|
12427
12632
|
|
|
12428
12633
|
<div class="padding-left--md">
|
|
12429
12634
|
|
|
12430
|
-
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
12635
|
+
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
12431
12636
|
|
|
12432
12637
|
</div>
|
|
12433
12638
|
|