@dynatrace-sdk/client-classic-environment-v2 2.0.0 → 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 +21 -0
- package/README.md +417 -277
- package/cjs/index.js +2355 -2116
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +2363 -2128
- package/package.json +1 -1
- 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 +0 -1
- 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-objects-api.d.ts +73 -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/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 +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +2 -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/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/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 +28 -14
- 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-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/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/settings-object-by-object-id-response.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.transformation.d.ts +2 -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/apis/settings-privacy-operations-sync-api-api.d.ts +0 -64
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.d.ts +0 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.transformation.d.ts +0 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.d.ts +0 -11
- package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.transformation.d.ts +0 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/personal-data-request.d.ts +0 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/personal-data-request.transformation.d.ts +0 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/pii-relationships-item.d.ts +0 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/pii-relationships-item.transformation.d.ts +0 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/pii.d.ts +0 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/pii.transformation.d.ts +0 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/schema.d.ts +0 -18
- package/types/packages/client/classic-environment-v2/src/lib/models/schema.transformation.d.ts +0 -9
- package/types/packages/client/classic-environment-v2/src/lib/models/value.d.ts +0 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/value.transformation.d.ts +0 -9
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
|
|
|
@@ -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
|
|
|
@@ -7805,6 +7824,65 @@ const data =
|
|
|
7805
7824
|
|
|
7806
7825
|
|
|
7807
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
|
+
|
|
7808
7886
|
</div>
|
|
7809
7887
|
|
|
7810
7888
|
|
|
@@ -7812,7 +7890,7 @@ const data =
|
|
|
7812
7890
|
### getSettingsObjectByObjectId
|
|
7813
7891
|
|
|
7814
7892
|
<div class="padding-bottom--md">
|
|
7815
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse">SettingsObjectByObjectIdResponse</a>></strong>
|
|
7893
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse" target="_blank" rel="noopener noreferrer">SettingsObjectByObjectIdResponse</a>></strong>
|
|
7816
7894
|
|
|
7817
7895
|
<div class="padding-left--md">
|
|
7818
7896
|
|
|
@@ -7867,7 +7945,7 @@ const data =
|
|
|
7867
7945
|
### getSettingsObjects
|
|
7868
7946
|
|
|
7869
7947
|
<div class="padding-bottom--md">
|
|
7870
|
-
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist"
|
|
7948
|
+
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist">ObjectsList</a>></strong>
|
|
7871
7949
|
|
|
7872
7950
|
<div class="padding-left--md">
|
|
7873
7951
|
|
|
@@ -7896,7 +7974,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
7896
7974
|
| Name | Type | Description |
|
|
7897
7975
|
| --- | --- | --- |
|
|
7898
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> |
|
|
7899
|
-
|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> |
|
|
7900
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> |
|
|
7901
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> |
|
|
7902
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> |
|
|
@@ -7935,7 +8013,7 @@ const data =
|
|
|
7935
8013
|
### postSettingsObjects
|
|
7936
8014
|
|
|
7937
8015
|
<div class="padding-bottom--md">
|
|
7938
|
-
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse">SettingsObjectResponse</a>>></strong>
|
|
8016
|
+
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse" target="_blank" rel="noopener noreferrer">SettingsObjectResponse</a>>></strong>
|
|
7939
8017
|
|
|
7940
8018
|
<div class="padding-left--md">
|
|
7941
8019
|
|
|
@@ -7959,7 +8037,7 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
7959
8037
|
|
|
7960
8038
|
| Name | Type | Description |
|
|
7961
8039
|
| --- | --- | --- |
|
|
7962
|
-
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate"
|
|
8040
|
+
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>>| |
|
|
7963
8041
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings objects, without saving them. |
|
|
7964
8042
|
|
|
7965
8043
|
|
|
@@ -8002,7 +8080,7 @@ const data =
|
|
|
8002
8080
|
### putSettingsObjectByObjectId
|
|
8003
8081
|
|
|
8004
8082
|
<div class="padding-bottom--md">
|
|
8005
|
-
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse">SettingsObjectResponse</a>></strong>
|
|
8083
|
+
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse" target="_blank" rel="noopener noreferrer">SettingsObjectResponse</a>></strong>
|
|
8006
8084
|
|
|
8007
8085
|
<div class="padding-left--md">
|
|
8008
8086
|
|
|
@@ -8028,7 +8106,7 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
8028
8106
|
|
|
8029
8107
|
| Name | Type | Description |
|
|
8030
8108
|
| --- | --- | --- |
|
|
8031
|
-
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate"
|
|
8109
|
+
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate">SettingsObjectUpdate</a>| |
|
|
8032
8110
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
8033
8111
|
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, the request runs only validation of the submitted settings object, without saving it. |
|
|
8034
8112
|
|
|
@@ -8061,82 +8139,26 @@ const data =
|
|
|
8061
8139
|
|
|
8062
8140
|
</div>
|
|
8063
8141
|
|
|
8064
|
-
## settingsPrivacyOperationsSyncApiClient
|
|
8065
|
-
|
|
8066
|
-
```js
|
|
8067
|
-
import { settingsPrivacyOperationsSyncApiClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
8068
|
-
```
|
|
8069
|
-
|
|
8070
8142
|
|
|
8071
|
-
<a name="
|
|
8072
|
-
###
|
|
8143
|
+
<a name="resolveeffectivepermissions"></a>
|
|
8144
|
+
### resolveEffectivePermissions
|
|
8073
8145
|
|
|
8074
8146
|
<div class="padding-bottom--md">
|
|
8075
|
-
<strong>
|
|
8147
|
+
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission" target="_blank" rel="noopener noreferrer">EffectivePermission</a>>></strong>
|
|
8076
8148
|
|
|
8077
8149
|
<div class="padding-left--md">
|
|
8078
8150
|
|
|
8079
|
-
|
|
8080
|
-
|
|
8081
|
-
**Required scope:** settings:operations.privacy:write
|
|
8082
|
-
**Required permission:** settings:operations.privacy:write
|
|
8083
|
-
|
|
8084
|
-
|
|
8085
|
-
|
|
8086
|
-
</div>
|
|
8087
|
-
|
|
8088
|
-
|
|
8089
|
-
#### Parameters
|
|
8090
|
-
|
|
8091
|
-
| Name | Type |
|
|
8092
|
-
| --- | --- |
|
|
8093
|
-
|config.body<sup>*required</sup>|<a href="#personaldatarequest">PersonalDataRequest</a>|
|
|
8094
|
-
|
|
8095
|
-
|
|
8096
|
-
|
|
8097
|
-
|
|
8098
|
-
|
|
8099
|
-
<details>
|
|
8100
|
-
<summary>
|
|
8101
|
-
Code example
|
|
8102
|
-
</summary>
|
|
8103
|
-
|
|
8104
|
-
```ts
|
|
8105
|
-
import { settingsPrivacyOperationsSyncApiClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8106
|
-
|
|
8107
|
-
const data =
|
|
8108
|
-
await settingsPrivacyOperationsSyncApiClient.deletePersonalDataSync(
|
|
8109
|
-
{
|
|
8110
|
-
body: {
|
|
8111
|
-
email: "user@foo.com",
|
|
8112
|
-
userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
|
|
8113
|
-
},
|
|
8114
|
-
},
|
|
8115
|
-
);
|
|
8116
|
-
```
|
|
8117
|
-
|
|
8118
|
-
</details>
|
|
8119
|
-
|
|
8120
|
-
|
|
8121
|
-
|
|
8122
|
-
</div>
|
|
8123
|
-
|
|
8124
|
-
|
|
8125
|
-
<a name="exportpersonaldatasync"></a>
|
|
8126
|
-
### exportPersonalDataSync
|
|
8127
|
-
|
|
8128
|
-
<div class="padding-bottom--md">
|
|
8129
|
-
<strong>settingsPrivacyOperationsSyncApiClient.exportPersonalDataSync(config): Promise<<a href="#paginatedpersonaldataresponse" target="_blank" rel="noopener noreferrer">PaginatedPersonalDataResponse</a>></strong>
|
|
8130
|
-
|
|
8131
|
-
<div class="padding-left--md">
|
|
8151
|
+
Get the effective settings permissions of the calling user in the environment
|
|
8132
8152
|
|
|
8133
|
-
|
|
8153
|
+
**One of the following scopes is required:**
|
|
8154
|
+
+ settings:objects:write
|
|
8155
|
+
+ settings:objects:read
|
|
8156
|
+
+ settings:schemas:read
|
|
8134
8157
|
|
|
8135
|
-
**Required scope:** settings:operations.privacy:read
|
|
8136
|
-
**Required permission:** settings:operations.privacy:read
|
|
8137
8158
|
|
|
8138
|
-
|
|
8139
|
-
|
|
8159
|
+
**One of the following permissions is required:**
|
|
8160
|
+
+ environment:roles:viewer
|
|
8161
|
+
+ settings:schemas:read
|
|
8140
8162
|
|
|
8141
8163
|
|
|
8142
8164
|
|
|
@@ -8145,10 +8167,9 @@ The amount of elements in a single response page is limited to 100.
|
|
|
8145
8167
|
|
|
8146
8168
|
#### Parameters
|
|
8147
8169
|
|
|
8148
|
-
| Name | Type |
|
|
8149
|
-
| --- | --- |
|
|
8150
|
-
|config.body<sup>*required</sup>|<a href="#
|
|
8151
|
-
|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The page to retrieve (optional; if not set, a PersonalDataRequestDto must be provided and the first page of data will be returned) |
|
|
8170
|
+
| Name | Type |
|
|
8171
|
+
| --- | --- |
|
|
8172
|
+
|config.body<sup>*required</sup>|<a href="#resolutionrequest">ResolutionRequest</a>|
|
|
8152
8173
|
|
|
8153
8174
|
|
|
8154
8175
|
|
|
@@ -8164,17 +8185,12 @@ Code example
|
|
|
8164
8185
|
</summary>
|
|
8165
8186
|
|
|
8166
8187
|
```ts
|
|
8167
|
-
import {
|
|
8188
|
+
import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
8168
8189
|
|
|
8169
8190
|
const data =
|
|
8170
|
-
await
|
|
8171
|
-
{
|
|
8172
|
-
|
|
8173
|
-
email: "user@foo.com",
|
|
8174
|
-
userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
|
|
8175
|
-
},
|
|
8176
|
-
},
|
|
8177
|
-
);
|
|
8191
|
+
await settingsObjectsClient.resolveEffectivePermissions({
|
|
8192
|
+
body: {},
|
|
8193
|
+
});
|
|
8178
8194
|
```
|
|
8179
8195
|
|
|
8180
8196
|
</details>
|
|
@@ -9928,9 +9944,10 @@ Information about an affected entity.
|
|
|
9928
9944
|
|
|
9929
9945
|
Aggregated log records.
|
|
9930
9946
|
|
|
9931
|
-
| Name | Type |
|
|
9932
|
-
| --- | --- |
|
|
9933
|
-
|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. |
|
|
9934
9951
|
|
|
9935
9952
|
### AggregatedLogAggregationResult
|
|
9936
9953
|
**type**: Record<string, object | undefined>
|
|
@@ -9985,7 +10002,7 @@ Parameters of a new API token.
|
|
|
9985
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> |
|
|
9986
10003
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9987
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> |
|
|
9988
|
-
|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>rumCookieNames.read</code>: Read RUM cookie names.</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> |
|
|
9989
10006
|
|
|
9990
10007
|
### ApiTokenCreated
|
|
9991
10008
|
|
|
@@ -10036,7 +10053,7 @@ The update of the API token.
|
|
|
10036
10053
|
| --- | --- | --- |
|
|
10037
10054
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
10038
10055
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
10039
|
-
|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>rumCookieNames.read</code>: Read RUM cookie names.</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> |
|
|
10040
10057
|
|
|
10041
10058
|
### ApplicationImpact
|
|
10042
10059
|
|
|
@@ -10063,6 +10080,17 @@ Optional filters that took effect.
|
|
|
10063
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> |
|
|
10064
10081
|
|filter|<a href="#filter">Filter</a>| |
|
|
10065
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
|
+
|
|
10066
10094
|
### AssetInfo
|
|
10067
10095
|
|
|
10068
10096
|
|
|
@@ -11018,6 +11046,18 @@ A constraint on the values that are going to be deleted.
|
|
|
11018
11046
|
|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
|
|
11019
11047
|
|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
|
|
11020
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
|
+
|
|
11021
11061
|
### EffectiveSettingsValue
|
|
11022
11062
|
|
|
11023
11063
|
|
|
@@ -11465,6 +11505,7 @@ Configuration of an event property.
|
|
|
11465
11505
|
| --- | --- | --- |
|
|
11466
11506
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the event property. |
|
|
11467
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> |
|
|
11468
11509
|
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the event property. |
|
|
11469
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. |
|
|
11470
11511
|
|
|
@@ -11627,6 +11668,7 @@ A list of exported log records.
|
|
|
11627
11668
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
11628
11669
|
|results|Array<<a href="#logrecord">LogRecord</a>>|A list of retrieved log records. |
|
|
11629
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. |
|
|
11630
11672
|
|
|
11631
11673
|
### Extension
|
|
11632
11674
|
|
|
@@ -11717,7 +11759,7 @@ A list of extensions with additional metadata.
|
|
|
11717
11759
|
|
|
11718
11760
|
| Name | Type | Description |
|
|
11719
11761
|
| --- | --- | --- |
|
|
11720
|
-
|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) |
|
|
11721
11763
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
11722
11764
|
|keywords<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Extension keywords for the highest version |
|
|
11723
11765
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Highest installed version |
|
|
@@ -12030,6 +12072,18 @@ Configuration for external vault synchronization for username and password crede
|
|
|
12030
12072
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12031
12073
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12032
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
|
+
|
|
12033
12087
|
### HttpProtocolDetails
|
|
12034
12088
|
|
|
12035
12089
|
|
|
@@ -12164,6 +12218,7 @@ A synthetic location.
|
|
|
12164
12218
|
|
|
12165
12219
|
| Name | Type | Description |
|
|
12166
12220
|
| --- | --- | --- |
|
|
12221
|
+
|capabilities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of location's capabilities. |
|
|
12167
12222
|
|cloudPlatform|LocationCollectionElementCloudPlatform| |
|
|
12168
12223
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the location. |
|
|
12169
12224
|
|geoCity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location's city. |
|
|
@@ -12225,6 +12280,7 @@ A list of retrieved log records.
|
|
|
12225
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>. |
|
|
12226
12281
|
|results|Array<<a href="#logrecord" target="_blank" rel="noopener noreferrer">LogRecord</a>>|A list of retrieved log records. |
|
|
12227
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. |
|
|
12228
12284
|
|
|
12229
12285
|
### METag
|
|
12230
12286
|
|
|
@@ -12534,21 +12590,35 @@ Analysis of problem impact to a mobile application.
|
|
|
12534
12590
|
|impactType<sup>*required</sup>|ImpactImpactType| |
|
|
12535
12591
|
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
12536
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
|
+
|
|
12537
12607
|
### ModificationInfo
|
|
12538
12608
|
|
|
12539
12609
|
|
|
12540
12610
|
|
|
12541
12611
|
|
|
12542
|
-
The modification info for a single updatable setting.
|
|
12612
|
+
The modification info for a single updatable setting. Replaced by `resourceContext`.
|
|
12543
12613
|
|
|
12544
12614
|
| Name | Type | Description |
|
|
12545
12615
|
| --- | --- | --- |
|
|
12546
|
-
|deletable
|
|
12616
|
+
|deletable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings value can be deleted |
|
|
12547
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) |
|
|
12548
|
-
|modifiable
|
|
12549
|
-
|modifiablePaths
|
|
12550
|
-
|movable
|
|
12551
|
-
|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 |
|
|
12552
12622
|
|
|
12553
12623
|
### MonitorEntityIdDto
|
|
12554
12624
|
|
|
@@ -12845,51 +12915,17 @@ A list of settings objects.
|
|
|
12845
12915
|
|pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
12846
12916
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
12847
12917
|
|
|
12848
|
-
###
|
|
12918
|
+
### PermissionContext
|
|
12849
12919
|
|
|
12850
12920
|
|
|
12851
12921
|
|
|
12852
12922
|
|
|
12853
|
-
|
|
12923
|
+
Optional context data
|
|
12854
12924
|
|
|
12855
12925
|
| Name | Type | Description |
|
|
12856
12926
|
| --- | --- | --- |
|
|
12857
|
-
|
|
|
12858
|
-
|
|
|
12859
|
-
|
|
12860
|
-
### PaginatedPersonalDataResponseData
|
|
12861
|
-
|
|
12862
|
-
|
|
12863
|
-
|
|
12864
|
-
|
|
12865
|
-
The data of the response payload to the personal data request.
|
|
12866
|
-
|
|
12867
|
-
| Name | Type | Description |
|
|
12868
|
-
| --- | --- | --- |
|
|
12869
|
-
|schemas<sup>*required</sup>|Array<<a href="#schema" target="_blank" rel="noopener noreferrer">Schema</a>>|The list of settings schemas containing personal data. |
|
|
12870
|
-
|
|
12871
|
-
### PersonalDataRequest
|
|
12872
|
-
|
|
12873
|
-
|
|
12874
|
-
|
|
12875
|
-
|
|
12876
|
-
The request payload for the exporting personal data
|
|
12877
|
-
|
|
12878
|
-
| Name | Type | Description |
|
|
12879
|
-
| --- | --- | --- |
|
|
12880
|
-
|email<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User's e-mail |
|
|
12881
|
-
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|IAM user UUID |
|
|
12882
|
-
|
|
12883
|
-
### Pii
|
|
12884
|
-
|
|
12885
|
-
|
|
12886
|
-
|
|
12887
|
-
|
|
12888
|
-
The information about relationships of the user to the settings object.
|
|
12889
|
-
|
|
12890
|
-
| Name | Type | Description |
|
|
12891
|
-
| --- | --- | --- |
|
|
12892
|
-
|relationships<sup>*required</sup>|Array<PiiRelationshipsItem>|A list of user relationships. |
|
|
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 |
|
|
12893
12929
|
|
|
12894
12930
|
### Precondition
|
|
12895
12931
|
|
|
@@ -12956,6 +12992,9 @@ The properties of a problem.
|
|
|
12956
12992
|
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>| |
|
|
12957
12993
|
|impactLevel<sup>*required</sup>|ProblemImpactLevel| |
|
|
12958
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. |
|
|
12959
12998
|
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>| |
|
|
12960
12999
|
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
12961
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. |
|
|
@@ -13295,14 +13334,15 @@ Assessment of the remediation item.
|
|
|
13295
13334
|
| Name | Type | Description |
|
|
13296
13335
|
| --- | --- | --- |
|
|
13297
13336
|
|assessmentAccuracy|RemediationAssessmentAssessmentAccuracy| |
|
|
13337
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13298
13338
|
|dataAssets|RemediationAssessmentDataAssets| |
|
|
13299
13339
|
|exposure|RemediationAssessmentExposure| |
|
|
13300
13340
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets. |
|
|
13301
13341
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13302
13342
|
|vulnerableFunctionUsage|RemediationAssessmentVulnerableFunctionUsage| |
|
|
13303
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction"
|
|
13304
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13305
|
-
|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. |
|
|
13306
13346
|
|
|
13307
13347
|
### RemediationDetailsItem
|
|
13308
13348
|
|
|
@@ -13313,17 +13353,17 @@ Detailed information of a remediation item for a security problem.
|
|
|
13313
13353
|
|
|
13314
13354
|
| Name | Type | Description |
|
|
13315
13355
|
| --- | --- | --- |
|
|
13316
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>| |
|
|
13356
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>| |
|
|
13317
13357
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13318
13358
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13319
13359
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13320
|
-
|muteState|<a href="#remediationitemmutestate"
|
|
13360
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>| |
|
|
13321
13361
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13322
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>| |
|
|
13362
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>| |
|
|
13323
13363
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13324
|
-
|trackingLink|<a href="#trackinglink"
|
|
13364
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>| |
|
|
13325
13365
|
|vulnerabilityState|RemediationDetailsItemVulnerabilityState| |
|
|
13326
|
-
|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> |
|
|
13327
13367
|
|
|
13328
13368
|
### RemediationItem
|
|
13329
13369
|
|
|
@@ -13334,17 +13374,17 @@ A possible remediation for a security problem.
|
|
|
13334
13374
|
|
|
13335
13375
|
| Name | Type | Description |
|
|
13336
13376
|
| --- | --- | --- |
|
|
13337
|
-
|assessment|<a href="#remediationassessment"
|
|
13377
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>| |
|
|
13338
13378
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13339
13379
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13340
13380
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13341
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>| |
|
|
13381
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>| |
|
|
13342
13382
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13343
|
-
|remediationProgress|<a href="#remediationprogress"
|
|
13383
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>| |
|
|
13344
13384
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13345
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>| |
|
|
13385
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>| |
|
|
13346
13386
|
|vulnerabilityState|RemediationItemVulnerabilityState| |
|
|
13347
|
-
|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> |
|
|
13348
13388
|
|
|
13349
13389
|
### RemediationItemDetailsVulnerableComponent
|
|
13350
13390
|
|
|
@@ -13372,7 +13412,7 @@ A list of remediation items.
|
|
|
13372
13412
|
|
|
13373
13413
|
| Name | Type | Description |
|
|
13374
13414
|
| --- | --- | --- |
|
|
13375
|
-
|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. |
|
|
13376
13416
|
|
|
13377
13417
|
### RemediationItemMuteState
|
|
13378
13418
|
|
|
@@ -13437,7 +13477,7 @@ Response of muting several remediation items.
|
|
|
13437
13477
|
|
|
13438
13478
|
| Name | Type | Description |
|
|
13439
13479
|
| --- | --- | --- |
|
|
13440
|
-
|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. |
|
|
13441
13481
|
|
|
13442
13482
|
### RemediationItemsBulkUnmute
|
|
13443
13483
|
|
|
@@ -13461,7 +13501,7 @@ Response of un-muting several remediation items.
|
|
|
13461
13501
|
|
|
13462
13502
|
| Name | Type | Description |
|
|
13463
13503
|
| --- | --- | --- |
|
|
13464
|
-
|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. |
|
|
13465
13505
|
|
|
13466
13506
|
### RemediationItemsBulkUpdateDeleteDto
|
|
13467
13507
|
|
|
@@ -13473,7 +13513,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
13473
13513
|
| Name | Type | Description |
|
|
13474
13514
|
| --- | --- | --- |
|
|
13475
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> |
|
|
13476
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates"
|
|
13516
|
+
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a>| |
|
|
13477
13517
|
|
|
13478
13518
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
13479
13519
|
**type**: Record<string, TrackingLinkUpdate | undefined>
|
|
@@ -13507,12 +13547,12 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
13507
13547
|
|
|
13508
13548
|
| Name | Type | Description |
|
|
13509
13549
|
| --- | --- | --- |
|
|
13510
|
-
|assessment|<a href="#remediationprogressentityassessment">RemediationProgressEntityAssessment</a>| |
|
|
13550
|
+
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>| |
|
|
13511
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. |
|
|
13512
13552
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity. |
|
|
13513
13553
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity. |
|
|
13514
13554
|
|state|RemediationProgressEntityState| |
|
|
13515
|
-
|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> |
|
|
13516
13556
|
|
|
13517
13557
|
### RemediationProgressEntityAssessment
|
|
13518
13558
|
|
|
@@ -13525,9 +13565,9 @@ Assessment of the remediation progress entity.
|
|
|
13525
13565
|
| --- | --- | --- |
|
|
13526
13566
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13527
13567
|
|vulnerableFunctionUsage|RemediationProgressEntityAssessmentVulnerableFunctionUsage| |
|
|
13528
|
-
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13529
|
-
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction"
|
|
13530
|
-
|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. |
|
|
13531
13571
|
|
|
13532
13572
|
### RemediationProgressEntityList
|
|
13533
13573
|
|
|
@@ -13538,7 +13578,7 @@ A list of remediation progress entities.
|
|
|
13538
13578
|
|
|
13539
13579
|
| Name | Type | Description |
|
|
13540
13580
|
| --- | --- | --- |
|
|
13541
|
-
|remediationProgressEntities|Array<<a href="#remediationprogressentity"
|
|
13581
|
+
|remediationProgressEntities|Array<<a href="#remediationprogressentity">RemediationProgressEntity</a>>|A list of remediation progress entities. |
|
|
13542
13582
|
|
|
13543
13583
|
### RemediationProgressVulnerableComponent
|
|
13544
13584
|
|
|
@@ -13566,9 +13606,65 @@ Describes the complete request information of an attack.
|
|
|
13566
13606
|
| --- | --- | --- |
|
|
13567
13607
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
13568
13608
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
13569
|
-
|protocolDetails|<a href="#protocoldetails">ProtocolDetails</a>| |
|
|
13609
|
+
|protocolDetails|<a href="#protocoldetails" target="_blank" rel="noopener noreferrer">ProtocolDetails</a>| |
|
|
13570
13610
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
13571
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
|
+
|
|
13572
13668
|
### RiskAssessment
|
|
13573
13669
|
|
|
13574
13670
|
|
|
@@ -13579,6 +13675,7 @@ Risk assessment of a security problem.
|
|
|
13579
13675
|
| Name | Type | Description |
|
|
13580
13676
|
| --- | --- | --- |
|
|
13581
13677
|
|assessmentAccuracy|RiskAssessmentAssessmentAccuracy| |
|
|
13678
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>| |
|
|
13582
13679
|
|baseRiskLevel|RiskAssessmentBaseRiskLevel| |
|
|
13583
13680
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13584
13681
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -13619,6 +13716,7 @@ Risk assessment of a security problem.
|
|
|
13619
13716
|
| Name | Type | Description |
|
|
13620
13717
|
| --- | --- | --- |
|
|
13621
13718
|
|assessmentAccuracy|RiskAssessmentDetailsAssessmentAccuracy| |
|
|
13719
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13622
13720
|
|baseRiskLevel|RiskAssessmentDetailsBaseRiskLevel| |
|
|
13623
13721
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13624
13722
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
@@ -13641,7 +13739,7 @@ A snapshot of the risk assessment of a security problem.
|
|
|
13641
13739
|
| Name | Type | Description |
|
|
13642
13740
|
| --- | --- | --- |
|
|
13643
13741
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13644
|
-
|changes|<a href="#riskassessmentchanges"
|
|
13742
|
+
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>| |
|
|
13645
13743
|
|exposure|RiskAssessmentSnapshotExposure| |
|
|
13646
13744
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
13647
13745
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
@@ -13680,7 +13778,7 @@ Parameters of a service-level objective (SLO).
|
|
|
13680
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>). |
|
|
13681
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> |
|
|
13682
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> |
|
|
13683
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate">SloBurnRate</a>| |
|
|
13781
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate" target="_blank" rel="noopener noreferrer">SloBurnRate</a>| |
|
|
13684
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. |
|
|
13685
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> |
|
|
13686
13784
|
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
@@ -13714,22 +13812,9 @@ Contains SLOs and paging information.
|
|
|
13714
13812
|
| --- | --- | --- |
|
|
13715
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> |
|
|
13716
13814
|
|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
|
|
13717
|
-
|slo<sup>*required</sup>|Array<<a href="#slo"
|
|
13815
|
+
|slo<sup>*required</sup>|Array<<a href="#slo">SLO</a>>|The list of SLOs. |
|
|
13718
13816
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |
|
|
13719
13817
|
|
|
13720
|
-
### Schema
|
|
13721
|
-
|
|
13722
|
-
|
|
13723
|
-
|
|
13724
|
-
|
|
13725
|
-
The information about settings schema containing personal data.
|
|
13726
|
-
|
|
13727
|
-
| Name | Type | Description |
|
|
13728
|
-
| --- | --- | --- |
|
|
13729
|
-
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema. |
|
|
13730
|
-
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13731
|
-
|values<sup>*required</sup>|Array<<a href="#value">Value</a>>|The list of settings values containing personal data. |
|
|
13732
|
-
|
|
13733
13818
|
### SchemaConstraintRestDto
|
|
13734
13819
|
|
|
13735
13820
|
|
|
@@ -14143,6 +14228,7 @@ A settings object.
|
|
|
14143
14228
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14144
14229
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14145
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>| |
|
|
14146
14232
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14147
14233
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14148
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>. |
|
|
@@ -14167,6 +14253,7 @@ The response to a get by objectId request.
|
|
|
14167
14253
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14168
14254
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14169
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>| |
|
|
14170
14257
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14171
14258
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14172
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>. |
|
|
@@ -14221,6 +14308,18 @@ An update of a settings object.
|
|
|
14221
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> |
|
|
14222
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> |
|
|
14223
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
|
+
|
|
14224
14323
|
### SloBurnRate
|
|
14225
14324
|
|
|
14226
14325
|
|
|
@@ -14260,7 +14359,7 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
14260
14359
|
| --- | --- | --- |
|
|
14261
14360
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
14262
14361
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The SLO is enabled (<code>true</code>) or disabled (<code>false</code>).</p> <p>If not defined, the SLO is disabled by default.</p> |
|
|
14263
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig"
|
|
14362
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>| |
|
|
14264
14363
|
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
14265
14364
|
|filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the <a href="https://dt-url.net/entityselector" target="_blank" rel="noopener noreferrer" >syntax of entity selector</a>. |
|
|
14266
14365
|
|metricDenominator|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The total count metric (the denominator in rate calculation).</p> <p>Required when the <strong>useRateMetric</strong> is set to <code>false</code>.</p> |
|
|
@@ -14322,7 +14421,7 @@ Parameters of a status alert.
|
|
|
14322
14421
|
|
|
14323
14422
|
| Name | Type |
|
|
14324
14423
|
| --- | --- |
|
|
14325
|
-
|details|<a href="#success">Success</a>|
|
|
14424
|
+
|details|<a href="#success" target="_blank" rel="noopener noreferrer">Success</a>|
|
|
14326
14425
|
|
|
14327
14426
|
### SyntheticConfigDto
|
|
14328
14427
|
|
|
@@ -14392,7 +14491,7 @@ A list of synthetic locations.
|
|
|
14392
14491
|
|
|
14393
14492
|
| Name | Type | Description |
|
|
14394
14493
|
| --- | --- | --- |
|
|
14395
|
-
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement"
|
|
14494
|
+
|locations<sup>*required</sup>|Array<<a href="#locationcollectionelement">LocationCollectionElement</a>>|A list of synthetic locations. |
|
|
14396
14495
|
|
|
14397
14496
|
### SyntheticMonitorListDto
|
|
14398
14497
|
|
|
@@ -14403,7 +14502,7 @@ List of available synthetic monitors.
|
|
|
14403
14502
|
|
|
14404
14503
|
| Name | Type | Description |
|
|
14405
14504
|
| --- | --- | --- |
|
|
14406
|
-
|monitors|Array<<a href="#syntheticmonitorsummarydto">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
14505
|
+
|monitors|Array<<a href="#syntheticmonitorsummarydto" target="_blank" rel="noopener noreferrer">SyntheticMonitorSummaryDto</a>>|List of monitors. |
|
|
14407
14506
|
|
|
14408
14507
|
### SyntheticMonitorOutageHandlingSettingsDto
|
|
14409
14508
|
|
|
@@ -14429,7 +14528,7 @@ The performance threshold rule.
|
|
|
14429
14528
|
|
|
14430
14529
|
| Name | Type | Description |
|
|
14431
14530
|
| --- | --- | --- |
|
|
14432
|
-
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation|
|
|
14531
|
+
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation| <i>default:</i> <code>"AVG"</code>|
|
|
14433
14532
|
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
|
|
14434
14533
|
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
|
|
14435
14534
|
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
|
|
@@ -14446,7 +14545,7 @@ Performance thresholds configuration.
|
|
|
14446
14545
|
| Name | Type | Description |
|
|
14447
14546
|
| --- | --- | --- |
|
|
14448
14547
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
14449
|
-
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto"
|
|
14548
|
+
|thresholds|Array<<a href="#syntheticmonitorperformancethresholddto">SyntheticMonitorPerformanceThresholdDto</a>>|The list of performance threshold rules. |
|
|
14450
14549
|
|
|
14451
14550
|
### SyntheticMonitorSummaryDto
|
|
14452
14551
|
|
|
@@ -14471,7 +14570,7 @@ The network availability monitor constraint.
|
|
|
14471
14570
|
|
|
14472
14571
|
| Name | Type | Description |
|
|
14473
14572
|
| --- | --- | --- |
|
|
14474
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>| |
|
|
14573
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>| |
|
|
14475
14574
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
14476
14575
|
|
|
14477
14576
|
### SyntheticMultiProtocolMonitorConstraintDtoProperties
|
|
@@ -14497,10 +14596,10 @@ Network Availability monitor.
|
|
|
14497
14596
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14498
14597
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
14499
14598
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14500
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto"
|
|
14501
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14502
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto"
|
|
14503
|
-
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14599
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14600
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14601
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14602
|
+
|tags|Array<<a href="#synthetictagwithsourcedto" target="_blank" rel="noopener noreferrer">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14504
14603
|
|type<sup>*required</sup>|SyntheticMultiProtocolMonitorDtoType| |
|
|
14505
14604
|
|
|
14506
14605
|
### SyntheticMultiProtocolMonitorStepDto
|
|
@@ -14512,10 +14611,10 @@ The step of a network availability monitor.
|
|
|
14512
14611
|
|
|
14513
14612
|
| Name | Type | Description |
|
|
14514
14613
|
| --- | --- | --- |
|
|
14515
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto"
|
|
14614
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
14516
14615
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
14517
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties">SyntheticMultiProtocolMonitorStepDtoProperties</a>| |
|
|
14518
|
-
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto"
|
|
14616
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>| |
|
|
14617
|
+
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
14519
14618
|
|requestType<sup>*required</sup>|SyntheticMultiProtocolMonitorStepDtoRequestType| |
|
|
14520
14619
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
14521
14620
|
|targetList<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
@@ -14541,10 +14640,10 @@ Network availability monitor.
|
|
|
14541
14640
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14542
14641
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14543
14642
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14544
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14545
|
-
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto"
|
|
14546
|
-
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14547
|
-
|tags|Array<<a href="#synthetictagwithsourcedto"
|
|
14643
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14644
|
+
|steps<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorstepdto">SyntheticMultiProtocolMonitorStepDto</a>>|The steps of the monitor. |
|
|
14645
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>| |
|
|
14646
|
+
|tags|Array<<a href="#synthetictagwithsourcedto">SyntheticTagWithSourceDto</a>>|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |
|
|
14548
14647
|
|type<sup>*required</sup>|MultiProtocol| |
|
|
14549
14648
|
|
|
14550
14649
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
@@ -14556,7 +14655,7 @@ The configuration of a network availability monitor request.
|
|
|
14556
14655
|
|
|
14557
14656
|
| Name | Type | Description |
|
|
14558
14657
|
| --- | --- | --- |
|
|
14559
|
-
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|Request constraints. |
|
|
14658
|
+
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDto</a>>|Request constraints. |
|
|
14560
14659
|
|
|
14561
14660
|
### SyntheticOnDemandBatchStatus
|
|
14562
14661
|
|
|
@@ -14571,12 +14670,12 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
14571
14670
|
|batchStatus<sup>*required</sup>|SyntheticOnDemandBatchStatusBatchStatus| |
|
|
14572
14671
|
|executedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result SUCCESS or FAILED. |
|
|
14573
14672
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
14574
|
-
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus"
|
|
14575
|
-
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14673
|
+
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14674
|
+
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14576
14675
|
|failedToExecuteCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were triggered and timed out because of a problem with the Synthetic engine. |
|
|
14577
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata"
|
|
14676
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>| |
|
|
14578
14677
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
14579
|
-
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
14678
|
+
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
14580
14679
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
14581
14680
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered execution of the batch. |
|
|
14582
14681
|
|
|
@@ -14602,14 +14701,14 @@ Describes the status of an on-demand execution.
|
|
|
14602
14701
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
14603
14702
|
|executionStage<sup>*required</sup>|SyntheticOnDemandExecutionExecutionStage| |
|
|
14604
14703
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
14605
|
-
|fullResults|<a href="#executionfullresults"
|
|
14704
|
+
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>| |
|
|
14606
14705
|
|locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the location from where the monitor is to be executed. |
|
|
14607
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata">SyntheticOnDemandExecutionMetadata</a>| |
|
|
14706
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionMetadata</a>| |
|
|
14608
14707
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
14609
14708
|
|nextExecutionId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Next execution id for sequential mode. |
|
|
14610
14709
|
|processingMode<sup>*required</sup>|SyntheticOnDemandExecutionProcessingMode| |
|
|
14611
14710
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
14612
|
-
|simpleResults|<a href="#executionsimpleresults"
|
|
14711
|
+
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>| |
|
|
14613
14712
|
|source<sup>*required</sup>|SyntheticOnDemandExecutionSource| |
|
|
14614
14713
|
|userId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the user who triggered the on-demand execution. |
|
|
14615
14714
|
|
|
@@ -14631,9 +14730,9 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
14631
14730
|
| --- | --- | --- |
|
|
14632
14731
|
|failOnPerformanceIssue|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the execution will fail in case of performance issue. <i>default:</i> <code>true</code>|
|
|
14633
14732
|
|failOnSslWarning|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing. <i>default:</i> <code>true</code>|
|
|
14634
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup">SyntheticOnDemandExecutionRequestGroup</a>| |
|
|
14635
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata"
|
|
14636
|
-
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
14733
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestGroup</a>| |
|
|
14734
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>| |
|
|
14735
|
+
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
14637
14736
|
|processingMode|SyntheticOnDemandExecutionRequestProcessingMode| <i>default:</i> <code>"STANDARD"</code>|
|
|
14638
14737
|
|stopOnProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, no executions will be scheduled if a problem occurs. <i>default:</i> <code>false</code>|
|
|
14639
14738
|
|takeScreenshotsOnSuccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the screenshots will be taken during the execution of a browser monitor. <i>default:</i> <code>false</code>|
|
|
@@ -14684,10 +14783,10 @@ The result of on-demand synthetic monitor execution.
|
|
|
14684
14783
|
| Name | Type | Description |
|
|
14685
14784
|
| --- | --- | --- |
|
|
14686
14785
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The batch identifier of the triggered executions. |
|
|
14687
|
-
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor"
|
|
14786
|
+
|triggered|Array<<a href="#syntheticondemandtriggeredmonitor">SyntheticOnDemandTriggeredMonitor</a>>|Monitors for which on-demand executions were triggered. |
|
|
14688
14787
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of the triggered executions within the batch. |
|
|
14689
14788
|
|triggeringProblemsCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of problems within the batch. |
|
|
14690
|
-
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
14789
|
+
|triggeringProblemsDetails|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>|List with the entities for which triggering problems occurred. |
|
|
14691
14790
|
|
|
14692
14791
|
### SyntheticOnDemandExecutions
|
|
14693
14792
|
|
|
@@ -14698,7 +14797,7 @@ Contains a list of synthetic on-demand executions.
|
|
|
14698
14797
|
|
|
14699
14798
|
| Name | Type | Description |
|
|
14700
14799
|
| --- | --- | --- |
|
|
14701
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution"
|
|
14800
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>>|The list of executions. |
|
|
14702
14801
|
|
|
14703
14802
|
### SyntheticOnDemandFailedExecutionStatus
|
|
14704
14803
|
|
|
@@ -14738,7 +14837,7 @@ Contains the list of on-demand executions of the monitor.
|
|
|
14738
14837
|
|
|
14739
14838
|
| Name | Type | Description |
|
|
14740
14839
|
| --- | --- | --- |
|
|
14741
|
-
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
14840
|
+
|executions<sup>*required</sup>|Array<<a href="#syntheticondemandtriggeredexecutiondetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeredExecutionDetails</a>>|The list of triggered executions. |
|
|
14742
14841
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
14743
14842
|
|
|
14744
14843
|
### SyntheticOnDemandTriggeringProblemDetails
|
|
@@ -14851,8 +14950,8 @@ Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
|
14851
14950
|
|
|
14852
14951
|
| Name | Type |
|
|
14853
14952
|
| --- | --- |
|
|
14854
|
-
|active|<a href="#tenanttoken"
|
|
14855
|
-
|old|<a href="#tenanttoken">TenantToken</a>|
|
|
14953
|
+
|active|<a href="#tenanttoken">TenantToken</a>|
|
|
14954
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|
|
|
14856
14955
|
|
|
14857
14956
|
### ToPosition
|
|
14858
14957
|
|
|
@@ -14876,9 +14975,9 @@ A credentials set of the `TOKEN` type.
|
|
|
14876
14975
|
| Name | Type | Description |
|
|
14877
14976
|
| --- | --- | --- |
|
|
14878
14977
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
14879
|
-
|allowedEntities|Array<<a href="#credentialaccessdata"
|
|
14978
|
+
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14880
14979
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
14881
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>| |
|
|
14980
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>| |
|
|
14882
14981
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
14883
14982
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14884
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>). |
|
|
@@ -14926,9 +15025,9 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
14926
15025
|
| --- | --- | --- |
|
|
14927
15026
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
14928
15027
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
14929
|
-
|entity<sup>*required</sup>|<a href="#entitystub"
|
|
15028
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
14930
15029
|
|evidenceType<sup>*required</sup>|EvidenceEvidenceType| |
|
|
14931
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>| |
|
|
15030
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
14932
15031
|
|rootCauseRelevant<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The evidence is (<code>true</code>) or is not (<code>false</code>) a part of the root cause. |
|
|
14933
15032
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
14934
15033
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
@@ -14944,8 +15043,8 @@ A list of values that has possibly been truncated.
|
|
|
14944
15043
|
|
|
14945
15044
|
| Name | Type | Description |
|
|
14946
15045
|
| --- | --- | --- |
|
|
14947
|
-
|truncationInfo|<a href="#truncationinfo"
|
|
14948
|
-
|values|Array<<a href="#attackrequestheader">AttackRequestHeader</a>>|Values of the list. |
|
|
15046
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
15047
|
+
|values|Array<<a href="#attackrequestheader" target="_blank" rel="noopener noreferrer">AttackRequestHeader</a>>|Values of the list. |
|
|
14949
15048
|
|
|
14950
15049
|
### TruncatableListHttpRequestParameter
|
|
14951
15050
|
|
|
@@ -14956,8 +15055,8 @@ A list of values that has possibly been truncated.
|
|
|
14956
15055
|
|
|
14957
15056
|
| Name | Type | Description |
|
|
14958
15057
|
| --- | --- | --- |
|
|
14959
|
-
|truncationInfo|<a href="#truncationinfo"
|
|
14960
|
-
|values|Array<<a href="#httprequestparameter">HttpRequestParameter</a>>|Values of the list. |
|
|
15058
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
15059
|
+
|values|Array<<a href="#httprequestparameter" target="_blank" rel="noopener noreferrer">HttpRequestParameter</a>>|Values of the list. |
|
|
14961
15060
|
|
|
14962
15061
|
### TruncatableListString
|
|
14963
15062
|
|
|
@@ -14968,7 +15067,7 @@ A list of values that has possibly been truncated.
|
|
|
14968
15067
|
|
|
14969
15068
|
| Name | Type | Description |
|
|
14970
15069
|
| --- | --- | --- |
|
|
14971
|
-
|truncationInfo|<a href="#truncationinfo"
|
|
15070
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
14972
15071
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list. |
|
|
14973
15072
|
|
|
14974
15073
|
### TruncationInfo
|
|
@@ -14994,7 +15093,7 @@ UI customization for defining a button that calls a function when pressed
|
|
|
14994
15093
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description to be shown in a tooltip when hovering over the button |
|
|
14995
15094
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The label of the button |
|
|
14996
15095
|
|identifier<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the function to be called when the button is pressed |
|
|
14997
|
-
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition">InsertPosition</a>|The position where the button should be shown in the UI |
|
|
15096
|
+
|insert<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#insertposition" target="_blank" rel="noopener noreferrer">InsertPosition</a>|The position where the button should be shown in the UI |
|
|
14998
15097
|
|
|
14999
15098
|
### UiCallbackCustomization
|
|
15000
15099
|
|
|
@@ -15005,7 +15104,7 @@ UI customization options for defining custom callbacks
|
|
|
15005
15104
|
|
|
15006
15105
|
| Name | Type | Description |
|
|
15007
15106
|
| --- | --- | --- |
|
|
15008
|
-
|buttons|Array<<a href="#uibuttoncustomization"
|
|
15107
|
+
|buttons|Array<<a href="#uibuttoncustomization">UiButtonCustomization</a>>|UI customization for defining buttons that call functions when pressed |
|
|
15009
15108
|
|
|
15010
15109
|
### UiCustomization
|
|
15011
15110
|
|
|
@@ -15016,10 +15115,10 @@ Customization for UI elements
|
|
|
15016
15115
|
|
|
15017
15116
|
| Name | Type |
|
|
15018
15117
|
| --- | --- |
|
|
15019
|
-
|callback|<a href="#uicallbackcustomization">UiCallbackCustomization</a>|
|
|
15020
|
-
|expandable|<a href="#uiexpandablecustomization"
|
|
15021
|
-
|table|<a href="#uitablecustomization">UiTableCustomization</a>|
|
|
15022
|
-
|tabs|<a href="#uitabscustomization"
|
|
15118
|
+
|callback|<a href="#uicallbackcustomization" target="_blank" rel="noopener noreferrer">UiCallbackCustomization</a>|
|
|
15119
|
+
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|
|
|
15120
|
+
|table|<a href="#uitablecustomization" target="_blank" rel="noopener noreferrer">UiTableCustomization</a>|
|
|
15121
|
+
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|
|
|
15023
15122
|
|
|
15024
15123
|
### UiEmptyStateCustomization
|
|
15025
15124
|
|
|
@@ -15043,7 +15142,7 @@ UI customization for expandable section
|
|
|
15043
15142
|
| --- | --- | --- |
|
|
15044
15143
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name |
|
|
15045
15144
|
|expanded|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if the item should be expanded by default |
|
|
15046
|
-
|sections|Array<<a href="#uiexpandablesectioncustomization">UiExpandableSectionCustomization</a>>|A list of sections |
|
|
15145
|
+
|sections|Array<<a href="#uiexpandablesectioncustomization" target="_blank" rel="noopener noreferrer">UiExpandableSectionCustomization</a>>|A list of sections |
|
|
15047
15146
|
|
|
15048
15147
|
### UiExpandableSectionCustomization
|
|
15049
15148
|
|
|
@@ -15085,7 +15184,7 @@ Customization for UI table columns
|
|
|
15085
15184
|
|columnRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced column from the 'tableColumns' property of the schema for this column. |
|
|
15086
15185
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name for this column. |
|
|
15087
15186
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used. |
|
|
15088
|
-
|items|Array<<a href="#uitablecolumnitemcustomization"
|
|
15187
|
+
|items|Array<<a href="#uitablecolumnitemcustomization">UiTableColumnItemCustomization</a>>|The possible items of this column. |
|
|
15089
15188
|
|propertyRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The referenced property for this column. |
|
|
15090
15189
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ui specific type for this column. |
|
|
15091
15190
|
|width|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The width this column should take up on the table. |
|
|
@@ -15112,8 +15211,8 @@ Customization for UI tables
|
|
|
15112
15211
|
|
|
15113
15212
|
| Name | Type | Description |
|
|
15114
15213
|
| --- | --- | --- |
|
|
15115
|
-
|columns|Array<<a href="#uitablecolumncustomization">UiTableColumnCustomization</a>>|A list of columns for the UI table |
|
|
15116
|
-
|emptyState|<a href="#uiemptystatecustomization"
|
|
15214
|
+
|columns|Array<<a href="#uitablecolumncustomization" target="_blank" rel="noopener noreferrer">UiTableColumnCustomization</a>>|A list of columns for the UI table |
|
|
15215
|
+
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>| |
|
|
15117
15216
|
|
|
15118
15217
|
### UiTabsCustomization
|
|
15119
15218
|
|
|
@@ -15124,7 +15223,7 @@ UI customization for tabs
|
|
|
15124
15223
|
|
|
15125
15224
|
| Name | Type | Description |
|
|
15126
15225
|
| --- | --- | --- |
|
|
15127
|
-
|groups|Array<<a href="#uitabgroupcustomization">UiTabGroupCustomization</a>>|A list of groups |
|
|
15226
|
+
|groups|Array<<a href="#uitabgroupcustomization" target="_blank" rel="noopener noreferrer">UiTabGroupCustomization</a>>|A list of groups |
|
|
15128
15227
|
|
|
15129
15228
|
### Unit
|
|
15130
15229
|
|
|
@@ -15163,7 +15262,7 @@ A list of units along with their properties.
|
|
|
15163
15262
|
| Name | Type | Description |
|
|
15164
15263
|
| --- | --- | --- |
|
|
15165
15264
|
|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of units in the result. |
|
|
15166
|
-
|units<sup>*required</sup>|Array<<a href="#unit"
|
|
15265
|
+
|units<sup>*required</sup>|Array<<a href="#unit">Unit</a>>|A list of units. |
|
|
15167
15266
|
|
|
15168
15267
|
### UpdateJob
|
|
15169
15268
|
|
|
@@ -15197,7 +15296,7 @@ A list of update jobs of the ActiveGate.
|
|
|
15197
15296
|
| Name | Type | Description |
|
|
15198
15297
|
| --- | --- | --- |
|
|
15199
15298
|
|agId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate. |
|
|
15200
|
-
|updateJobs|Array<<a href="#updatejob">UpdateJob</a>>|A list of update jobs of the ActiveGate. |
|
|
15299
|
+
|updateJobs|Array<<a href="#updatejob" target="_blank" rel="noopener noreferrer">UpdateJob</a>>|A list of update jobs of the ActiveGate. |
|
|
15201
15300
|
|
|
15202
15301
|
### UpdateJobsAll
|
|
15203
15302
|
|
|
@@ -15208,7 +15307,7 @@ A list of ActiveGates with update jobs.
|
|
|
15208
15307
|
|
|
15209
15308
|
| Name | Type | Description |
|
|
15210
15309
|
| --- | --- | --- |
|
|
15211
|
-
|allUpdateJobs|Array<<a href="#updatejoblist"
|
|
15310
|
+
|allUpdateJobs|Array<<a href="#updatejoblist">UpdateJobList</a>>|A list of ActiveGates with update jobs. |
|
|
15212
15311
|
|
|
15213
15312
|
### UserPasswordCredentials
|
|
15214
15313
|
|
|
@@ -15220,9 +15319,9 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
15220
15319
|
| Name | Type | Description |
|
|
15221
15320
|
| --- | --- | --- |
|
|
15222
15321
|
|allowContextlessRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope). |
|
|
15223
|
-
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
15322
|
+
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
15224
15323
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
15225
|
-
|externalVault|<a href="#externalvault"
|
|
15324
|
+
|externalVault|<a href="#externalvault">ExternalVault</a>| |
|
|
15226
15325
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
15227
15326
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
15228
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>). |
|
|
@@ -15241,23 +15340,10 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
15241
15340
|
|
|
15242
15341
|
| Name | Type |
|
|
15243
15342
|
| --- | --- |
|
|
15244
|
-
|error|<a href="#metricingesterror">MetricIngestError</a>|
|
|
15343
|
+
|error|<a href="#metricingesterror" target="_blank" rel="noopener noreferrer">MetricIngestError</a>|
|
|
15245
15344
|
|linesInvalid|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
15246
15345
|
|linesOk|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|
|
|
15247
|
-
|warnings|<a href="#warnings"
|
|
15248
|
-
|
|
15249
|
-
### Value
|
|
15250
|
-
|
|
15251
|
-
|
|
15252
|
-
|
|
15253
|
-
|
|
15254
|
-
The information about settings value containing personal data.
|
|
15255
|
-
|
|
15256
|
-
| Name | Type | Description |
|
|
15257
|
-
| --- | --- | --- |
|
|
15258
|
-
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short summary of the settings object. This can contain Markdown and will be escaped accordingly. |
|
|
15259
|
-
|objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
15260
|
-
|pii<sup>*required</sup>|<a href="#pii">Pii</a>| |
|
|
15346
|
+
|warnings|<a href="#warnings">Warnings</a>|
|
|
15261
15347
|
|
|
15262
15348
|
### Vulnerability
|
|
15263
15349
|
|
|
@@ -15676,7 +15762,7 @@ The type of the ActiveGate.
|
|
|
15676
15762
|
|
|
15677
15763
|
<div class="padding-left--md">
|
|
15678
15764
|
|
|
15679
|
-
`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` | `RumCookieNamesRead` | `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`
|
|
15680
15766
|
|
|
15681
15767
|
</div>
|
|
15682
15768
|
|
|
@@ -15694,7 +15780,7 @@ The type of the ActiveGate.
|
|
|
15694
15780
|
|
|
15695
15781
|
<div class="padding-left--md">
|
|
15696
15782
|
|
|
15697
|
-
`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` | `RumCookieNamesRead` | `RumJavaScriptTagManagement` | `SecurityProblemsRead` | `SecurityProblemsWrite` | `
|
|
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`
|
|
15698
15784
|
|
|
15699
15785
|
</div>
|
|
15700
15786
|
|
|
@@ -15712,7 +15798,25 @@ The type of the ActiveGate.
|
|
|
15712
15798
|
|
|
15713
15799
|
<div class="padding-left--md">
|
|
15714
15800
|
|
|
15715
|
-
`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` | `RumCookieNamesRead` | `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`
|
|
15716
15820
|
|
|
15717
15821
|
</div>
|
|
15718
15822
|
|
|
@@ -16172,6 +16276,24 @@ The technology of the vulnerable component.
|
|
|
16172
16276
|
</div>
|
|
16173
16277
|
|
|
16174
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`
|
|
16293
|
+
|
|
16294
|
+
</div>
|
|
16295
|
+
|
|
16296
|
+
|
|
16175
16297
|
</div>
|
|
16176
16298
|
|
|
16177
16299
|
<a name="entrypointusagesegmentsegmenttype"></a>
|
|
@@ -17318,7 +17440,7 @@ The name of the monitoring state.
|
|
|
17318
17440
|
|
|
17319
17441
|
<div class="padding-left--md">
|
|
17320
17442
|
|
|
17321
|
-
`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`
|
|
17322
17444
|
|
|
17323
17445
|
</div>
|
|
17324
17446
|
|
|
@@ -17359,24 +17481,6 @@ The fallback mode of the network zone.
|
|
|
17359
17481
|
</div>
|
|
17360
17482
|
|
|
17361
17483
|
|
|
17362
|
-
</div>
|
|
17363
|
-
|
|
17364
|
-
<a name="piirelationshipsitem"></a>
|
|
17365
|
-
### PiiRelationshipsItem
|
|
17366
|
-
|
|
17367
|
-
<div class="padding-left--md">
|
|
17368
|
-
|
|
17369
|
-
|
|
17370
|
-
|
|
17371
|
-
#### Enum keys
|
|
17372
|
-
|
|
17373
|
-
<div class="padding-left--md">
|
|
17374
|
-
|
|
17375
|
-
`Creator` | `LastModifier` | `Modifier` | `Owner`
|
|
17376
|
-
|
|
17377
|
-
</div>
|
|
17378
|
-
|
|
17379
|
-
|
|
17380
17484
|
</div>
|
|
17381
17485
|
|
|
17382
17486
|
<a name="preconditiontype"></a>
|
|
@@ -17719,6 +17823,42 @@ The current state of the remediation progress entity.
|
|
|
17719
17823
|
</div>
|
|
17720
17824
|
|
|
17721
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
|
+
|
|
17722
17862
|
</div>
|
|
17723
17863
|
|
|
17724
17864
|
<a name="riskassessmentassessmentaccuracy"></a>
|
|
@@ -18525,7 +18665,7 @@ Aggregation type
|
|
|
18525
18665
|
|
|
18526
18666
|
<div class="padding-left--md">
|
|
18527
18667
|
|
|
18528
|
-
`
|
|
18668
|
+
`Avg` | `Max` | `Min`
|
|
18529
18669
|
|
|
18530
18670
|
</div>
|
|
18531
18671
|
|