@dynatrace-sdk/client-classic-environment-v2 1.13.2 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +37 -0
- package/README.md +593 -108
- package/cjs/index.js +2633 -1592
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +2647 -1602
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +38 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +75 -3
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +10 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-client-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/biz-event-ingest-result-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/client-request-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-envelope-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/invalid-response-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-array-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/validation-response-error.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log.transformation.d.ts +1 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/assessment-accuracy-details-reduced-reasons-item.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/assessment-accuracy-details-reduced-reasons-item.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/assessment-accuracy-details.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/assessment-accuracy-details.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.d.ts +1 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-event-type.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scope.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scopes-item.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scope.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scopes-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission-granted.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission-granted.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-info.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-capability.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-capability.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/history-modification-info.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/history-modification-info.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +34 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +8 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/log-records-list.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-records-list.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/management-zone-details.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/management-zone-details.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/modification-info.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/modification-info.transformation.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/modification.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/modification.transformation.d.ts +9 -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/permission-context.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/permission-context.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resource-context-operations-item.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resource-context-operations-item.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resource-context.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resource-context.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff-page.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff-page.transformation.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff-type.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +34 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.transformation.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.d.ts +11 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.transformation.d.ts +5 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-technology.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.d.ts +72 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.transformation.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/single-permission-request.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/single-permission-request.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto-aggregation.d.ts +1 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +8 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.transformation.d.ts +1 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.0.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -1770,6 +1770,15 @@ The ingestion of business events is subject to licensing (see [licensing documen
|
|
|
1770
1770
|
</div>
|
|
1771
1771
|
|
|
1772
1772
|
|
|
1773
|
+
#### Parameters
|
|
1774
|
+
|
|
1775
|
+
| Name | Type |
|
|
1776
|
+
| --- | --- |
|
|
1777
|
+
|config.body<sup>*required</sup>|<a href="#cloudevent">CloudEvent</a> | Array<<a href="#cloudevent" target="_blank" rel="noopener noreferrer">CloudEvent</a>> | IngestBody|
|
|
1778
|
+
|config.type<sup>*required</sup>|"application/cloudevent+json" | "application/cloudevents+json" | "application/cloudevent-batch+json" | "application/cloudevents-batch+json" | "application/json; charset=utf-8"|
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
|
|
1773
1782
|
|
|
1774
1783
|
#### Returns
|
|
1775
1784
|
|
|
@@ -1865,7 +1874,7 @@ import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment
|
|
|
1865
1874
|
const data = await credentialVaultClient.createCredentials({
|
|
1866
1875
|
body: {
|
|
1867
1876
|
name: "...",
|
|
1868
|
-
scopes: [CredentialsScopesItem.
|
|
1877
|
+
scopes: [CredentialsScopesItem.AppEngine],
|
|
1869
1878
|
},
|
|
1870
1879
|
});
|
|
1871
1880
|
```
|
|
@@ -2139,7 +2148,7 @@ const data = await credentialVaultClient.updateCredentials({
|
|
|
2139
2148
|
id: "...",
|
|
2140
2149
|
body: {
|
|
2141
2150
|
name: "...",
|
|
2142
|
-
scopes: [CredentialsScopesItem.
|
|
2151
|
+
scopes: [CredentialsScopesItem.AppEngine],
|
|
2143
2152
|
},
|
|
2144
2153
|
});
|
|
2145
2154
|
```
|
|
@@ -2565,7 +2574,7 @@ Lists events within the specified timeframe
|
|
|
2565
2574
|
| Name | Type | Description |
|
|
2566
2575
|
| --- | --- | --- |
|
|
2567
2576
|
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The entity scope of the query. You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&quot;value&quot;)</code></li> <li>Entity name: <ul> <li><code>entityName.equals</code>: performs a non-casesensitive <code>EQUALS</code> query.</li> <li><code>entityName.startsWith</code>: changes the operator to <code>BEGINS WITH</code>.</li> <li><code>entityName.in</code>: enables you to provide multiple values. The <code>EQUALS</code> operator applies.</li> <li><code>caseSensitive(entityName.equals(&quot;value&quot;))</code>: takes any entity name criterion as an argument and makes the value case-sensitive.</li> </ul> </li> <li>Health state (HEALTHY,UNHEALTHY): <code>healthState(&quot;HEALTHY&quot;)</code></li> <li>First seen timestamp: <code>firstSeenTms.&lt;operator&gt;(now-3h)</code>. Use any timestamp format from the <strong>from</strong> /<strong>to</strong> parameters. The following operators are available: <ul> <li><code>lte</code>: earlier than or at the specified time</li> <li><code>lt</code>: earlier than the specified time</li> <li><code>gte</code>: later than or at the specified time</li> <li><code>gt</code>: later than the specified time</li> </ul> </li> <li>Entity attribute: <code>&lt;attribute&gt;(&quot;value1&quot;,&quot;value2&quot;)</code> and <code>&lt;attribute&gt;.exists()</code>. To fetch the list of available attributes, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>properties</strong> field of the response.</li> <li>Relationships: <code>fromRelationships.&lt;relationshipName&gt;()</code> and <code>toRelationships.&lt;relationshipName&gt;()</code>. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the <a href="https://dt-url.net/2ka3ivt" target="_blank" rel="noopener noreferrer" >GET entity type</a> request and check the <strong>fromRelationships</strong> and <strong>toRelationships</strong> fields.</li> <li>Negation: <code>not(&lt;criterion&gt;)</code>. Inverts any criterion except for <strong>type</strong>.</li> </ul> <p>For more information, see <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >Entity selector</a> in Dynatrace Documentation.</p> <p>To set several criteria, separate them with a comma (<code>,</code>). For example, <code>type(&quot;HOST&quot;),healthState(&quot;HEALTHY&quot;)</code>. Only results matching <strong>all</strong> criteria are included in the response.</p> <p>The maximum string length is 2,000 characters.</p> <p>The number of entities that can be selected is limited to 10000.</p> |
|
|
2568
|
-
|config.eventSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only events matching the specified criteria are included in the response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Event ID: <code>eventId("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w" target="_blank" rel="noopener noreferrer" >GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code
|
|
2577
|
+
|config.eventSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only events matching the specified criteria are included in the response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Event ID: <code>eventId("id-1", "id-2")</code>.</li> <li>ID of related entity: <code>entityId("id-1", "id-2")</code>.</li> <li>Event status: <code>status("OPEN")</code> or <code>status("CLOSED")</code>. You can specify only one status.</li> <li>Management zone ID: <code>managementZoneId("123", "321")</code>.</li> <li>Event type: <code>eventType("event-type")</code>. You can specify only one event type. You can fetch the list of possible event types with the <a href="https://dt-url.net/qc03u6w" target="_blank" rel="noopener noreferrer" >GET event types</a> call.</li> <li>Correlation ID: <code>correlationId("id-1", "id-2")</code>.</li> <li>Happened during maintenance (true, false): <code>underMaintenance(true)</code>.</li> <li>Notifications are suppressed (true, false): <code>suppressAlert(true)</code>.</li> <li>Problem creation is suppressed (true, false): <code>suppressProblem(true)</code>.</li> <li>Frequent event (true, false): <code>frequentEvent(true)</code>.</li> <li>Event property: <code>property.<key>("value-1", "value-2")</code>. Only properties with the <strong>filterable</strong> property set to <code>true</code> can be used. You can check event properties via the <a href="https://dt-url.net/es03nwo" target="_blank" rel="noopener noreferrer" >GET event properties</a> call.</li> </ul> <p>To set several criteria, separate them with commas (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
2569
2578
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two hours is used (<code>now-2h</code>).</p> |
|
|
2570
2579
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
2571
2580
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of events in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
|
|
@@ -4412,6 +4421,15 @@ Unique log data attributes (high-cardinality attributes) such as `span_id` and `
|
|
|
4412
4421
|
</div>
|
|
4413
4422
|
|
|
4414
4423
|
|
|
4424
|
+
#### Parameters
|
|
4425
|
+
|
|
4426
|
+
| Name | Type |
|
|
4427
|
+
| --- | --- |
|
|
4428
|
+
|config.body<sup>*required</sup>|LogMessageJson | LogMessagePlain|
|
|
4429
|
+
|config.type<sup>*required</sup>|"application/json" | "application/json; charset=utf-8" | "text/plain; charset=utf-8"|
|
|
4430
|
+
|
|
4431
|
+
|
|
4432
|
+
|
|
4415
4433
|
|
|
4416
4434
|
#### Returns
|
|
4417
4435
|
|
|
@@ -6909,6 +6927,7 @@ Gets parameters of a security problem
|
|
|
6909
6927
|
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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>remediationDescription</code>: Description of how to remediate 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> |
|
|
6910
6928
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
6911
6929
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
6930
|
+
|config.managementZoneFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the <strong>OR</strong> logic applies. All values are case-sensitive and must be quoted.</p> <ul> <li>Management zone ID: ids("mzId-1", "mzId-2").</li> <li>Management zone names: names("mz-1", "mz-2").</li> </ul> <p>You can specify several comma-separated criteria (for example, <code>names("myMz"),ids("9130632296508575249")</code>).</p> |
|
|
6912
6931
|
|
|
6913
6932
|
|
|
6914
6933
|
|
|
@@ -7617,6 +7636,71 @@ const data =
|
|
|
7617
7636
|
|
|
7618
7637
|
|
|
7619
7638
|
|
|
7639
|
+
</div>
|
|
7640
|
+
|
|
7641
|
+
## settingsManagementZonesClient
|
|
7642
|
+
|
|
7643
|
+
```js
|
|
7644
|
+
import { settingsManagementZonesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
7645
|
+
```
|
|
7646
|
+
|
|
7647
|
+
|
|
7648
|
+
<a name="getmanagementzonedetails"></a>
|
|
7649
|
+
### getManagementZoneDetails
|
|
7650
|
+
|
|
7651
|
+
<div class="padding-bottom--md">
|
|
7652
|
+
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails">ManagementZoneDetails</a>></strong>
|
|
7653
|
+
|
|
7654
|
+
<div class="padding-left--md">
|
|
7655
|
+
|
|
7656
|
+
Reads management zone details.
|
|
7657
|
+
|
|
7658
|
+
**Required scope:** settings:objects:read
|
|
7659
|
+
**One of the following permissions is required:**
|
|
7660
|
+
+ environment:roles:manage-settings
|
|
7661
|
+
+ settings:objects:read
|
|
7662
|
+
|
|
7663
|
+
|
|
7664
|
+
|
|
7665
|
+
Allows to convert from an objectId to the ID of the management zone, and can serve as a replacement for the old config endpoint for that purpose.
|
|
7666
|
+
|
|
7667
|
+
|
|
7668
|
+
|
|
7669
|
+
</div>
|
|
7670
|
+
|
|
7671
|
+
|
|
7672
|
+
#### Parameters
|
|
7673
|
+
|
|
7674
|
+
| Name | Type | Description |
|
|
7675
|
+
| --- | --- | --- |
|
|
7676
|
+
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
7677
|
+
|
|
7678
|
+
|
|
7679
|
+
|
|
7680
|
+
|
|
7681
|
+
#### Returns
|
|
7682
|
+
|
|
7683
|
+
Success
|
|
7684
|
+
|
|
7685
|
+
|
|
7686
|
+
<details>
|
|
7687
|
+
<summary>
|
|
7688
|
+
Code example
|
|
7689
|
+
</summary>
|
|
7690
|
+
|
|
7691
|
+
```ts
|
|
7692
|
+
import { settingsManagementZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7693
|
+
|
|
7694
|
+
const data =
|
|
7695
|
+
await settingsManagementZonesClient.getManagementZoneDetails(
|
|
7696
|
+
{ objectId: "..." },
|
|
7697
|
+
);
|
|
7698
|
+
```
|
|
7699
|
+
|
|
7700
|
+
</details>
|
|
7701
|
+
|
|
7702
|
+
|
|
7703
|
+
|
|
7620
7704
|
</div>
|
|
7621
7705
|
|
|
7622
7706
|
## settingsObjectsClient
|
|
@@ -7682,7 +7766,7 @@ const data =
|
|
|
7682
7766
|
### getEffectiveSettingsValues
|
|
7683
7767
|
|
|
7684
7768
|
<div class="padding-bottom--md">
|
|
7685
|
-
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist">EffectiveSettingsValuesList</a>></strong>
|
|
7769
|
+
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist" target="_blank" rel="noopener noreferrer">EffectiveSettingsValuesList</a>></strong>
|
|
7686
7770
|
|
|
7687
7771
|
<div class="padding-left--md">
|
|
7688
7772
|
|
|
@@ -7740,6 +7824,65 @@ const data =
|
|
|
7740
7824
|
|
|
7741
7825
|
|
|
7742
7826
|
|
|
7827
|
+
</div>
|
|
7828
|
+
|
|
7829
|
+
|
|
7830
|
+
<a name="getsettingshistory"></a>
|
|
7831
|
+
### getSettingsHistory
|
|
7832
|
+
|
|
7833
|
+
<div class="padding-bottom--md">
|
|
7834
|
+
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage">RevisionDiffPage</a>></strong>
|
|
7835
|
+
|
|
7836
|
+
<div class="padding-left--md">
|
|
7837
|
+
|
|
7838
|
+
Gets the history of settings objects
|
|
7839
|
+
|
|
7840
|
+
**Required scope:** settings:objects:read
|
|
7841
|
+
**One of the following permissions is required:**
|
|
7842
|
+
+ environment:roles:manage-settings
|
|
7843
|
+
+ settings:objects:read
|
|
7844
|
+
|
|
7845
|
+
|
|
7846
|
+
|
|
7847
|
+
</div>
|
|
7848
|
+
|
|
7849
|
+
|
|
7850
|
+
#### Parameters
|
|
7851
|
+
|
|
7852
|
+
| Name | Type | Description |
|
|
7853
|
+
| --- | --- | --- |
|
|
7854
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, <strong>revision,modificationInfo</strong>). Supported fields: <strong>revision</strong>, <strong>jsonPatch</strong>, <strong>jsonBefore</strong>, <strong>jsonAfter</strong>, <strong>objectId</strong>, <strong>type</strong>, <strong>schemaVersion</strong>, <strong>modificationInfo</strong>.(optional, default to revision, modificationInfo) |
|
|
7855
|
+
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Filtering is supported on the following fields: \* <code>objectId</code> \* <code>modificationInfo.lastModifiedTime</code>, and the fields can only be combined with <code>and</code> as a boolean operator. If this parameter is omitted or does not include a range for <strong>modificationInfo.lastModifiedTime</strong>, only revisions of the last 2 weeks are returned. (optional) |
|
|
7856
|
+
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
7857
|
+
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<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> |
|
|
7858
|
+
|config.schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Schema ID to which the requested revisions belong. |
|
|
7859
|
+
|config.scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The scope that the requested history objects target.</p> <p>The selection only matches revisions 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" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>.</p> <p>To load the first page, when the <strong>nextPageKey</strong> is not set, this parameter is required.</p> |
|
|
7860
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The sort parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>. Sorting is supported on the following fields: \* <code>modificationInfo.lastModifiedTime</code> (optional, default to -modificationInfo.lastModifiedTime) |
|
|
7861
|
+
|
|
7862
|
+
|
|
7863
|
+
|
|
7864
|
+
|
|
7865
|
+
#### Returns
|
|
7866
|
+
|
|
7867
|
+
Success
|
|
7868
|
+
|
|
7869
|
+
|
|
7870
|
+
<details>
|
|
7871
|
+
<summary>
|
|
7872
|
+
Code example
|
|
7873
|
+
</summary>
|
|
7874
|
+
|
|
7875
|
+
```ts
|
|
7876
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
7877
|
+
|
|
7878
|
+
const data =
|
|
7879
|
+
await settingsObjectsClient.getSettingsHistory();
|
|
7880
|
+
```
|
|
7881
|
+
|
|
7882
|
+
</details>
|
|
7883
|
+
|
|
7884
|
+
|
|
7885
|
+
|
|
7743
7886
|
</div>
|
|
7744
7887
|
|
|
7745
7888
|
|
|
@@ -7747,7 +7890,7 @@ const data =
|
|
|
7747
7890
|
### getSettingsObjectByObjectId
|
|
7748
7891
|
|
|
7749
7892
|
<div class="padding-bottom--md">
|
|
7750
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#
|
|
7893
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse" target="_blank" rel="noopener noreferrer">SettingsObjectByObjectIdResponse</a>></strong>
|
|
7751
7894
|
|
|
7752
7895
|
<div class="padding-left--md">
|
|
7753
7896
|
|
|
@@ -7831,7 +7974,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
7831
7974
|
| Name | Type | Description |
|
|
7832
7975
|
| --- | --- | --- |
|
|
7833
7976
|
|config.externalIds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
7834
|
-
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
7977
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> (deprecated), <code>resourceContext</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
7835
7978
|
|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href="https://dt-url.net/platform-services-filtering" target="_blank" rel="noopener noreferrer" >here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>created</code></li> <li><code>modified</code></li> <li><code>createdBy</code></li> <li><code>modifiedBy</code></li> <li><code>author</code> (deprecated, will not work for future schemas)</li> <li><code>value</code> with properties and sub-properties separated by dot (for example, <code>value.owningApp = 'Notebooks'</code>)</li> </ul> <p>If this parameter is omitted, all settings objects will be returned. The maximum nesting depth (via parentheses) is 5. The maximum expression length is 1024 characters.</p> <p>Note that only fields included to the response via <code>fields</code> can be used for filtering.</p> |
|
|
7836
7979
|
|config.nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
7837
7980
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<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> |
|
|
@@ -7994,6 +8137,66 @@ const data =
|
|
|
7994
8137
|
|
|
7995
8138
|
|
|
7996
8139
|
|
|
8140
|
+
</div>
|
|
8141
|
+
|
|
8142
|
+
|
|
8143
|
+
<a name="resolveeffectivepermissions"></a>
|
|
8144
|
+
### resolveEffectivePermissions
|
|
8145
|
+
|
|
8146
|
+
<div class="padding-bottom--md">
|
|
8147
|
+
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission" target="_blank" rel="noopener noreferrer">EffectivePermission</a>>></strong>
|
|
8148
|
+
|
|
8149
|
+
<div class="padding-left--md">
|
|
8150
|
+
|
|
8151
|
+
Get the effective settings permissions of the calling user in the environment
|
|
8152
|
+
|
|
8153
|
+
**One of the following scopes is required:**
|
|
8154
|
+
+ settings:objects:write
|
|
8155
|
+
+ settings:objects:read
|
|
8156
|
+
+ settings:schemas:read
|
|
8157
|
+
|
|
8158
|
+
|
|
8159
|
+
**One of the following permissions is required:**
|
|
8160
|
+
+ environment:roles:viewer
|
|
8161
|
+
+ settings:schemas:read
|
|
8162
|
+
|
|
8163
|
+
|
|
8164
|
+
|
|
8165
|
+
</div>
|
|
8166
|
+
|
|
8167
|
+
|
|
8168
|
+
#### Parameters
|
|
8169
|
+
|
|
8170
|
+
| Name | Type |
|
|
8171
|
+
| --- | --- |
|
|
8172
|
+
|config.body<sup>*required</sup>|<a href="#resolutionrequest">ResolutionRequest</a>|
|
|
8173
|
+
|
|
8174
|
+
|
|
8175
|
+
|
|
8176
|
+
|
|
8177
|
+
#### Returns
|
|
8178
|
+
|
|
8179
|
+
Success
|
|
8180
|
+
|
|
8181
|
+
|
|
8182
|
+
<details>
|
|
8183
|
+
<summary>
|
|
8184
|
+
Code example
|
|
8185
|
+
</summary>
|
|
8186
|
+
|
|
8187
|
+
```ts
|
|
8188
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8189
|
+
|
|
8190
|
+
const data =
|
|
8191
|
+
await settingsObjectsClient.resolveEffectivePermissions({
|
|
8192
|
+
body: {},
|
|
8193
|
+
});
|
|
8194
|
+
```
|
|
8195
|
+
|
|
8196
|
+
</details>
|
|
8197
|
+
|
|
8198
|
+
|
|
8199
|
+
|
|
7997
8200
|
</div>
|
|
7998
8201
|
|
|
7999
8202
|
## settingsSchemasClient
|
|
@@ -8007,7 +8210,7 @@ import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
8007
8210
|
### getAvailableSchemaDefinitions
|
|
8008
8211
|
|
|
8009
8212
|
<div class="padding-bottom--md">
|
|
8010
|
-
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(
|
|
8213
|
+
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist" target="_blank" rel="noopener noreferrer">SchemaList</a>></strong>
|
|
8011
8214
|
|
|
8012
8215
|
<div class="padding-left--md">
|
|
8013
8216
|
|
|
@@ -8023,6 +8226,14 @@ Lists available settings schemas
|
|
|
8023
8226
|
</div>
|
|
8024
8227
|
|
|
8025
8228
|
|
|
8229
|
+
#### Parameters
|
|
8230
|
+
|
|
8231
|
+
| Name | Type | Description |
|
|
8232
|
+
| --- | --- | --- |
|
|
8233
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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>schemaId,displayName</code>).</p> <p>Supported fields: <code>schemaId</code>, <code>displayName</code>, <code>latestSchemaVersion</code>, <code>multiObject</code>, <code>ordered</code>.</p> |
|
|
8234
|
+
|
|
8235
|
+
|
|
8236
|
+
|
|
8026
8237
|
|
|
8027
8238
|
#### Returns
|
|
8028
8239
|
|
|
@@ -8513,6 +8724,7 @@ Lists all synthetic locations (both public and private) available for your envir
|
|
|
8513
8724
|
|
|
8514
8725
|
| Name | Type | Description |
|
|
8515
8726
|
| --- | --- | --- |
|
|
8727
|
+
|config.capability|GetLocationsQueryCapability|Filters the resulting set of locations to those which support specific capability. |
|
|
8516
8728
|
|config.cloudPlatform|GetLocationsQueryCloudPlatform|Filters the resulting set of locations to those which are hosted on a specific cloud platform. |
|
|
8517
8729
|
|config.type|GetLocationsQueryType|Filters the resulting set of locations to those of a specific type. |
|
|
8518
8730
|
|
|
@@ -9068,7 +9280,7 @@ Gets all synthetic monitors. Currently network availability monitors only. | mat
|
|
|
9068
9280
|
|
|
9069
9281
|
| Name | Type | Description |
|
|
9070
9282
|
| --- | --- | --- |
|
|
9071
|
-
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor
|
|
9283
|
+
|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching the specified criteria are included into response.</p> <p>You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,MULTI_PROTOCOL)</code>. Possible values: 'HTTP', 'BROWSER', 'THIRD_PARTY', 'MULTI_PROTOCOL' (Note that only 'MULTI_PROTOCOL' is currently supported).</li> <li>Management zone ID: <code>managementZoneId(1, 2)</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored host ME ID: <code>monitoredEntity(HOST-123)</code>.</li> <li>Monitor tags: <code>tag([context]key:value,key:value,key)</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash(<code>\\</code>). Otherwise, the tag will be parsed as a <code>key:value tag</code>. All tag values are case-sensitive.</li> <li>Monitor enablement: <code>enabled(true)</code>.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>). Only results matching <strong>all</strong> criteria are included in the response.</p> |
|
|
9072
9284
|
|
|
9073
9285
|
|
|
9074
9286
|
|
|
@@ -9622,7 +9834,7 @@ Parameters of a new ActiveGate token.
|
|
|
9622
9834
|
| Name | Type | Description |
|
|
9623
9835
|
| --- | --- | --- |
|
|
9624
9836
|
|activeGateType<sup>*required</sup>|ActiveGateTokenCreateActiveGateType| |
|
|
9625
|
-
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> |
|
|
9837
|
+
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> <p>Ensure that it is not set in the past and does not exceed <code>2 years</code> from the moment of creation."</p> |
|
|
9626
9838
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9627
9839
|
|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a seed token (<code>true</code>) or an individual token (<code>false</code>).</p> <p>We recommend the individual token option (false).</p> |
|
|
9628
9840
|
|
|
@@ -9732,9 +9944,10 @@ Information about an affected entity.
|
|
|
9732
9944
|
|
|
9733
9945
|
Aggregated log records.
|
|
9734
9946
|
|
|
9735
|
-
| Name | Type |
|
|
9736
|
-
| --- | --- |
|
|
9737
|
-
|aggregationResult|<a href="#aggregatedlogaggregationresult" target="_blank" rel="noopener noreferrer">AggregatedLogAggregationResult</a>|
|
|
9947
|
+
| Name | Type | Description |
|
|
9948
|
+
| --- | --- | --- |
|
|
9949
|
+
|aggregationResult|<a href="#aggregatedlogaggregationresult" target="_blank" rel="noopener noreferrer">AggregatedLogAggregationResult</a>| |
|
|
9950
|
+
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
9738
9951
|
|
|
9739
9952
|
### AggregatedLogAggregationResult
|
|
9740
9953
|
**type**: Record<string, object | undefined>
|
|
@@ -9789,7 +10002,7 @@ Parameters of a new API token.
|
|
|
9789
10002
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires. Ensure that the expiration date is not set in the past.</p> |
|
|
9790
10003
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9791
10004
|
|personalAccessToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a personal access token (<code>true</code>) or an API token (<code>false</code>).</p> <p>Personal access tokens are tied to the permissions of their owner.</p> |
|
|
9792
|
-
|scopes<sup>*required</sup>|Array<ApiTokenCreateScopesItem>|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
10005
|
+
|scopes<sup>*required</sup>|Array<ApiTokenCreateScopesItem>|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Events, Software Development Lifecycle.</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Events, Software Development Lifecycle (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9793
10006
|
|
|
9794
10007
|
### ApiTokenCreated
|
|
9795
10008
|
|
|
@@ -9840,7 +10053,7 @@ The update of the API token.
|
|
|
9840
10053
|
| --- | --- | --- |
|
|
9841
10054
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
9842
10055
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9843
|
-
|scopes|Array<ApiTokenUpdateScopesItem>|<p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
10056
|
+
|scopes|Array<ApiTokenUpdateScopesItem>|<p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>openpipeline.events_sdlc</code>: OpenPipeline - Ingest Events, Software Development Lifecycle.</li> <li><code>openpipeline.events_sdlc.custom</code>: OpenPipeline - Ingest Events, Software Development Lifecycle (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>rumCookieNames.read</code>: Read RUM cookie names.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9844
10057
|
|
|
9845
10058
|
### ApplicationImpact
|
|
9846
10059
|
|
|
@@ -9867,6 +10080,17 @@ Optional filters that took effect.
|
|
|
9867
10080
|
|appliedTo<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The keys of all metrics that this filter has been applied to.</p> <p>Can contain multiple metrics for complex expressions and always at least one key.</p> |
|
|
9868
10081
|
|filter|<a href="#filter">Filter</a>| |
|
|
9869
10082
|
|
|
10083
|
+
### AssessmentAccuracyDetails
|
|
10084
|
+
|
|
10085
|
+
|
|
10086
|
+
|
|
10087
|
+
|
|
10088
|
+
The assessment accuracy details.
|
|
10089
|
+
|
|
10090
|
+
| Name | Type | Description |
|
|
10091
|
+
| --- | --- | --- |
|
|
10092
|
+
|reducedReasons|Array<AssessmentAccuracyDetailsReducedReasonsItem>|The reasons for a reduced assessment accuracy. |
|
|
10093
|
+
|
|
9870
10094
|
### AssetInfo
|
|
9871
10095
|
|
|
9872
10096
|
|
|
@@ -10264,7 +10488,7 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
10264
10488
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
10265
10489
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (Base64 encoded). |
|
|
10266
10490
|
|scope|CredentialsScope| |
|
|
10267
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
10491
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10268
10492
|
|type|CredentialsType| |
|
|
10269
10493
|
|
|
10270
10494
|
### CloudEvent
|
|
@@ -10472,7 +10696,7 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
10472
10696
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10473
10697
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
10474
10698
|
|scope|CredentialsScope| |
|
|
10475
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
10699
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10476
10700
|
|type|CredentialsType| |
|
|
10477
10701
|
|
|
10478
10702
|
### CredentialsDetailsCertificateResponseElement
|
|
@@ -10822,6 +11046,18 @@ A constraint on the values that are going to be deleted.
|
|
|
10822
11046
|
|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
|
|
10823
11047
|
|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
|
|
10824
11048
|
|
|
11049
|
+
### EffectivePermission
|
|
11050
|
+
|
|
11051
|
+
|
|
11052
|
+
|
|
11053
|
+
|
|
11054
|
+
|
|
11055
|
+
|
|
11056
|
+
| Name | Type |
|
|
11057
|
+
| --- | --- |
|
|
11058
|
+
|granted|EffectivePermissionGranted|
|
|
11059
|
+
|permission|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11060
|
+
|
|
10825
11061
|
### EffectiveSettingsValue
|
|
10826
11062
|
|
|
10827
11063
|
|
|
@@ -11269,6 +11505,7 @@ Configuration of an event property.
|
|
|
11269
11505
|
| --- | --- | --- |
|
|
11270
11506
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the event property. |
|
|
11271
11507
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the event property. |
|
|
11508
|
+
|filterable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The property can (<code>true</code>) or cannot (<code>false</code>) be used for filtering in the event selector. Usage in event selector: <code>property.<key>("value-1", "value-2")</code></p> |
|
|
11272
11509
|
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the event property. |
|
|
11273
11510
|
|writable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The property can (<code>true</code>) or cannot (<code>false</code>) be set during event ingestion. |
|
|
11274
11511
|
|
|
@@ -11431,6 +11668,7 @@ A list of exported log records.
|
|
|
11431
11668
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
11432
11669
|
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records. |
|
|
11433
11670
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
11671
|
+
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
11434
11672
|
|
|
11435
11673
|
### Extension
|
|
11436
11674
|
|
|
@@ -11521,7 +11759,7 @@ A list of extensions with additional metadata.
|
|
|
11521
11759
|
|
|
11522
11760
|
| Name | Type | Description |
|
|
11523
11761
|
| --- | --- | --- |
|
|
11524
|
-
|activeVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active version in the environment (null if none is active) |
|
|
11762
|
+
|activeVersion|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active version in the environment (null if none is active) |
|
|
11525
11763
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
11526
11764
|
|keywords<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Extension keywords for the highest version |
|
|
11527
11765
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Highest installed version |
|
|
@@ -11834,6 +12072,18 @@ Configuration for external vault synchronization for username and password crede
|
|
|
11834
12072
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11835
12073
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11836
12074
|
|
|
12075
|
+
### HistoryModificationInfo
|
|
12076
|
+
|
|
12077
|
+
|
|
12078
|
+
|
|
12079
|
+
|
|
12080
|
+
Modification information about the setting.
|
|
12081
|
+
|
|
12082
|
+
| Name | Type | Description |
|
|
12083
|
+
| --- | --- | --- |
|
|
12084
|
+
|lastModifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
12085
|
+
|lastModifiedTime<sup>*required</sup>|Date|Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
|
|
12086
|
+
|
|
11837
12087
|
### HttpProtocolDetails
|
|
11838
12088
|
|
|
11839
12089
|
|
|
@@ -11968,6 +12218,7 @@ A synthetic location.
|
|
|
11968
12218
|
|
|
11969
12219
|
| Name | Type | Description |
|
|
11970
12220
|
| --- | --- | --- |
|
|
12221
|
+
|capabilities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of location's capabilities. |
|
|
11971
12222
|
|cloudPlatform|LocationCollectionElementCloudPlatform| |
|
|
11972
12223
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the location. |
|
|
11973
12224
|
|geoCity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location's city. |
|
|
@@ -12029,6 +12280,7 @@ A list of retrieved log records.
|
|
|
12029
12280
|
|nextSliceKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next slice of log records. Always null on <em>Log Management and Analytics, powered by Grail</em>. |
|
|
12030
12281
|
|results|Array<<a href="#logrecord" target="_blank" rel="noopener noreferrer">LogRecord</a>>|A list of retrieved log records. |
|
|
12031
12282
|
|sliceSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of records in a slice. |
|
|
12283
|
+
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
12032
12284
|
|
|
12033
12285
|
### METag
|
|
12034
12286
|
|
|
@@ -12076,6 +12328,17 @@ A short representation of a management zone.
|
|
|
12076
12328
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the management zone. |
|
|
12077
12329
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the management zone. |
|
|
12078
12330
|
|
|
12331
|
+
### ManagementZoneDetails
|
|
12332
|
+
|
|
12333
|
+
|
|
12334
|
+
|
|
12335
|
+
|
|
12336
|
+
The details of the management zone.
|
|
12337
|
+
|
|
12338
|
+
| Name | Type | Description |
|
|
12339
|
+
| --- | --- | --- |
|
|
12340
|
+
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the management zone. |
|
|
12341
|
+
|
|
12079
12342
|
### MetricData
|
|
12080
12343
|
|
|
12081
12344
|
|
|
@@ -12327,21 +12590,35 @@ Analysis of problem impact to a mobile application.
|
|
|
12327
12590
|
|impactType<sup>*required</sup>|ImpactImpactType| |
|
|
12328
12591
|
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
12329
12592
|
|
|
12593
|
+
### Modification
|
|
12594
|
+
|
|
12595
|
+
|
|
12596
|
+
|
|
12597
|
+
|
|
12598
|
+
The additional modification details for this settings object.
|
|
12599
|
+
|
|
12600
|
+
| Name | Type | Description |
|
|
12601
|
+
| --- | --- | --- |
|
|
12602
|
+
|first|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list). |
|
|
12603
|
+
|modifiablePaths<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are modifiable, regardless if the <code>write</code> operation is allowed. |
|
|
12604
|
+
|movable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings object can be moved/reordered. Only applicable for ordered list schema. |
|
|
12605
|
+
|nonModifiablePaths<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are not modifiable, even if the <code>write</code> operation is allowed. |
|
|
12606
|
+
|
|
12330
12607
|
### ModificationInfo
|
|
12331
12608
|
|
|
12332
12609
|
|
|
12333
12610
|
|
|
12334
12611
|
|
|
12335
|
-
The modification info for a single updatable setting.
|
|
12612
|
+
The modification info for a single updatable setting. Replaced by `resourceContext`.
|
|
12336
12613
|
|
|
12337
12614
|
| Name | Type | Description |
|
|
12338
12615
|
| --- | --- | --- |
|
|
12339
|
-
|deletable
|
|
12616
|
+
|deletable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings value can be deleted |
|
|
12340
12617
|
|first|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If non-moveable settings value is in the first group of non-moveable settings, or in the last (start or end of list) |
|
|
12341
|
-
|modifiable
|
|
12342
|
-
|modifiablePaths
|
|
12343
|
-
|movable
|
|
12344
|
-
|nonModifiablePaths
|
|
12618
|
+
|modifiable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings value can be modified |
|
|
12619
|
+
|modifiablePaths<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are modifiable, regardless of the state of <code>modifiable</code> |
|
|
12620
|
+
|movable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings value can be moved/reordered. Only applicable for ordered list schema |
|
|
12621
|
+
|nonModifiablePaths<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are not modifiable, when <code>modifiable</code> is true |
|
|
12345
12622
|
|
|
12346
12623
|
### MonitorEntityIdDto
|
|
12347
12624
|
|
|
@@ -12638,6 +12915,18 @@ A list of settings objects.
|
|
|
12638
12915
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
12639
12916
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
12640
12917
|
|
|
12918
|
+
### PermissionContext
|
|
12919
|
+
|
|
12920
|
+
|
|
12921
|
+
|
|
12922
|
+
|
|
12923
|
+
Optional context data
|
|
12924
|
+
|
|
12925
|
+
| Name | Type | Description |
|
|
12926
|
+
| --- | --- | --- |
|
|
12927
|
+
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Settings schema id for conditional permission |
|
|
12928
|
+
|scope<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Settings scope for conditional permission |
|
|
12929
|
+
|
|
12641
12930
|
### Precondition
|
|
12642
12931
|
|
|
12643
12932
|
|
|
@@ -12703,6 +12992,9 @@ The properties of a problem.
|
|
|
12703
12992
|
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>| |
|
|
12704
12993
|
|impactLevel<sup>*required</sup>|ProblemImpactLevel| |
|
|
12705
12994
|
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are impacted by the problem. |
|
|
12995
|
+
|k8s.cluster.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster names. |
|
|
12996
|
+
|k8s.cluster.uid|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster UIDs. |
|
|
12997
|
+
|k8s.namespace.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes namespace names. |
|
|
12706
12998
|
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>| |
|
|
12707
12999
|
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
12708
13000
|
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub" target="_blank" rel="noopener noreferrer">AlertingProfileStub</a>>|A list of alerting profiles that match the problem. |
|
|
@@ -12834,7 +13126,7 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
12834
13126
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
12835
13127
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (not supported). |
|
|
12836
13128
|
|scope|CredentialsScope| |
|
|
12837
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
13129
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
12838
13130
|
|type|CredentialsType| |
|
|
12839
13131
|
|
|
12840
13132
|
### PublicSyntheticLocation
|
|
@@ -13042,14 +13334,15 @@ Assessment of the remediation item.
|
|
|
13042
13334
|
| Name | Type | Description |
|
|
13043
13335
|
| --- | --- | --- |
|
|
13044
13336
|
|assessmentAccuracy|RemediationAssessmentAssessmentAccuracy| |
|
|
13337
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13045
13338
|
|dataAssets|RemediationAssessmentDataAssets| |
|
|
13046
13339
|
|exposure|RemediationAssessmentExposure| |
|
|
13047
13340
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets. |
|
|
13048
13341
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13049
13342
|
|vulnerableFunctionUsage|RemediationAssessmentVulnerableFunctionUsage| |
|
|
13050
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction"
|
|
13051
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13052
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction"
|
|
13343
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13344
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13345
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
13053
13346
|
|
|
13054
13347
|
### RemediationDetailsItem
|
|
13055
13348
|
|
|
@@ -13060,17 +13353,17 @@ Detailed information of a remediation item for a security problem.
|
|
|
13060
13353
|
|
|
13061
13354
|
| Name | Type | Description |
|
|
13062
13355
|
| --- | --- | --- |
|
|
13063
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>| |
|
|
13356
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>| |
|
|
13064
13357
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13065
13358
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13066
13359
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13067
|
-
|muteState|<a href="#remediationitemmutestate"
|
|
13360
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>| |
|
|
13068
13361
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13069
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>| |
|
|
13362
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>| |
|
|
13070
13363
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13071
|
-
|trackingLink|<a href="#trackinglink"
|
|
13364
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>| |
|
|
13072
13365
|
|vulnerabilityState|RemediationDetailsItemVulnerabilityState| |
|
|
13073
|
-
|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> |
|
|
13366
|
+
|vulnerableComponents|Array<<a href="#remediationitemdetailsvulnerablecomponent" target="_blank" rel="noopener noreferrer">RemediationItemDetailsVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
13074
13367
|
|
|
13075
13368
|
### RemediationItem
|
|
13076
13369
|
|
|
@@ -13081,17 +13374,17 @@ A possible remediation for a security problem.
|
|
|
13081
13374
|
|
|
13082
13375
|
| Name | Type | Description |
|
|
13083
13376
|
| --- | --- | --- |
|
|
13084
|
-
|assessment|<a href="#remediationassessment"
|
|
13377
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>| |
|
|
13085
13378
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13086
13379
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13087
13380
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13088
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>| |
|
|
13381
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>| |
|
|
13089
13382
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13090
|
-
|remediationProgress|<a href="#remediationprogress"
|
|
13383
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>| |
|
|
13091
13384
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13092
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>| |
|
|
13385
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>| |
|
|
13093
13386
|
|vulnerabilityState|RemediationItemVulnerabilityState| |
|
|
13094
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent"
|
|
13387
|
+
|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> |
|
|
13095
13388
|
|
|
13096
13389
|
### RemediationItemDetailsVulnerableComponent
|
|
13097
13390
|
|
|
@@ -13119,7 +13412,7 @@ A list of remediation items.
|
|
|
13119
13412
|
|
|
13120
13413
|
| Name | Type | Description |
|
|
13121
13414
|
| --- | --- | --- |
|
|
13122
|
-
|remediationItems|Array<<a href="#remediationitem">RemediationItem</a>>|A list of remediation items. |
|
|
13415
|
+
|remediationItems|Array<<a href="#remediationitem" target="_blank" rel="noopener noreferrer">RemediationItem</a>>|A list of remediation items. |
|
|
13123
13416
|
|
|
13124
13417
|
### RemediationItemMuteState
|
|
13125
13418
|
|
|
@@ -13184,7 +13477,7 @@ Response of muting several remediation items.
|
|
|
13184
13477
|
|
|
13185
13478
|
| Name | Type | Description |
|
|
13186
13479
|
| --- | --- | --- |
|
|
13187
|
-
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary"
|
|
13480
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary">RemediationItemMutingSummary</a>>|The summary of which remediation items were muted and which already were muted previously. |
|
|
13188
13481
|
|
|
13189
13482
|
### RemediationItemsBulkUnmute
|
|
13190
13483
|
|
|
@@ -13208,7 +13501,7 @@ Response of un-muting several remediation items.
|
|
|
13208
13501
|
|
|
13209
13502
|
| Name | Type | Description |
|
|
13210
13503
|
| --- | --- | --- |
|
|
13211
|
-
|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. |
|
|
13504
|
+
|summary<sup>*required</sup>|Array<<a href="#remediationitemmutingsummary" target="_blank" rel="noopener noreferrer">RemediationItemMutingSummary</a>>|The summary of which remediation items were un-muted and which already were un-muted previously. |
|
|
13212
13505
|
|
|
13213
13506
|
### RemediationItemsBulkUpdateDeleteDto
|
|
13214
13507
|
|
|
@@ -13220,7 +13513,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
13220
13513
|
| Name | Type | Description |
|
|
13221
13514
|
| --- | --- | --- |
|
|
13222
13515
|
|deletes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<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> |
|
|
13223
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates"
|
|
13516
|
+
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a>| |
|
|
13224
13517
|
|
|
13225
13518
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
13226
13519
|
**type**: Record<string, TrackingLinkUpdate | undefined>
|
|
@@ -13254,12 +13547,12 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
13254
13547
|
|
|
13255
13548
|
| Name | Type | Description |
|
|
13256
13549
|
| --- | --- | --- |
|
|
13257
|
-
|assessment|<a href="#remediationprogressentityassessment">RemediationProgressEntityAssessment</a>| |
|
|
13550
|
+
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>| |
|
|
13258
13551
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the remediation progress entity has first been related to the vulnerability. |
|
|
13259
13552
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity. |
|
|
13260
13553
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity. |
|
|
13261
13554
|
|state|RemediationProgressEntityState| |
|
|
13262
|
-
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent"
|
|
13555
|
+
|vulnerableComponents|Array<<a href="#remediationprogressvulnerablecomponent">RemediationProgressVulnerableComponent</a>>|<p>A list of vulnerable components of the remediation item.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
13263
13556
|
|
|
13264
13557
|
### RemediationProgressEntityAssessment
|
|
13265
13558
|
|
|
@@ -13272,9 +13565,9 @@ Assessment of the remediation progress entity.
|
|
|
13272
13565
|
| --- | --- | --- |
|
|
13273
13566
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13274
13567
|
|vulnerableFunctionUsage|RemediationProgressEntityAssessmentVulnerableFunctionUsage| |
|
|
13275
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13276
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
13277
|
-
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
13568
|
+
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13569
|
+
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13570
|
+
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
13278
13571
|
|
|
13279
13572
|
### RemediationProgressEntityList
|
|
13280
13573
|
|
|
@@ -13285,7 +13578,7 @@ A list of remediation progress entities.
|
|
|
13285
13578
|
|
|
13286
13579
|
| Name | Type | Description |
|
|
13287
13580
|
| --- | --- | --- |
|
|
13288
|
-
|remediationProgressEntities|Array<<a href="#remediationprogressentity"
|
|
13581
|
+
|remediationProgressEntities|Array<<a href="#remediationprogressentity">RemediationProgressEntity</a>>|A list of remediation progress entities. |
|
|
13289
13582
|
|
|
13290
13583
|
### RemediationProgressVulnerableComponent
|
|
13291
13584
|
|
|
@@ -13313,9 +13606,65 @@ Describes the complete request information of an attack.
|
|
|
13313
13606
|
| --- | --- | --- |
|
|
13314
13607
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
13315
13608
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
13316
|
-
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>| |
|
|
13609
|
+
|protocolDetails|<a href="#protocoldetails" target="_blank" rel="noopener noreferrer">ProtocolDetails</a>| |
|
|
13317
13610
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
13318
13611
|
|
|
13612
|
+
### ResolutionRequest
|
|
13613
|
+
|
|
13614
|
+
|
|
13615
|
+
|
|
13616
|
+
|
|
13617
|
+
|
|
13618
|
+
|
|
13619
|
+
| Name | Type |
|
|
13620
|
+
| --- | --- |
|
|
13621
|
+
|permissions|Array<<a href="#singlepermissionrequest">SinglePermissionRequest</a>>|
|
|
13622
|
+
|
|
13623
|
+
### ResourceContext
|
|
13624
|
+
|
|
13625
|
+
|
|
13626
|
+
|
|
13627
|
+
|
|
13628
|
+
The resource context, which contains additional permission information about the object.
|
|
13629
|
+
|
|
13630
|
+
| Name | Type | Description |
|
|
13631
|
+
| --- | --- | --- |
|
|
13632
|
+
|modifications<sup>*required</sup>|<a href="#modification" target="_blank" rel="noopener noreferrer">Modification</a>| |
|
|
13633
|
+
|operations<sup>*required</sup>|Array<ResourceContextOperationsItem>|The allowed operations on this settings object. |
|
|
13634
|
+
|
|
13635
|
+
### RevisionDiff
|
|
13636
|
+
|
|
13637
|
+
|
|
13638
|
+
|
|
13639
|
+
|
|
13640
|
+
The diff between two revisions.
|
|
13641
|
+
|
|
13642
|
+
| Name | Type | Description |
|
|
13643
|
+
| --- | --- | --- |
|
|
13644
|
+
|jsonAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The new value of the changed settings value or null if the value has been deleted. |
|
|
13645
|
+
|jsonBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The previous value of the changed settings value or null if the value has been newly created. |
|
|
13646
|
+
|jsonPatch|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|The JSON Patch for this value. May be null if the diff type is not UPDATE. |
|
|
13647
|
+
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>| |
|
|
13648
|
+
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
13649
|
+
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
13650
|
+
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema version the new value complies to |
|
|
13651
|
+
|type|RevisionDiffType| |
|
|
13652
|
+
|
|
13653
|
+
### RevisionDiffPage
|
|
13654
|
+
|
|
13655
|
+
|
|
13656
|
+
|
|
13657
|
+
|
|
13658
|
+
The paged response payload for diff between revisions of settings.
|
|
13659
|
+
|
|
13660
|
+
| Name | Type | Description |
|
|
13661
|
+
| --- | --- | --- |
|
|
13662
|
+
|endTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'to' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
13663
|
+
|items<sup>*required</sup>|Array<<a href="#revisiondiff" target="_blank" rel="noopener noreferrer">RevisionDiff</a>>|The list of revisions changes in the current page. |
|
|
13664
|
+
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
13665
|
+
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13666
|
+
|startTime<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The 'from' time in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') from the original request. |
|
|
13667
|
+
|
|
13319
13668
|
### RiskAssessment
|
|
13320
13669
|
|
|
13321
13670
|
|
|
@@ -13326,6 +13675,7 @@ Risk assessment of a security problem.
|
|
|
13326
13675
|
| Name | Type | Description |
|
|
13327
13676
|
| --- | --- | --- |
|
|
13328
13677
|
|assessmentAccuracy|RiskAssessmentAssessmentAccuracy| |
|
|
13678
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>| |
|
|
13329
13679
|
|baseRiskLevel|RiskAssessmentBaseRiskLevel| |
|
|
13330
13680
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13331
13681
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -13366,6 +13716,7 @@ Risk assessment of a security problem.
|
|
|
13366
13716
|
| Name | Type | Description |
|
|
13367
13717
|
| --- | --- | --- |
|
|
13368
13718
|
|assessmentAccuracy|RiskAssessmentDetailsAssessmentAccuracy| |
|
|
13719
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13369
13720
|
|baseRiskLevel|RiskAssessmentDetailsBaseRiskLevel| |
|
|
13370
13721
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13371
13722
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -13388,7 +13739,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
13388
13739
|
| Name | Type | Description |
|
|
13389
13740
|
| --- | --- | --- |
|
|
13390
13741
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13391
|
-
|changes|<a href="#riskassessmentchanges"
|
|
13742
|
+
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>| |
|
|
13392
13743
|
|exposure|RiskAssessmentSnapshotExposure| |
|
|
13393
13744
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
13394
13745
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
@@ -13427,7 +13778,7 @@ Parameters of a service-level objective (SLO).
|
|
|
13427
13778
|
|enabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The SLO is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
13428
13779
|
|error<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The error of the SLO calculation.</p> <p>If the value differs from <code>NONE</code>, there is something wrong with the SLO calculation.</p> |
|
|
13429
13780
|
|errorBudget<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The error budget of the calculated SLO.</p> <p>The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.</p> <p>Has the value of the evaluated error budget or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
13430
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>| |
|
|
13781
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate" target="_blank" rel="noopener noreferrer">SloBurnRate</a>| |
|
|
13431
13782
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric. |
|
|
13432
13783
|
|evaluatedPercentage<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The calculated status value of the SLO. Has the value of the evaluated SLO status or the value of <code>-1</code>:</p> <ul> <li>If there is an error with the SLO calculation; in that case check the value of the <strong>error</strong> property.</li> <li>If the evaluate parameter has not been set to <code>true</code>; in that case the <strong>error</strong> property will contain no error.</li> </ul> |
|
|
13433
13784
|
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
@@ -13461,7 +13812,7 @@ Contains SLOs and paging information.
|
|
|
13461
13812
|
| --- | --- | --- |
|
|
13462
13813
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
13463
13814
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13464
|
-
|slo<sup>*required</sup>|Array<<a href="#slo"
|
|
13815
|
+
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs. |
|
|
13465
13816
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13466
13817
|
|
|
13467
13818
|
### SchemaConstraintRestDto
|
|
@@ -13489,25 +13840,25 @@ Contains SLOs and paging information.
|
|
|
13489
13840
|
| Name | Type | Description |
|
|
13490
13841
|
| --- | --- | --- |
|
|
13491
13842
|
|allowedScopes<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of scopes where the schema can be used. |
|
|
13492
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
13493
|
-
|deletionConstraints|Array<<a href="#deletionconstraint"
|
|
13843
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constrains limiting the values to be accepted by the schema. |
|
|
13844
|
+
|deletionConstraints|Array<<a href="#deletionconstraint">DeletionConstraint</a>>|Constraints limiting the values to be deleted. |
|
|
13494
13845
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the schema. |
|
|
13495
13846
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
13496
13847
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
13497
13848
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
13498
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums">SchemaDefinitionRestDtoEnums</a>| |
|
|
13849
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>| |
|
|
13499
13850
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
13500
13851
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum amount of objects per scope.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13501
|
-
|metadata|<a href="#schemadefinitionrestdtometadata"
|
|
13852
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>| |
|
|
13502
13853
|
|multiObject<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multiple (<code>true</code>) objects per scope are permitted or a single (<code>false</code>) object per scope is permitted. |
|
|
13503
13854
|
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the order of objects has semantic significance.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13504
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties">SchemaDefinitionRestDtoProperties</a>| |
|
|
13505
|
-
|schemaConstraints|Array<<a href="#schemaconstraintrestdto"
|
|
13855
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>| |
|
|
13856
|
+
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
13506
13857
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
13507
13858
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13508
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns">SchemaDefinitionRestDtoTableColumns</a>| |
|
|
13509
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes"
|
|
13510
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>| |
|
|
13859
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>| |
|
|
13860
|
+
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a>| |
|
|
13861
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>| |
|
|
13511
13862
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
13512
13863
|
|
|
13513
13864
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -13567,7 +13918,7 @@ The list of available settings schemas.
|
|
|
13567
13918
|
|
|
13568
13919
|
| Name | Type | Description |
|
|
13569
13920
|
| --- | --- | --- |
|
|
13570
|
-
|items<sup>*required</sup>|Array<<a href="#schemastub"
|
|
13921
|
+
|items<sup>*required</sup>|Array<<a href="#schemastub">SchemaStub</a>>|A list of settings schemas. |
|
|
13571
13922
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of schemas in the list. |
|
|
13572
13923
|
|
|
13573
13924
|
### SchemaStub
|
|
@@ -13579,9 +13930,11 @@ The short representation of the settings schema.
|
|
|
13579
13930
|
|
|
13580
13931
|
| Name | Type | Description |
|
|
13581
13932
|
| --- | --- | --- |
|
|
13582
|
-
|displayName
|
|
13583
|
-
|latestSchemaVersion
|
|
13584
|
-
|
|
|
13933
|
+
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema. |
|
|
13934
|
+
|latestSchemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The most recent version of the schema. |
|
|
13935
|
+
|multiObject|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multi-object flag. <code>True</code> if the schema is a multi-object schema |
|
|
13936
|
+
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Ordered flag. <code>True</code> if the schema is an ordered multi-object schema. |
|
|
13937
|
+
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13585
13938
|
|
|
13586
13939
|
### SchemaType
|
|
13587
13940
|
|
|
@@ -13594,11 +13947,11 @@ A list of definitions of types.
|
|
|
13594
13947
|
|
|
13595
13948
|
| Name | Type | Description |
|
|
13596
13949
|
| --- | --- | --- |
|
|
13597
|
-
|constraints|Array<<a href="#complexconstraint">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
13950
|
+
|constraints|Array<<a href="#complexconstraint" target="_blank" rel="noopener noreferrer">ComplexConstraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
13598
13951
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
13599
13952
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
13600
13953
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
13601
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties"
|
|
13954
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>| |
|
|
13602
13955
|
|searchPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary search(for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13603
13956
|
|summaryPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary (for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13604
13957
|
|type<sup>*required</sup>|Object| |
|
|
@@ -13655,19 +14008,19 @@ Parameters of a security problem
|
|
|
13655
14008
|
|
|
13656
14009
|
| Name | Type | Description |
|
|
13657
14010
|
| --- | --- | --- |
|
|
13658
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>| |
|
|
14011
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
13659
14012
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
13660
14013
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
13661
14014
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
13662
14015
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
13663
|
-
|globalCounts|<a href="#globalcountsdto"
|
|
14016
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>| |
|
|
13664
14017
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
13665
14018
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
13666
14019
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
13667
|
-
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
14020
|
+
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
13668
14021
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
13669
14022
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
13670
|
-
|riskAssessment|<a href="#riskassessment"
|
|
14023
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>| |
|
|
13671
14024
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
13672
14025
|
|status|SecurityProblemStatus| |
|
|
13673
14026
|
|technology|SecurityProblemTechnology| |
|
|
@@ -13698,37 +14051,37 @@ Parameters of a security problem
|
|
|
13698
14051
|
| Name | Type | Description |
|
|
13699
14052
|
| --- | --- | --- |
|
|
13700
14053
|
|affectedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of affected entities of the security problem.</p> <p>An affected entity is an entity where a vulnerable component runs.</p> |
|
|
13701
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails">CodeLevelVulnerabilityDetails</a>| |
|
|
14054
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
13702
14055
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
13703
14056
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
13704
14057
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
13705
|
-
|entryPoints|<a href="#entrypoints"
|
|
13706
|
-
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
14058
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>| |
|
|
14059
|
+
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
13707
14060
|
|exposedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of exposed entities of the security problem.</p> <p>An exposed entity is an affected entity that is exposed to the internet.</p> |
|
|
13708
14061
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
13709
|
-
|filteredCounts|<a href="#filteredcountsdto"
|
|
14062
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>| |
|
|
13710
14063
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
13711
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>| |
|
|
14064
|
+
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>| |
|
|
13712
14065
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
13713
14066
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
13714
14067
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
13715
|
-
|managementZones|Array<<a href="#managementzone"
|
|
14068
|
+
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
13716
14069
|
|muteStateChangeInProgress|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code> a change of the mute state is in progress. |
|
|
13717
14070
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
13718
14071
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
13719
14072
|
|reachableDataAssets|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of data assets reachable by affected entities of the security problem.</p> <p>A data asset is a service that has database access.</p> |
|
|
13720
|
-
|relatedAttacks|<a href="#relatedattackslist">RelatedAttacksList</a>| |
|
|
13721
|
-
|relatedContainerImages|<a href="#relatedcontainerlist"
|
|
13722
|
-
|relatedEntities|<a href="#relatedentitieslist">RelatedEntitiesList</a>| |
|
|
14073
|
+
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a>| |
|
|
14074
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>| |
|
|
14075
|
+
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a>| |
|
|
13723
14076
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
13724
|
-
|riskAssessment|<a href="#riskassessmentdetails"
|
|
14077
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>| |
|
|
13725
14078
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
13726
14079
|
|status|SecurityProblemDetailsStatus| |
|
|
13727
14080
|
|technology|SecurityProblemDetailsTechnology| |
|
|
13728
14081
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
13729
14082
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
13730
14083
|
|vulnerabilityType|SecurityProblemDetailsVulnerabilityType| |
|
|
13731
|
-
|vulnerableComponents|Array<<a href="#vulnerablecomponent">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
14084
|
+
|vulnerableComponents|Array<<a href="#vulnerablecomponent" target="_blank" rel="noopener noreferrer">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
13732
14085
|
|
|
13733
14086
|
### SecurityProblemEvent
|
|
13734
14087
|
|
|
@@ -13739,9 +14092,9 @@ The event of a security problem.
|
|
|
13739
14092
|
|
|
13740
14093
|
| Name | Type | Description |
|
|
13741
14094
|
| --- | --- | --- |
|
|
13742
|
-
|muteState|<a href="#mutestate"
|
|
14095
|
+
|muteState|<a href="#mutestate">MuteState</a>| |
|
|
13743
14096
|
|reason|SecurityProblemEventReason| |
|
|
13744
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot">RiskAssessmentSnapshot</a>| |
|
|
14097
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>| |
|
|
13745
14098
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
13746
14099
|
|
|
13747
14100
|
### SecurityProblemEventsList
|
|
@@ -13753,7 +14106,7 @@ A list of events for a security problem.
|
|
|
13753
14106
|
|
|
13754
14107
|
| Name | Type | Description |
|
|
13755
14108
|
| --- | --- | --- |
|
|
13756
|
-
|events|Array<<a href="#securityproblemevent"
|
|
14109
|
+
|events|Array<<a href="#securityproblemevent">SecurityProblemEvent</a>>|A list of events for a security problem. |
|
|
13757
14110
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
13758
14111
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13759
14112
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
@@ -13769,7 +14122,7 @@ A list of security problems.
|
|
|
13769
14122
|
| --- | --- | --- |
|
|
13770
14123
|
|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<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> |
|
|
13771
14124
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13772
|
-
|securityProblems|Array<<a href="#securityproblem">SecurityProblem</a>>|A list of security problems. |
|
|
14125
|
+
|securityProblems|Array<<a href="#securityproblem" target="_blank" rel="noopener noreferrer">SecurityProblem</a>>|A list of security problems. |
|
|
13773
14126
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13774
14127
|
|
|
13775
14128
|
### SecurityProblemMute
|
|
@@ -13818,7 +14171,7 @@ Response of muting several security problems.
|
|
|
13818
14171
|
|
|
13819
14172
|
| Name | Type | Description |
|
|
13820
14173
|
| --- | --- | --- |
|
|
13821
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary"
|
|
14174
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were muted and which already were muted previously. |
|
|
13822
14175
|
|
|
13823
14176
|
### SecurityProblemsBulkUnmute
|
|
13824
14177
|
|
|
@@ -13842,7 +14195,7 @@ Response of un-muting several security problems.
|
|
|
13842
14195
|
|
|
13843
14196
|
| Name | Type | Description |
|
|
13844
14197
|
| --- | --- | --- |
|
|
13845
|
-
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
14198
|
+
|summary<sup>*required</sup>|Array<<a href="#securityproblembulkmutingsummary" target="_blank" rel="noopener noreferrer">SecurityProblemBulkMutingSummary</a>>|The summary of which security problems were un-muted and which already were un-muted previously. |
|
|
13846
14199
|
|
|
13847
14200
|
### ServiceImpact
|
|
13848
14201
|
|
|
@@ -13855,7 +14208,7 @@ Analysis of problem impact to a service.
|
|
|
13855
14208
|
| --- | --- | --- |
|
|
13856
14209
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
13857
14210
|
|impactType<sup>*required</sup>|ImpactImpactType| |
|
|
13858
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub"
|
|
14211
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
13859
14212
|
|numberOfPotentiallyAffectedServiceCalls|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
13860
14213
|
|
|
13861
14214
|
### SettingsObject
|
|
@@ -13871,10 +14224,36 @@ A settings object.
|
|
|
13871
14224
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
13872
14225
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
13873
14226
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
13874
|
-
|modificationInfo|<a href="#modificationinfo">ModificationInfo</a>| |
|
|
14227
|
+
|modificationInfo|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>| |
|
|
13875
14228
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
13876
14229
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
13877
14230
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14231
|
+
|resourceContext|<a href="#resourcecontext">ResourceContext</a>| |
|
|
14232
|
+
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14233
|
+
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14234
|
+
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>. |
|
|
14235
|
+
|searchSummary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A searchable summary string of the setting value. Plain text without Markdown. |
|
|
14236
|
+
|summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short summary of settings. This can contain Markdown and will be escaped accordingly. |
|
|
14237
|
+
|updateToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
14238
|
+
|value|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
14239
|
+
|
|
14240
|
+
### SettingsObjectByObjectIdResponse
|
|
14241
|
+
|
|
14242
|
+
|
|
14243
|
+
|
|
14244
|
+
|
|
14245
|
+
The response to a get by objectId request.
|
|
14246
|
+
|
|
14247
|
+
| Name | Type | Description |
|
|
14248
|
+
| --- | --- | --- |
|
|
14249
|
+
|author|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user (identified by a user ID or a public token ID) who performed that most recent modification. |
|
|
14250
|
+
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
14251
|
+
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
14252
|
+
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
14253
|
+
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14254
|
+
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14255
|
+
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14256
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>| |
|
|
13878
14257
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
13879
14258
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
13880
14259
|
|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope that the object targets. For more details, please see <a href="https://dt-url.net/ky03459" target="_blank" rel="noopener noreferrer" >Dynatrace Documentation</a>. |
|
|
@@ -13910,7 +14289,7 @@ The response to a creation- or update-request.
|
|
|
13910
14289
|
| Name | Type | Description |
|
|
13911
14290
|
| --- | --- | --- |
|
|
13912
14291
|
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code for the object. |
|
|
13913
|
-
|error|<a href="#error"
|
|
14292
|
+
|error|<a href="#error">Error</a>| |
|
|
13914
14293
|
|invalidValue|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
13915
14294
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For a successful request, the ID of the created or modified settings object. |
|
|
13916
14295
|
|
|
@@ -13929,6 +14308,18 @@ An update of a settings object.
|
|
|
13929
14308
|
|updateToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The update token of the object. You can use it to detect simultaneous modifications by different users.</p> <p>It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.</p> <p>If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.</p> |
|
|
13930
14309
|
|value<sup>*required</sup>|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The value of the setting.</p> <p>It defines the actual values of settings' parameters.</p> <p>The actual content depends on the object's schema.</p> |
|
|
13931
14310
|
|
|
14311
|
+
### SinglePermissionRequest
|
|
14312
|
+
|
|
14313
|
+
|
|
14314
|
+
|
|
14315
|
+
|
|
14316
|
+
A list of permissions.
|
|
14317
|
+
|
|
14318
|
+
| Name | Type | Description |
|
|
14319
|
+
| --- | --- | --- |
|
|
14320
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>| |
|
|
14321
|
+
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed |
|
|
14322
|
+
|
|
13932
14323
|
### SloBurnRate
|
|
13933
14324
|
|
|
13934
14325
|
|
|
@@ -14137,7 +14528,7 @@ The performance threshold rule.
|
|
|
14137
14528
|
|
|
14138
14529
|
| Name | Type | Description |
|
|
14139
14530
|
| --- | --- | --- |
|
|
14140
|
-
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation|
|
|
14531
|
+
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation| <i>default:</i> <code>"AVG"</code>|
|
|
14141
14532
|
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
|
|
14142
14533
|
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
|
|
14143
14534
|
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
|
|
@@ -14198,11 +14589,12 @@ Network Availability monitor.
|
|
|
14198
14589
|
|
|
14199
14590
|
| Name | Type | Description |
|
|
14200
14591
|
| --- | --- | --- |
|
|
14201
|
-
|active|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If false, the monitor is disabled. <i>default:</i> <code>true</code>|
|
|
14202
14592
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
14593
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
14203
14594
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity id of the monitor. |
|
|
14204
14595
|
|frequencyMin<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14205
14596
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14597
|
+
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
14206
14598
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14207
14599
|
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14208
14600
|
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
@@ -14243,8 +14635,8 @@ Network availability monitor.
|
|
|
14243
14635
|
|
|
14244
14636
|
| Name | Type | Description |
|
|
14245
14637
|
| --- | --- | --- |
|
|
14246
|
-
|active|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If false, the monitor is disabled. <i>default:</i> <code>true</code>|
|
|
14247
14638
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description |
|
|
14639
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled. <i>default:</i> <code>true</code>|
|
|
14248
14640
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14249
14641
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14250
14642
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
@@ -14460,6 +14852,7 @@ Contains the details of problems encountered while triggering on-demand executio
|
|
|
14460
14852
|
|cause<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cause of not triggering entity. |
|
|
14461
14853
|
|details<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The details of triggering problem. |
|
|
14462
14854
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity identifier. |
|
|
14855
|
+
|executionId<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The execution identifier. |
|
|
14463
14856
|
|locationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The location identifier. |
|
|
14464
14857
|
|
|
14465
14858
|
### SyntheticPrivateLocationUpdate
|
|
@@ -14589,7 +14982,7 @@ A credentials set of the `TOKEN` type.
|
|
|
14589
14982
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14590
14983
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
14591
14984
|
|scope|CredentialsScope| |
|
|
14592
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
14985
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
14593
14986
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Token in the string format. |
|
|
14594
14987
|
|type|CredentialsType| |
|
|
14595
14988
|
|
|
@@ -14934,7 +15327,7 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
14934
15327
|
|ownerAccessOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The credentials set is available to every user (<code>false</code>) or to owner only (<code>true</code>). |
|
|
14935
15328
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential. |
|
|
14936
15329
|
|scope|CredentialsScope| |
|
|
14937
|
-
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>
|
|
15330
|
+
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
14938
15331
|
|type|CredentialsType| |
|
|
14939
15332
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set. |
|
|
14940
15333
|
|
|
@@ -15369,7 +15762,7 @@ The type of the ActiveGate.
|
|
|
15369
15762
|
|
|
15370
15763
|
<div class="padding-left--md">
|
|
15371
15764
|
|
|
15372
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15765
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15373
15766
|
|
|
15374
15767
|
</div>
|
|
15375
15768
|
|
|
@@ -15387,7 +15780,7 @@ The type of the ActiveGate.
|
|
|
15387
15780
|
|
|
15388
15781
|
<div class="padding-left--md">
|
|
15389
15782
|
|
|
15390
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
15783
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DiagnosticExport` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MemoryDump` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `Mobile` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `ViewDashboard` | `ViewReport` | `WriteConfig` | `WriteSyntheticData`
|
|
15391
15784
|
|
|
15392
15785
|
</div>
|
|
15393
15786
|
|
|
@@ -15405,7 +15798,25 @@ The type of the ActiveGate.
|
|
|
15405
15798
|
|
|
15406
15799
|
<div class="padding-left--md">
|
|
15407
15800
|
|
|
15408
|
-
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15801
|
+
`ActiveGateCertManagement` | `ActiveGateTokenManagementCreate` | `ActiveGateTokenManagementRead` | `ActiveGateTokenManagementWrite` | `ActiveGatesRead` | `ActiveGatesWrite` | `AdaptiveTrafficManagementRead` | `AdvancedSyntheticIntegration` | `AnalyzersRead` | `AnalyzersWrite` | `ApiTokensRead` | `ApiTokensWrite` | `AttacksRead` | `AttacksWrite` | `AuditLogsRead` | `BizeventsIngest` | `CaptureRequestData` | `CredentialVaultRead` | `CredentialVaultWrite` | `DataExport` | `DataImport` | `DataPrivacy` | `Davis` | `DssFileManagement` | `DtaqlAccess` | `EntitiesRead` | `EntitiesWrite` | `EventsIngest` | `EventsRead` | `ExtensionConfigurationActionsWrite` | `ExtensionConfigurationsRead` | `ExtensionConfigurationsWrite` | `ExtensionEnvironmentRead` | `ExtensionEnvironmentWrite` | `ExtensionsRead` | `ExtensionsWrite` | `ExternalSyntheticIntegration` | `GeographicRegionsRead` | `HubInstall` | `HubRead` | `HubWrite` | `InstallerDownload` | `JavaScriptMappingFilesRead` | `JavaScriptMappingFilesWrite` | `LogExport` | `LogsIngest` | `LogsRead` | `MetricsIngest` | `MetricsRead` | `MetricsWrite` | `NetworkZonesRead` | `NetworkZonesWrite` | `OneAgentsRead` | `OneAgentsWrite` | `OpenTelemetryTraceIngest` | `OpenpipelineEvents` | `OpenpipelineEventsCustom` | `OpenpipelineEventsSdlc` | `OpenpipelineEventsSdlcCustom` | `OpenpipelineEventsSecurity` | `OpenpipelineEventsSecurityCustom` | `PluginUpload` | `ProblemsRead` | `ProblemsWrite` | `ReadConfig` | `ReadSyntheticData` | `ReleasesRead` | `RestRequestForwarding` | `RumBrowserExtension` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `SettingsRead` | `SettingsWrite` | `SloRead` | `SloWrite` | `SupportAlert` | `SyntheticExecutionsRead` | `SyntheticExecutionsWrite` | `SyntheticLocationsRead` | `SyntheticLocationsWrite` | `TenantTokenManagement` | `TenantTokenRotationWrite` | `TracesLookup` | `UnifiedAnalysisRead` | `UserSessionAnonymization` | `WriteConfig`
|
|
15802
|
+
|
|
15803
|
+
</div>
|
|
15804
|
+
|
|
15805
|
+
|
|
15806
|
+
</div>
|
|
15807
|
+
|
|
15808
|
+
<a name="assessmentaccuracydetailsreducedreasonsitem"></a>
|
|
15809
|
+
### AssessmentAccuracyDetailsReducedReasonsItem
|
|
15810
|
+
|
|
15811
|
+
<div class="padding-left--md">
|
|
15812
|
+
|
|
15813
|
+
The reason for a reduced accuracy of the assessment.
|
|
15814
|
+
|
|
15815
|
+
#### Enum keys
|
|
15816
|
+
|
|
15817
|
+
<div class="padding-left--md">
|
|
15818
|
+
|
|
15819
|
+
`LimitedAgentSupport` | `LimitedByConfiguration`
|
|
15409
15820
|
|
|
15410
15821
|
</div>
|
|
15411
15822
|
|
|
@@ -15531,7 +15942,7 @@ The category of the recorded operation.
|
|
|
15531
15942
|
|
|
15532
15943
|
<div class="padding-left--md">
|
|
15533
15944
|
|
|
15534
|
-
`
|
|
15945
|
+
`ActivegateToken` | `Config` | `ManualTaggingService` | `Token` | `WebUi`
|
|
15535
15946
|
|
|
15536
15947
|
</div>
|
|
15537
15948
|
|
|
@@ -15560,7 +15971,7 @@ The type of the recorded operation.
|
|
|
15560
15971
|
|
|
15561
15972
|
<div class="padding-left--md">
|
|
15562
15973
|
|
|
15563
|
-
`Create` | `Delete` | `Login` | `Logout` | `
|
|
15974
|
+
`Create` | `Delete` | `Login` | `Logout` | `Revoke` | `TagAdd` | `TagRemove` | `TagUpdate` | `Update`
|
|
15564
15975
|
|
|
15565
15976
|
</div>
|
|
15566
15977
|
|
|
@@ -15727,7 +16138,7 @@ The set of scopes of the credentials set.
|
|
|
15727
16138
|
|
|
15728
16139
|
<div class="padding-left--md">
|
|
15729
16140
|
|
|
15730
|
-
`Extension` | `Synthetic`
|
|
16141
|
+
`AppEngine` | `Extension` | `Synthetic`
|
|
15731
16142
|
|
|
15732
16143
|
</div>
|
|
15733
16144
|
|
|
@@ -15777,11 +16188,13 @@ The scope of the credentials set.
|
|
|
15777
16188
|
|
|
15778
16189
|
The set of scopes of the credentials set.
|
|
15779
16190
|
|
|
16191
|
+
Limitations: `CredentialsScope.APP_ENGINE` is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.
|
|
16192
|
+
|
|
15780
16193
|
#### Enum keys
|
|
15781
16194
|
|
|
15782
16195
|
<div class="padding-left--md">
|
|
15783
16196
|
|
|
15784
|
-
`Extension` | `Synthetic`
|
|
16197
|
+
`AppEngine` | `Extension` | `Synthetic`
|
|
15785
16198
|
|
|
15786
16199
|
</div>
|
|
15787
16200
|
|
|
@@ -15858,7 +16271,25 @@ The technology of the vulnerable component.
|
|
|
15858
16271
|
|
|
15859
16272
|
<div class="padding-left--md">
|
|
15860
16273
|
|
|
15861
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
16274
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
16275
|
+
|
|
16276
|
+
</div>
|
|
16277
|
+
|
|
16278
|
+
|
|
16279
|
+
</div>
|
|
16280
|
+
|
|
16281
|
+
<a name="effectivepermissiongranted"></a>
|
|
16282
|
+
### EffectivePermissionGranted
|
|
16283
|
+
|
|
16284
|
+
<div class="padding-left--md">
|
|
16285
|
+
|
|
16286
|
+
|
|
16287
|
+
|
|
16288
|
+
#### Enum keys
|
|
16289
|
+
|
|
16290
|
+
<div class="padding-left--md">
|
|
16291
|
+
|
|
16292
|
+
`Condition` | `False` | `True`
|
|
15862
16293
|
|
|
15863
16294
|
</div>
|
|
15864
16295
|
|
|
@@ -16513,6 +16944,24 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
16513
16944
|
</div>
|
|
16514
16945
|
|
|
16515
16946
|
|
|
16947
|
+
</div>
|
|
16948
|
+
|
|
16949
|
+
<a name="getlocationsquerycapability"></a>
|
|
16950
|
+
### GetLocationsQueryCapability
|
|
16951
|
+
|
|
16952
|
+
<div class="padding-left--md">
|
|
16953
|
+
|
|
16954
|
+
|
|
16955
|
+
|
|
16956
|
+
#### Enum keys
|
|
16957
|
+
|
|
16958
|
+
<div class="padding-left--md">
|
|
16959
|
+
|
|
16960
|
+
`Browser` | `Dns` | `Http` | `Icmp` | `Tcp`
|
|
16961
|
+
|
|
16962
|
+
</div>
|
|
16963
|
+
|
|
16964
|
+
|
|
16516
16965
|
</div>
|
|
16517
16966
|
|
|
16518
16967
|
<a name="getlocationsquerycloudplatform"></a>
|
|
@@ -16991,7 +17440,7 @@ The name of the monitoring state.
|
|
|
16991
17440
|
|
|
16992
17441
|
<div class="padding-left--md">
|
|
16993
17442
|
|
|
16994
|
-
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
17443
|
+
`AgentInjectionStatusGoDynamizerFailed` | `AgentInjectionStatusGoPclntabFailed` | `AgentInjectionStatusGoVertigoSupportAdded` | `AgentInjectionStatusNginxPatchedBinaryDetected` | `AgentInjectionStatusPhpOpcacheDisabled` | `AgentInjectionStatusPhpStackSizeTooLow` | `AgentInjectionSuppression` | `AixEnableFullMonitoringNeeded` | `BadInstaller` | `BoshbpmDisabled` | `ContainerInjectionFailed` | `ContainerdDisabled` | `CrioDisabled` | `CustomPgRuleRequired` | `DeepMonitoringSuccessful` | `DeepMonitoringUnsuccessful` | `DockerDisabled` | `GardenDisabled` | `HostInfraStructureOnly` | `HostMonitoringDisabled` | `NetworkAgentInactive` | `Ok` | `ParentProcessRestartRequired` | `PodmanDisabled` | `ProcessGroupDifferentIdDueToDeclarativeGrouping` | `ProcessGroupDisabled` | `ProcessGroupDisabledViaContainerInjectionRule` | `ProcessGroupDisabledViaContainerInjectionRuleRestart` | `ProcessGroupDisabledViaGlobalSettings` | `ProcessGroupDisabledViaInjectionRule` | `ProcessGroupDisabledViaInjectionRuleRestart` | `RestartRequired` | `RestartRequiredApache` | `RestartRequiredDockerDeamon` | `RestartRequiredHostGroupInconsistent` | `RestartRequiredHostIdInconsistent` | `RestartRequiredOutdatedAgentApacheUpdate` | `RestartRequiredOutdatedAgentInjected` | `RestartRequiredUsingDifferentDataStorageDir` | `RestartRequiredUsingDifferentLogPath` | `RestartRequiredVirtualizedContainer` | `UnsupportedState` | `WincDisabled`
|
|
16995
17444
|
|
|
16996
17445
|
</div>
|
|
16997
17446
|
|
|
@@ -17374,6 +17823,42 @@ The current state of the remediation progress entity.
|
|
|
17374
17823
|
</div>
|
|
17375
17824
|
|
|
17376
17825
|
|
|
17826
|
+
</div>
|
|
17827
|
+
|
|
17828
|
+
<a name="resourcecontextoperationsitem"></a>
|
|
17829
|
+
### ResourceContextOperationsItem
|
|
17830
|
+
|
|
17831
|
+
<div class="padding-left--md">
|
|
17832
|
+
|
|
17833
|
+
The allowed operations on this settings object.
|
|
17834
|
+
|
|
17835
|
+
#### Enum keys
|
|
17836
|
+
|
|
17837
|
+
<div class="padding-left--md">
|
|
17838
|
+
|
|
17839
|
+
`Delete` | `Read` | `Write`
|
|
17840
|
+
|
|
17841
|
+
</div>
|
|
17842
|
+
|
|
17843
|
+
|
|
17844
|
+
</div>
|
|
17845
|
+
|
|
17846
|
+
<a name="revisiondifftype"></a>
|
|
17847
|
+
### RevisionDiffType
|
|
17848
|
+
|
|
17849
|
+
<div class="padding-left--md">
|
|
17850
|
+
|
|
17851
|
+
The type of the difference.
|
|
17852
|
+
|
|
17853
|
+
#### Enum keys
|
|
17854
|
+
|
|
17855
|
+
<div class="padding-left--md">
|
|
17856
|
+
|
|
17857
|
+
`Create` | `Delete` | `NoChange` | `Reorder` | `Update`
|
|
17858
|
+
|
|
17859
|
+
</div>
|
|
17860
|
+
|
|
17861
|
+
|
|
17377
17862
|
</div>
|
|
17378
17863
|
|
|
17379
17864
|
<a name="riskassessmentassessmentaccuracy"></a>
|
|
@@ -17897,7 +18382,7 @@ The technology of the security problem.
|
|
|
17897
18382
|
|
|
17898
18383
|
<div class="padding-left--md">
|
|
17899
18384
|
|
|
17900
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
18385
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
17901
18386
|
|
|
17902
18387
|
</div>
|
|
17903
18388
|
|
|
@@ -17987,7 +18472,7 @@ The technology of the security problem.
|
|
|
17987
18472
|
|
|
17988
18473
|
<div class="padding-left--md">
|
|
17989
18474
|
|
|
17990
|
-
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php`
|
|
18475
|
+
`Dotnet` | `Go` | `Java` | `Kubernetes` | `NodeJs` | `Php` | `Python`
|
|
17991
18476
|
|
|
17992
18477
|
</div>
|
|
17993
18478
|
|
|
@@ -18180,7 +18665,7 @@ Aggregation type
|
|
|
18180
18665
|
|
|
18181
18666
|
<div class="padding-left--md">
|
|
18182
18667
|
|
|
18183
|
-
`
|
|
18668
|
+
`Avg` | `Max` | `Min`
|
|
18184
18669
|
|
|
18185
18670
|
</div>
|
|
18186
18671
|
|