@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.2.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 +15 -0
- package/README.md +863 -620
- package/cjs/index.js +10730 -7262
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +10761 -7113
- package/package.json +3 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +34 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +130 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +41 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +40 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +75 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +44 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +70 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +49 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/biz-event-ingest-result-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-envelope-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +1 -3
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-array-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/validation-response-error.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-slo-alert-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-config.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-global-auto-update-config.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/applied-filter.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attack.d.ts +30 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/attacker.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/code-location.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-type.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/custom-device-creation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-allowed-location-dto.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-stub.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entry-point-usage-segment.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-result.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/evidence.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-simple-results.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-step.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-event-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-status-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-upload-response-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/identity-type.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/identity-type.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/identity.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/identity.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/impact.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-definition.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-value-type.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-update-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/mute-state.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem-close-result.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +24 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-service.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-change.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/request-information.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resource-context.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment.d.ts +26 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +20 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +39 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.d.ts +8 -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 +13 -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 +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +23 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location-update.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-batch-status.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +21 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/tenant-token-config.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/token-credentials.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-table-customization.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/user-password-credentials.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups.d.ts +9 -0
- package/types/packages/http-client/src/lib/types/binary.d.ts +2 -2
- package/types/packages/http-client/src/lib/types/http-client-response.d.ts +2 -2
- package/types/packages/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/api-client-error.d.ts +1 -1
- package/types/packages/shared-errors/src/api-gateway-error.d.ts +18 -0
- package/types/packages/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/client-request-error.d.ts +3 -2
- package/types/packages/shared-errors/src/index.d.ts +6 -0
- package/types/packages/shared-errors/src/sdk-error.d.ts +5 -0
- package/types/packages/shared-errors/src/types.d.ts +31 -0
- /package/types/packages/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/invalid-response-error.d.ts +0 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @dynatrace-sdk/client-classic-environment-v2
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/3.2.0)
|
|
4
4
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
5
5
|
|
|
6
6
|
|
|
@@ -737,6 +737,55 @@ const data =
|
|
|
737
737
|
|
|
738
738
|
|
|
739
739
|
|
|
740
|
+
</div>
|
|
741
|
+
|
|
742
|
+
## activeGatesActiveGateGroupsClient
|
|
743
|
+
|
|
744
|
+
```js
|
|
745
|
+
import { activeGatesActiveGateGroupsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<a name="getactivegategroups"></a>
|
|
750
|
+
### getActiveGateGroups
|
|
751
|
+
|
|
752
|
+
<div class="padding-bottom--md">
|
|
753
|
+
<strong>activeGatesActiveGateGroupsClient.getActiveGateGroups(abortSignal?): Promise<<a href="#activegategroups">ActiveGateGroups</a>></strong>
|
|
754
|
+
|
|
755
|
+
<div class="padding-left--md">
|
|
756
|
+
|
|
757
|
+
Lists ActiveGate groups
|
|
758
|
+
|
|
759
|
+
**Required scope:** environment-api:activegates:read
|
|
760
|
+
**Required permission:** environment:roles:manage-settings
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
</div>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
#### Returns
|
|
769
|
+
|
|
770
|
+
Success
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
<details>
|
|
774
|
+
<summary>
|
|
775
|
+
Code example
|
|
776
|
+
</summary>
|
|
777
|
+
|
|
778
|
+
```ts
|
|
779
|
+
import { activeGatesActiveGateGroupsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
780
|
+
|
|
781
|
+
const data =
|
|
782
|
+
await activeGatesActiveGateGroupsClient.getActiveGateGroups();
|
|
783
|
+
```
|
|
784
|
+
|
|
785
|
+
</details>
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
740
789
|
</div>
|
|
741
790
|
|
|
742
791
|
## activeGatesAutoUpdateConfigurationClient
|
|
@@ -750,7 +799,7 @@ import { activeGatesAutoUpdateConfigurationClient } from '@dynatrace-sdk/client-
|
|
|
750
799
|
### getAutoUpdateConfigById
|
|
751
800
|
|
|
752
801
|
<div class="padding-bottom--md">
|
|
753
|
-
<strong>activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(config): Promise<<a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a>></strong>
|
|
802
|
+
<strong>activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(config): Promise<<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>></strong>
|
|
754
803
|
|
|
755
804
|
<div class="padding-left--md">
|
|
756
805
|
|
|
@@ -803,7 +852,7 @@ const data =
|
|
|
803
852
|
### getGlobalAutoUpdateConfigForTenant
|
|
804
853
|
|
|
805
854
|
<div class="padding-bottom--md">
|
|
806
|
-
<strong>activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant(abortSignal?): Promise<<a href="#activegateglobalautoupdateconfig"
|
|
855
|
+
<strong>activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant(abortSignal?): Promise<<a href="#activegateglobalautoupdateconfig">ActiveGateGlobalAutoUpdateConfig</a>></strong>
|
|
807
856
|
|
|
808
857
|
<div class="padding-left--md">
|
|
809
858
|
|
|
@@ -865,7 +914,7 @@ Updates the configuration of auto-update for the specified ActiveGate
|
|
|
865
914
|
| Name | Type | Description |
|
|
866
915
|
| --- | --- | --- |
|
|
867
916
|
|config.agId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required ActiveGate. |
|
|
868
|
-
|config.body<sup>*required</sup>|<a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a>| |
|
|
917
|
+
|config.body<sup>*required</sup>|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>| |
|
|
869
918
|
|
|
870
919
|
|
|
871
920
|
|
|
@@ -914,7 +963,7 @@ Puts the global auto-update configuration of environment ActiveGates.
|
|
|
914
963
|
|
|
915
964
|
| Name | Type |
|
|
916
965
|
| --- | --- |
|
|
917
|
-
|config.body<sup>*required</sup>|<a href="#activegateglobalautoupdateconfig"
|
|
966
|
+
|config.body<sup>*required</sup>|<a href="#activegateglobalautoupdateconfig">ActiveGateGlobalAutoUpdateConfig</a>|
|
|
918
967
|
|
|
919
968
|
|
|
920
969
|
|
|
@@ -964,7 +1013,7 @@ Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
|
|
|
964
1013
|
| Name | Type | Description |
|
|
965
1014
|
| --- | --- | --- |
|
|
966
1015
|
|config.agId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required ActiveGate. |
|
|
967
|
-
|config.body<sup>*required</sup>|<a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a>| |
|
|
1016
|
+
|config.body<sup>*required</sup>|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>| |
|
|
968
1017
|
|
|
969
1018
|
|
|
970
1019
|
|
|
@@ -1013,7 +1062,7 @@ Validates the payload for the `POST /activeGates/autoUpdate` request.
|
|
|
1013
1062
|
|
|
1014
1063
|
| Name | Type |
|
|
1015
1064
|
| --- | --- |
|
|
1016
|
-
|config.body<sup>*required</sup>|<a href="#activegateglobalautoupdateconfig"
|
|
1065
|
+
|config.body<sup>*required</sup>|<a href="#activegateglobalautoupdateconfig">ActiveGateGlobalAutoUpdateConfig</a>|
|
|
1017
1066
|
|
|
1018
1067
|
|
|
1019
1068
|
|
|
@@ -1050,7 +1099,7 @@ import { activeGatesAutoUpdateJobsClient } from '@dynatrace-sdk/client-classic-e
|
|
|
1050
1099
|
### createUpdateJobForAg
|
|
1051
1100
|
|
|
1052
1101
|
<div class="padding-bottom--md">
|
|
1053
|
-
<strong>activeGatesAutoUpdateJobsClient.createUpdateJobForAg(config): Promise<<a href="#updatejob">UpdateJob</a>></strong>
|
|
1102
|
+
<strong>activeGatesAutoUpdateJobsClient.createUpdateJobForAg(config): Promise<<a href="#updatejob" target="_blank" rel="noopener noreferrer">UpdateJob</a>></strong>
|
|
1054
1103
|
|
|
1055
1104
|
<div class="padding-left--md">
|
|
1056
1105
|
|
|
@@ -1069,7 +1118,7 @@ Creates a new update job for the specified ActiveGate
|
|
|
1069
1118
|
| Name | Type | Description |
|
|
1070
1119
|
| --- | --- | --- |
|
|
1071
1120
|
|config.agId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required ActiveGate. |
|
|
1072
|
-
|config.body<sup>*required</sup>|<a href="#updatejob"
|
|
1121
|
+
|config.body<sup>*required</sup>|<a href="#updatejob">UpdateJob</a>| |
|
|
1073
1122
|
|
|
1074
1123
|
|
|
1075
1124
|
|
|
@@ -1157,7 +1206,7 @@ const data =
|
|
|
1157
1206
|
### getAllUpdateJobList
|
|
1158
1207
|
|
|
1159
1208
|
<div class="padding-bottom--md">
|
|
1160
|
-
<strong>activeGatesAutoUpdateJobsClient.getAllUpdateJobList(config): Promise<<a href="#updatejobsall">UpdateJobsAll</a>></strong>
|
|
1209
|
+
<strong>activeGatesAutoUpdateJobsClient.getAllUpdateJobList(config): Promise<<a href="#updatejobsall" target="_blank" rel="noopener noreferrer">UpdateJobsAll</a>></strong>
|
|
1161
1210
|
|
|
1162
1211
|
<div class="padding-left--md">
|
|
1163
1212
|
|
|
@@ -1217,7 +1266,7 @@ const data =
|
|
|
1217
1266
|
### getUpdateJobByJobIdForAg
|
|
1218
1267
|
|
|
1219
1268
|
<div class="padding-bottom--md">
|
|
1220
|
-
<strong>activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(config): Promise<<a href="#updatejob"
|
|
1269
|
+
<strong>activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(config): Promise<<a href="#updatejob">UpdateJob</a>></strong>
|
|
1221
1270
|
|
|
1222
1271
|
<div class="padding-left--md">
|
|
1223
1272
|
|
|
@@ -1271,7 +1320,7 @@ const data =
|
|
|
1271
1320
|
### getUpdateJobListByAgId
|
|
1272
1321
|
|
|
1273
1322
|
<div class="padding-bottom--md">
|
|
1274
|
-
<strong>activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(config): Promise<<a href="#updatejoblist">UpdateJobList</a>></strong>
|
|
1323
|
+
<strong>activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(config): Promise<<a href="#updatejoblist" target="_blank" rel="noopener noreferrer">UpdateJobList</a>></strong>
|
|
1275
1324
|
|
|
1276
1325
|
<div class="padding-left--md">
|
|
1277
1326
|
|
|
@@ -1353,7 +1402,7 @@ Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
|
|
|
1353
1402
|
| Name | Type | Description |
|
|
1354
1403
|
| --- | --- | --- |
|
|
1355
1404
|
|config.agId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required ActiveGate. |
|
|
1356
|
-
|config.body<sup>*required</sup>|<a href="#updatejob"
|
|
1405
|
+
|config.body<sup>*required</sup>|<a href="#updatejob">UpdateJob</a>| |
|
|
1357
1406
|
|
|
1358
1407
|
|
|
1359
1408
|
|
|
@@ -1393,7 +1442,7 @@ import { activeGatesClient } from '@dynatrace-sdk/client-classic-environment-v2'
|
|
|
1393
1442
|
### getAllActiveGates
|
|
1394
1443
|
|
|
1395
1444
|
<div class="padding-bottom--md">
|
|
1396
|
-
<strong>activeGatesClient.getAllActiveGates(config): Promise<<a href="#activegatelist">ActiveGateList</a>></strong>
|
|
1445
|
+
<strong>activeGatesClient.getAllActiveGates(config): Promise<<a href="#activegatelist" target="_blank" rel="noopener noreferrer">ActiveGateList</a>></strong>
|
|
1397
1446
|
|
|
1398
1447
|
<div class="padding-left--md">
|
|
1399
1448
|
|
|
@@ -1462,7 +1511,7 @@ const data = await activeGatesClient.getAllActiveGates();
|
|
|
1462
1511
|
### getOneActiveGateById
|
|
1463
1512
|
|
|
1464
1513
|
<div class="padding-bottom--md">
|
|
1465
|
-
<strong>activeGatesClient.getOneActiveGateById(config): Promise<<a href="#activegate"
|
|
1514
|
+
<strong>activeGatesClient.getOneActiveGateById(config): Promise<<a href="#activegate">ActiveGate</a>></strong>
|
|
1466
1515
|
|
|
1467
1516
|
<div class="padding-left--md">
|
|
1468
1517
|
|
|
@@ -1520,7 +1569,7 @@ import { attacksClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
1520
1569
|
### getAttack
|
|
1521
1570
|
|
|
1522
1571
|
<div class="padding-bottom--md">
|
|
1523
|
-
<strong>attacksClient.getAttack(config): Promise<<a href="#attack">Attack</a>></strong>
|
|
1572
|
+
<strong>attacksClient.getAttack(config): Promise<<a href="#attack" target="_blank" rel="noopener noreferrer">Attack</a>></strong>
|
|
1524
1573
|
|
|
1525
1574
|
<div class="padding-left--md">
|
|
1526
1575
|
|
|
@@ -1573,7 +1622,7 @@ const data = await attacksClient.getAttack({ id: "..." });
|
|
|
1573
1622
|
### getAttacks
|
|
1574
1623
|
|
|
1575
1624
|
<div class="padding-bottom--md">
|
|
1576
|
-
<strong>attacksClient.getAttacks(config): Promise<<a href="#attacklist"
|
|
1625
|
+
<strong>attacksClient.getAttacks(config): Promise<<a href="#attacklist">AttackList</a>></strong>
|
|
1577
1626
|
|
|
1578
1627
|
<div class="padding-left--md">
|
|
1579
1628
|
|
|
@@ -1637,7 +1686,7 @@ import { auditLogsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
1637
1686
|
### getLog
|
|
1638
1687
|
|
|
1639
1688
|
<div class="padding-bottom--md">
|
|
1640
|
-
<strong>auditLogsClient.getLog(config): Promise<<a href="#auditlogentry">AuditLogEntry</a>></strong>
|
|
1689
|
+
<strong>auditLogsClient.getLog(config): Promise<<a href="#auditlogentry" target="_blank" rel="noopener noreferrer">AuditLogEntry</a>></strong>
|
|
1641
1690
|
|
|
1642
1691
|
<div class="padding-left--md">
|
|
1643
1692
|
|
|
@@ -1687,7 +1736,7 @@ const data = await auditLogsClient.getLog({ id: "..." });
|
|
|
1687
1736
|
### getLogs
|
|
1688
1737
|
|
|
1689
1738
|
<div class="padding-bottom--md">
|
|
1690
|
-
<strong>auditLogsClient.getLogs(config): Promise<<a href="#auditlog"
|
|
1739
|
+
<strong>auditLogsClient.getLogs(config): Promise<<a href="#auditlog">AuditLog</a>></strong>
|
|
1691
1740
|
|
|
1692
1741
|
<div class="padding-left--md">
|
|
1693
1742
|
|
|
@@ -1774,7 +1823,7 @@ The ingestion of business events is subject to licensing (see [licensing documen
|
|
|
1774
1823
|
|
|
1775
1824
|
| Name | Type |
|
|
1776
1825
|
| --- | --- |
|
|
1777
|
-
|config.body<sup>*required</sup>|<a href="#cloudevent">CloudEvent</a> | Array<<a href="#cloudevent"
|
|
1826
|
+
|config.body<sup>*required</sup>|<a href="#cloudevent" target="_blank" rel="noopener noreferrer">CloudEvent</a> | Array<<a href="#cloudevent">CloudEvent</a>> | IngestBody|
|
|
1778
1827
|
|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
1828
|
|
|
1780
1829
|
|
|
@@ -1833,7 +1882,7 @@ import { credentialVaultClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
1833
1882
|
### createCredentials
|
|
1834
1883
|
|
|
1835
1884
|
<div class="padding-bottom--md">
|
|
1836
|
-
<strong>credentialVaultClient.createCredentials(config): Promise<<a href="#credentialsid">CredentialsId</a>></strong>
|
|
1885
|
+
<strong>credentialVaultClient.createCredentials(config): Promise<<a href="#credentialsid" target="_blank" rel="noopener noreferrer">CredentialsId</a>></strong>
|
|
1837
1886
|
|
|
1838
1887
|
<div class="padding-left--md">
|
|
1839
1888
|
|
|
@@ -1853,7 +1902,7 @@ The body must not provide an ID. An ID is assigned automatically by the Dynatrac
|
|
|
1853
1902
|
|
|
1854
1903
|
| Name | Type |
|
|
1855
1904
|
| --- | --- |
|
|
1856
|
-
|config.body<sup>*required</sup>|<a href="#credentials"
|
|
1905
|
+
|config.body<sup>*required</sup>|<a href="#credentials">Credentials</a>|
|
|
1857
1906
|
|
|
1858
1907
|
|
|
1859
1908
|
|
|
@@ -1890,7 +1939,7 @@ const data = await credentialVaultClient.createCredentials({
|
|
|
1890
1939
|
### getCredentials
|
|
1891
1940
|
|
|
1892
1941
|
<div class="padding-bottom--md">
|
|
1893
|
-
<strong>credentialVaultClient.getCredentials(config): Promise<<a href="#credentialsresponseelement">CredentialsResponseElement</a>></strong>
|
|
1942
|
+
<strong>credentialVaultClient.getCredentials(config): Promise<<a href="#credentialsresponseelement" target="_blank" rel="noopener noreferrer">CredentialsResponseElement</a>></strong>
|
|
1894
1943
|
|
|
1895
1944
|
<div class="padding-left--md">
|
|
1896
1945
|
|
|
@@ -1944,7 +1993,7 @@ const data = await credentialVaultClient.getCredentials({
|
|
|
1944
1993
|
### getCredentialsDetails
|
|
1945
1994
|
|
|
1946
1995
|
<div class="padding-bottom--md">
|
|
1947
|
-
<strong>credentialVaultClient.getCredentialsDetails(config): Promise<<a href="#abstractcredentialsresponseelement"
|
|
1996
|
+
<strong>credentialVaultClient.getCredentialsDetails(config): Promise<<a href="#abstractcredentialsresponseelement">AbstractCredentialsResponseElement</a>></strong>
|
|
1948
1997
|
|
|
1949
1998
|
<div class="padding-left--md">
|
|
1950
1999
|
|
|
@@ -1998,7 +2047,7 @@ const data =
|
|
|
1998
2047
|
### listCredentials
|
|
1999
2048
|
|
|
2000
2049
|
<div class="padding-bottom--md">
|
|
2001
|
-
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist">CredentialsList</a>></strong>
|
|
2050
|
+
<strong>credentialVaultClient.listCredentials(config): Promise<<a href="#credentialslist" target="_blank" rel="noopener noreferrer">CredentialsList</a>></strong>
|
|
2002
2051
|
|
|
2003
2052
|
<div class="padding-left--md">
|
|
2004
2053
|
|
|
@@ -2105,7 +2154,7 @@ const data = await credentialVaultClient.removeCredentials({
|
|
|
2105
2154
|
### updateCredentials
|
|
2106
2155
|
|
|
2107
2156
|
<div class="padding-bottom--md">
|
|
2108
|
-
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid"
|
|
2157
|
+
<strong>credentialVaultClient.updateCredentials(config): Promise<void | <a href="#credentialsid">CredentialsId</a>></strong>
|
|
2109
2158
|
|
|
2110
2159
|
<div class="padding-left--md">
|
|
2111
2160
|
|
|
@@ -2125,7 +2174,7 @@ The body must not provide an ID. The ID should be provided in the path.
|
|
|
2125
2174
|
|
|
2126
2175
|
| Name | Type | Description |
|
|
2127
2176
|
| --- | --- | --- |
|
|
2128
|
-
|config.body<sup>*required</sup>|<a href="#credentials">Credentials</a>| |
|
|
2177
|
+
|config.body<sup>*required</sup>|<a href="#credentials" target="_blank" rel="noopener noreferrer">Credentials</a>| |
|
|
2129
2178
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the credentials set to be updated. |
|
|
2130
2179
|
|
|
2131
2180
|
|
|
@@ -2170,7 +2219,7 @@ import { davisSecurityAdvisorClient } from '@dynatrace-sdk/client-classic-enviro
|
|
|
2170
2219
|
### getAdviceForSecurityProblems
|
|
2171
2220
|
|
|
2172
2221
|
<div class="padding-bottom--md">
|
|
2173
|
-
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist"
|
|
2222
|
+
<strong>davisSecurityAdvisorClient.getAdviceForSecurityProblems(config): Promise<<a href="#davissecurityadvicelist">DavisSecurityAdviceList</a>></strong>
|
|
2174
2223
|
|
|
2175
2224
|
<div class="padding-left--md">
|
|
2176
2225
|
|
|
@@ -2235,7 +2284,7 @@ import { eventsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
2235
2284
|
### createEvent
|
|
2236
2285
|
|
|
2237
2286
|
<div class="padding-bottom--md">
|
|
2238
|
-
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults">EventIngestResults</a>></strong>
|
|
2287
|
+
<strong>eventsClient.createEvent(config): Promise<<a href="#eventingestresults" target="_blank" rel="noopener noreferrer">EventIngestResults</a>></strong>
|
|
2239
2288
|
|
|
2240
2289
|
<div class="padding-left--md">
|
|
2241
2290
|
|
|
@@ -2263,7 +2312,7 @@ The ingestion of custom events is subject to licensing (see [licensing documenta
|
|
|
2263
2312
|
|
|
2264
2313
|
| Name | Type |
|
|
2265
2314
|
| --- | --- |
|
|
2266
|
-
|config.body<sup>*required</sup>|<a href="#eventingest"
|
|
2315
|
+
|config.body<sup>*required</sup>|<a href="#eventingest">EventIngest</a>|
|
|
2267
2316
|
|
|
2268
2317
|
|
|
2269
2318
|
|
|
@@ -2297,7 +2346,7 @@ const data = await eventsClient.createEvent({
|
|
|
2297
2346
|
### getEvent
|
|
2298
2347
|
|
|
2299
2348
|
<div class="padding-bottom--md">
|
|
2300
|
-
<strong>eventsClient.getEvent(config): Promise<<a href="#event">Event</a>></strong>
|
|
2349
|
+
<strong>eventsClient.getEvent(config): Promise<<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>></strong>
|
|
2301
2350
|
|
|
2302
2351
|
<div class="padding-left--md">
|
|
2303
2352
|
|
|
@@ -2349,7 +2398,7 @@ const data = await eventsClient.getEvent({
|
|
|
2349
2398
|
### getEventProperties
|
|
2350
2399
|
|
|
2351
2400
|
<div class="padding-bottom--md">
|
|
2352
|
-
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist"
|
|
2401
|
+
<strong>eventsClient.getEventProperties(config): Promise<<a href="#eventpropertieslist">EventPropertiesList</a>></strong>
|
|
2353
2402
|
|
|
2354
2403
|
<div class="padding-left--md">
|
|
2355
2404
|
|
|
@@ -2400,7 +2449,7 @@ const data = await eventsClient.getEventProperties();
|
|
|
2400
2449
|
### getEventProperty
|
|
2401
2450
|
|
|
2402
2451
|
<div class="padding-bottom--md">
|
|
2403
|
-
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails">EventPropertyDetails</a>></strong>
|
|
2452
|
+
<strong>eventsClient.getEventProperty(config): Promise<<a href="#eventpropertydetails" target="_blank" rel="noopener noreferrer">EventPropertyDetails</a>></strong>
|
|
2404
2453
|
|
|
2405
2454
|
<div class="padding-left--md">
|
|
2406
2455
|
|
|
@@ -2452,7 +2501,7 @@ const data = await eventsClient.getEventProperty({
|
|
|
2452
2501
|
### getEventType
|
|
2453
2502
|
|
|
2454
2503
|
<div class="padding-bottom--md">
|
|
2455
|
-
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype"
|
|
2504
|
+
<strong>eventsClient.getEventType(config): Promise<<a href="#eventtype">EventType</a>></strong>
|
|
2456
2505
|
|
|
2457
2506
|
<div class="padding-left--md">
|
|
2458
2507
|
|
|
@@ -2504,7 +2553,7 @@ const data = await eventsClient.getEventType({
|
|
|
2504
2553
|
### getEventTypes
|
|
2505
2554
|
|
|
2506
2555
|
<div class="padding-bottom--md">
|
|
2507
|
-
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist">EventTypeList</a>></strong>
|
|
2556
|
+
<strong>eventsClient.getEventTypes(config): Promise<<a href="#eventtypelist" target="_blank" rel="noopener noreferrer">EventTypeList</a>></strong>
|
|
2508
2557
|
|
|
2509
2558
|
<div class="padding-left--md">
|
|
2510
2559
|
|
|
@@ -2555,7 +2604,7 @@ const data = await eventsClient.getEventTypes();
|
|
|
2555
2604
|
### getEvents
|
|
2556
2605
|
|
|
2557
2606
|
<div class="padding-bottom--md">
|
|
2558
|
-
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist"
|
|
2607
|
+
<strong>eventsClient.getEvents(config): Promise<<a href="#eventlist">EventList</a>></strong>
|
|
2559
2608
|
|
|
2560
2609
|
<div class="padding-left--md">
|
|
2561
2610
|
|
|
@@ -2616,7 +2665,7 @@ import { extensions_2_0Client } from '@dynatrace-sdk/client-classic-environment-
|
|
|
2616
2665
|
### activateExtensionEnvironmentConfiguration
|
|
2617
2666
|
|
|
2618
2667
|
<div class="padding-bottom--md">
|
|
2619
|
-
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
2668
|
+
<strong>extensions_2_0Client.activateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
2620
2669
|
|
|
2621
2670
|
<div class="padding-left--md">
|
|
2622
2671
|
|
|
@@ -2636,7 +2685,7 @@ Activates the environment configuration from the specified version of the extens
|
|
|
2636
2685
|
|
|
2637
2686
|
| Name | Type | Description |
|
|
2638
2687
|
| --- | --- | --- |
|
|
2639
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion"
|
|
2688
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
2640
2689
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
2641
2690
|
|
|
2642
2691
|
|
|
@@ -2672,7 +2721,7 @@ const data =
|
|
|
2672
2721
|
### createMonitoringConfiguration
|
|
2673
2722
|
|
|
2674
2723
|
<div class="padding-bottom--md">
|
|
2675
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
2724
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#monitoringconfigurationresponse" target="_blank" rel="noopener noreferrer">MonitoringConfigurationResponse</a>>></strong>
|
|
2676
2725
|
|
|
2677
2726
|
<div class="padding-left--md">
|
|
2678
2727
|
|
|
@@ -2692,7 +2741,7 @@ Creates new monitoring configuration for the specified extension 2.0
|
|
|
2692
2741
|
|
|
2693
2742
|
| Name | Type | Description |
|
|
2694
2743
|
| --- | --- | --- |
|
|
2695
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto"
|
|
2744
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
2696
2745
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
2697
2746
|
|
|
2698
2747
|
|
|
@@ -2725,7 +2774,7 @@ const data =
|
|
|
2725
2774
|
</div>
|
|
2726
2775
|
|
|
2727
2776
|
<div class="padding-bottom--md">
|
|
2728
|
-
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse"
|
|
2777
|
+
<strong>extensions_2_0Client.createMonitoringConfiguration(config): Promise<Array<<a href="#errorenvelope" target="_blank" rel="noopener noreferrer">ErrorEnvelope</a> | <a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>>></strong>
|
|
2729
2778
|
|
|
2730
2779
|
<div class="padding-left--md">
|
|
2731
2780
|
|
|
@@ -2740,7 +2789,7 @@ const data =
|
|
|
2740
2789
|
|
|
2741
2790
|
| Name | Type | Description |
|
|
2742
2791
|
| --- | --- | --- |
|
|
2743
|
-
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto">MonitoringConfigurationDto</a>>| |
|
|
2792
|
+
|config.body<sup>*required</sup>|Array<<a href="#monitoringconfigurationdto" target="_blank" rel="noopener noreferrer">MonitoringConfigurationDto</a>>| |
|
|
2744
2793
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
2745
2794
|
|
|
2746
2795
|
|
|
@@ -2756,7 +2805,7 @@ const data =
|
|
|
2756
2805
|
### deleteEnvironmentConfiguration
|
|
2757
2806
|
|
|
2758
2807
|
<div class="padding-bottom--md">
|
|
2759
|
-
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
2808
|
+
<strong>extensions_2_0Client.deleteEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
2760
2809
|
|
|
2761
2810
|
<div class="padding-left--md">
|
|
2762
2811
|
|
|
@@ -2811,7 +2860,7 @@ const data =
|
|
|
2811
2860
|
### executeExtensionMonitoringConfigurationActions
|
|
2812
2861
|
|
|
2813
2862
|
<div class="padding-bottom--md">
|
|
2814
|
-
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse">ExecuteActionsResponse</a>></strong>
|
|
2863
|
+
<strong>extensions_2_0Client.executeExtensionMonitoringConfigurationActions(config): Promise<<a href="#executeactionsresponse" target="_blank" rel="noopener noreferrer">ExecuteActionsResponse</a>></strong>
|
|
2815
2864
|
|
|
2816
2865
|
<div class="padding-left--md">
|
|
2817
2866
|
|
|
@@ -2831,7 +2880,7 @@ Executes Data Source action of Active Gate or Host
|
|
|
2831
2880
|
|
|
2832
2881
|
| Name | Type | Description |
|
|
2833
2882
|
| --- | --- | --- |
|
|
2834
|
-
|config.body<sup>*required</sup>|<a href="#executeactionsdto"
|
|
2883
|
+
|config.body<sup>*required</sup>|<a href="#executeactionsdto">ExecuteActionsDto</a>| |
|
|
2835
2884
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
2836
2885
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
2837
2886
|
|
|
@@ -2872,7 +2921,7 @@ const data =
|
|
|
2872
2921
|
### extensionConfigurationSchema
|
|
2873
2922
|
|
|
2874
2923
|
<div class="padding-bottom--md">
|
|
2875
|
-
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto">SchemaDefinitionRestDto</a>></strong>
|
|
2924
|
+
<strong>extensions_2_0Client.extensionConfigurationSchema(config): Promise<<a href="#schemadefinitionrestdto" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDto</a>></strong>
|
|
2876
2925
|
|
|
2877
2926
|
<div class="padding-left--md">
|
|
2878
2927
|
|
|
@@ -2929,7 +2978,7 @@ const data =
|
|
|
2929
2978
|
### extensionDetails
|
|
2930
2979
|
|
|
2931
2980
|
<div class="padding-bottom--md">
|
|
2932
|
-
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension"
|
|
2981
|
+
<strong>extensions_2_0Client.extensionDetails(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
2933
2982
|
|
|
2934
2983
|
<div class="padding-left--md">
|
|
2935
2984
|
|
|
@@ -3015,7 +3064,7 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
3015
3064
|
### extensionMonitoringConfigurations
|
|
3016
3065
|
|
|
3017
3066
|
<div class="padding-bottom--md">
|
|
3018
|
-
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
3067
|
+
<strong>extensions_2_0Client.extensionMonitoringConfigurations(config): Promise<<a href="#extensionmonitoringconfigurationslist" target="_blank" rel="noopener noreferrer">ExtensionMonitoringConfigurationsList</a>></strong>
|
|
3019
3068
|
|
|
3020
3069
|
<div class="padding-left--md">
|
|
3021
3070
|
|
|
@@ -3074,7 +3123,7 @@ const data =
|
|
|
3074
3123
|
### getActiveEnvironmentConfiguration
|
|
3075
3124
|
|
|
3076
3125
|
<div class="padding-bottom--md">
|
|
3077
|
-
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
3126
|
+
<strong>extensions_2_0Client.getActiveEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3078
3127
|
|
|
3079
3128
|
<div class="padding-left--md">
|
|
3080
3129
|
|
|
@@ -3129,7 +3178,7 @@ const data =
|
|
|
3129
3178
|
### getActiveGateGroupsInfo
|
|
3130
3179
|
|
|
3131
3180
|
<div class="padding-bottom--md">
|
|
3132
|
-
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto">ActiveGateGroupsInfoDto</a>></strong>
|
|
3181
|
+
<strong>extensions_2_0Client.getActiveGateGroupsInfo(config): Promise<<a href="#activegategroupsinfodto" target="_blank" rel="noopener noreferrer">ActiveGateGroupsInfoDto</a>></strong>
|
|
3133
3182
|
|
|
3134
3183
|
<div class="padding-left--md">
|
|
3135
3184
|
|
|
@@ -3186,7 +3235,7 @@ const data =
|
|
|
3186
3235
|
### getEnvironmentConfigurationAssetsInfo
|
|
3187
3236
|
|
|
3188
3237
|
<div class="padding-bottom--md">
|
|
3189
|
-
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto"
|
|
3238
|
+
<strong>extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(config): Promise<<a href="#extensionassetsdto">ExtensionAssetsDto</a>></strong>
|
|
3190
3239
|
|
|
3191
3240
|
<div class="padding-left--md">
|
|
3192
3241
|
|
|
@@ -3241,7 +3290,7 @@ const data =
|
|
|
3241
3290
|
### getEnvironmentConfigurationEvents
|
|
3242
3291
|
|
|
3243
3292
|
<div class="padding-bottom--md">
|
|
3244
|
-
<strong>extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<<a href="#extensioneventslist">ExtensionEventsList</a>></strong>
|
|
3293
|
+
<strong>extensions_2_0Client.getEnvironmentConfigurationEvents(config): Promise<<a href="#extensioneventslist" target="_blank" rel="noopener noreferrer">ExtensionEventsList</a>></strong>
|
|
3245
3294
|
|
|
3246
3295
|
<div class="padding-left--md">
|
|
3247
3296
|
|
|
@@ -3300,7 +3349,7 @@ const data =
|
|
|
3300
3349
|
### getExtensionMonitoringConfigurationEvents
|
|
3301
3350
|
|
|
3302
3351
|
<div class="padding-bottom--md">
|
|
3303
|
-
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<<a href="#extensioneventslist"
|
|
3352
|
+
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationEvents(config): Promise<<a href="#extensioneventslist">ExtensionEventsList</a>></strong>
|
|
3304
3353
|
|
|
3305
3354
|
<div class="padding-left--md">
|
|
3306
3355
|
|
|
@@ -3363,7 +3412,7 @@ const data =
|
|
|
3363
3412
|
### getExtensionMonitoringConfigurationStatus
|
|
3364
3413
|
|
|
3365
3414
|
<div class="padding-bottom--md">
|
|
3366
|
-
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto">ExtensionStatusDto</a>></strong>
|
|
3415
|
+
<strong>extensions_2_0Client.getExtensionMonitoringConfigurationStatus(config): Promise<<a href="#extensionstatusdto" target="_blank" rel="noopener noreferrer">ExtensionStatusDto</a>></strong>
|
|
3367
3416
|
|
|
3368
3417
|
<div class="padding-left--md">
|
|
3369
3418
|
|
|
@@ -3475,7 +3524,7 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
3475
3524
|
### installExtension
|
|
3476
3525
|
|
|
3477
3526
|
<div class="padding-bottom--md">
|
|
3478
|
-
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto"
|
|
3527
|
+
<strong>extensions_2_0Client.installExtension(config): Promise<<a href="#registeredextensionresultdto">RegisteredExtensionResultDto</a>></strong>
|
|
3479
3528
|
|
|
3480
3529
|
<div class="padding-left--md">
|
|
3481
3530
|
|
|
@@ -3530,7 +3579,7 @@ const data = await extensions_2_0Client.installExtension({
|
|
|
3530
3579
|
### listExtensionInfos
|
|
3531
3580
|
|
|
3532
3581
|
<div class="padding-bottom--md">
|
|
3533
|
-
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist">ExtensionInfoList</a>></strong>
|
|
3582
|
+
<strong>extensions_2_0Client.listExtensionInfos(config): Promise<<a href="#extensioninfolist" target="_blank" rel="noopener noreferrer">ExtensionInfoList</a>></strong>
|
|
3534
3583
|
|
|
3535
3584
|
<div class="padding-left--md">
|
|
3536
3585
|
|
|
@@ -3585,7 +3634,7 @@ const data =
|
|
|
3585
3634
|
### listExtensionVersions
|
|
3586
3635
|
|
|
3587
3636
|
<div class="padding-bottom--md">
|
|
3588
|
-
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist"
|
|
3637
|
+
<strong>extensions_2_0Client.listExtensionVersions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
3589
3638
|
|
|
3590
3639
|
<div class="padding-left--md">
|
|
3591
3640
|
|
|
@@ -3642,7 +3691,7 @@ const data =
|
|
|
3642
3691
|
### listExtensions
|
|
3643
3692
|
|
|
3644
3693
|
<div class="padding-bottom--md">
|
|
3645
|
-
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist">ExtensionList</a>></strong>
|
|
3694
|
+
<strong>extensions_2_0Client.listExtensions(config): Promise<<a href="#extensionlist" target="_blank" rel="noopener noreferrer">ExtensionList</a>></strong>
|
|
3646
3695
|
|
|
3647
3696
|
<div class="padding-left--md">
|
|
3648
3697
|
|
|
@@ -3696,7 +3745,7 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
3696
3745
|
### listSchemaFiles
|
|
3697
3746
|
|
|
3698
3747
|
<div class="padding-bottom--md">
|
|
3699
|
-
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles"
|
|
3748
|
+
<strong>extensions_2_0Client.listSchemaFiles(config): Promise<<a href="#schemafiles">SchemaFiles</a>></strong>
|
|
3700
3749
|
|
|
3701
3750
|
<div class="padding-left--md">
|
|
3702
3751
|
|
|
@@ -3779,7 +3828,7 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
3779
3828
|
### listSchemas
|
|
3780
3829
|
|
|
3781
3830
|
<div class="padding-bottom--md">
|
|
3782
|
-
<strong>extensions_2_0Client.listSchemas(abortSignal?): Promise<<a href="#schemaslist">SchemasList</a>></strong>
|
|
3831
|
+
<strong>extensions_2_0Client.listSchemas(abortSignal?): Promise<<a href="#schemaslist" target="_blank" rel="noopener noreferrer">SchemasList</a>></strong>
|
|
3783
3832
|
|
|
3784
3833
|
<div class="padding-left--md">
|
|
3785
3834
|
|
|
@@ -3823,7 +3872,7 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
3823
3872
|
### monitoringConfigurationDetails
|
|
3824
3873
|
|
|
3825
3874
|
<div class="padding-bottom--md">
|
|
3826
|
-
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration"
|
|
3875
|
+
<strong>extensions_2_0Client.monitoringConfigurationDetails(config): Promise<<a href="#extensionmonitoringconfiguration">ExtensionMonitoringConfiguration</a>></strong>
|
|
3827
3876
|
|
|
3828
3877
|
<div class="padding-left--md">
|
|
3829
3878
|
|
|
@@ -3879,7 +3928,7 @@ const data =
|
|
|
3879
3928
|
### removeExtension
|
|
3880
3929
|
|
|
3881
3930
|
<div class="padding-bottom--md">
|
|
3882
|
-
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension">Extension</a>></strong>
|
|
3931
|
+
<strong>extensions_2_0Client.removeExtension(config): Promise<<a href="#extension" target="_blank" rel="noopener noreferrer">Extension</a>></strong>
|
|
3883
3932
|
|
|
3884
3933
|
<div class="padding-left--md">
|
|
3885
3934
|
|
|
@@ -3988,7 +4037,7 @@ const data =
|
|
|
3988
4037
|
### updateExtensionEnvironmentConfiguration
|
|
3989
4038
|
|
|
3990
4039
|
<div class="padding-bottom--md">
|
|
3991
|
-
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion"
|
|
4040
|
+
<strong>extensions_2_0Client.updateExtensionEnvironmentConfiguration(config): Promise<<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>></strong>
|
|
3992
4041
|
|
|
3993
4042
|
<div class="padding-left--md">
|
|
3994
4043
|
|
|
@@ -4008,7 +4057,7 @@ Updates the active environment configuration version of the extension 2.0
|
|
|
4008
4057
|
|
|
4009
4058
|
| Name | Type | Description |
|
|
4010
4059
|
| --- | --- | --- |
|
|
4011
|
-
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
4060
|
+
|config.body<sup>*required</sup>|<a href="#extensionenvironmentconfigurationversion" target="_blank" rel="noopener noreferrer">ExtensionEnvironmentConfigurationVersion</a>| |
|
|
4012
4061
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4013
4062
|
|
|
4014
4063
|
|
|
@@ -4044,7 +4093,7 @@ const data =
|
|
|
4044
4093
|
### updateMonitoringConfiguration
|
|
4045
4094
|
|
|
4046
4095
|
<div class="padding-bottom--md">
|
|
4047
|
-
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse"
|
|
4096
|
+
<strong>extensions_2_0Client.updateMonitoringConfiguration(config): Promise<<a href="#monitoringconfigurationresponse">MonitoringConfigurationResponse</a>></strong>
|
|
4048
4097
|
|
|
4049
4098
|
<div class="padding-left--md">
|
|
4050
4099
|
|
|
@@ -4064,7 +4113,7 @@ Updates the specified monitoring configuration
|
|
|
4064
4113
|
|
|
4065
4114
|
| Name | Type | Description |
|
|
4066
4115
|
| --- | --- | --- |
|
|
4067
|
-
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto">MonitoringConfigurationUpdateDto</a>| |
|
|
4116
|
+
|config.body<sup>*required</sup>|<a href="#monitoringconfigurationupdatedto" target="_blank" rel="noopener noreferrer">MonitoringConfigurationUpdateDto</a>| |
|
|
4068
4117
|
|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |
|
|
4069
4118
|
|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested extension 2.0. |
|
|
4070
4119
|
|
|
@@ -4103,7 +4152,7 @@ const data =
|
|
|
4103
4152
|
### uploadExtension
|
|
4104
4153
|
|
|
4105
4154
|
<div class="padding-bottom--md">
|
|
4106
|
-
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto"
|
|
4155
|
+
<strong>extensions_2_0Client.uploadExtension(config): Promise<<a href="#extensionuploadresponsedto">ExtensionUploadResponseDto</a>></strong>
|
|
4107
4156
|
|
|
4108
4157
|
<div class="padding-left--md">
|
|
4109
4158
|
|
|
@@ -4164,7 +4213,7 @@ import { logsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
4164
4213
|
### exportLogRecords
|
|
4165
4214
|
|
|
4166
4215
|
<div class="padding-bottom--md">
|
|
4167
|
-
<strong>logsClient.exportLogRecords(config): Promise<<a href="#exportedlogrecordlist">ExportedLogRecordList</a>></strong>
|
|
4216
|
+
<strong>logsClient.exportLogRecords(config): Promise<<a href="#exportedlogrecordlist" target="_blank" rel="noopener noreferrer">ExportedLogRecordList</a>></strong>
|
|
4168
4217
|
|
|
4169
4218
|
<div class="padding-left--md">
|
|
4170
4219
|
|
|
@@ -4231,7 +4280,7 @@ const data = await logsClient.exportLogRecords();
|
|
|
4231
4280
|
### getLogHistogramData
|
|
4232
4281
|
|
|
4233
4282
|
<div class="padding-bottom--md">
|
|
4234
|
-
<strong>logsClient.getLogHistogramData(config): Promise<<a href="#aggregatedlog"
|
|
4283
|
+
<strong>logsClient.getLogHistogramData(config): Promise<<a href="#aggregatedlog">AggregatedLog</a>></strong>
|
|
4235
4284
|
|
|
4236
4285
|
<div class="padding-left--md">
|
|
4237
4286
|
|
|
@@ -4298,7 +4347,7 @@ const data = await logsClient.getLogHistogramData();
|
|
|
4298
4347
|
### getLogRecords
|
|
4299
4348
|
|
|
4300
4349
|
<div class="padding-bottom--md">
|
|
4301
|
-
<strong>logsClient.getLogRecords(config): Promise<<a href="#logrecordslist">LogRecordsList</a>></strong>
|
|
4350
|
+
<strong>logsClient.getLogRecords(config): Promise<<a href="#logrecordslist" target="_blank" rel="noopener noreferrer">LogRecordsList</a>></strong>
|
|
4302
4351
|
|
|
4303
4352
|
<div class="padding-left--md">
|
|
4304
4353
|
|
|
@@ -4367,7 +4416,7 @@ const data = await logsClient.getLogRecords();
|
|
|
4367
4416
|
### storeLog
|
|
4368
4417
|
|
|
4369
4418
|
<div class="padding-bottom--md">
|
|
4370
|
-
<strong>logsClient.storeLog(config): Promise<void | <a href="#successenvelope"
|
|
4419
|
+
<strong>logsClient.storeLog(config): Promise<void | <a href="#successenvelope">SuccessEnvelope</a>></strong>
|
|
4371
4420
|
|
|
4372
4421
|
<div class="padding-left--md">
|
|
4373
4422
|
|
|
@@ -4491,7 +4540,7 @@ import { metricsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
4491
4540
|
### allMetrics
|
|
4492
4541
|
|
|
4493
4542
|
<div class="padding-bottom--md">
|
|
4494
|
-
<strong>metricsClient.allMetrics(config): Promise<<a href="#metricdescriptorcollection">MetricDescriptorCollection</a>></strong>
|
|
4543
|
+
<strong>metricsClient.allMetrics(config): Promise<<a href="#metricdescriptorcollection" target="_blank" rel="noopener noreferrer">MetricDescriptorCollection</a>></strong>
|
|
4495
4544
|
|
|
4496
4545
|
<div class="padding-left--md">
|
|
4497
4546
|
|
|
@@ -4608,7 +4657,7 @@ const data = await metricsClient.delete({
|
|
|
4608
4657
|
### ingest
|
|
4609
4658
|
|
|
4610
4659
|
<div class="padding-bottom--md">
|
|
4611
|
-
<strong>metricsClient.ingest(config): Promise<<a href="#validationresponse"
|
|
4660
|
+
<strong>metricsClient.ingest(config): Promise<<a href="#validationresponse">ValidationResponse</a>></strong>
|
|
4612
4661
|
|
|
4613
4662
|
<div class="padding-left--md">
|
|
4614
4663
|
|
|
@@ -4660,7 +4709,7 @@ const data = await metricsClient.ingest({
|
|
|
4660
4709
|
### metric
|
|
4661
4710
|
|
|
4662
4711
|
<div class="padding-bottom--md">
|
|
4663
|
-
<strong>metricsClient.metric(config): Promise<<a href="#metricdescriptor">MetricDescriptor</a>></strong>
|
|
4712
|
+
<strong>metricsClient.metric(config): Promise<<a href="#metricdescriptor" target="_blank" rel="noopener noreferrer">MetricDescriptor</a>></strong>
|
|
4664
4713
|
|
|
4665
4714
|
<div class="padding-left--md">
|
|
4666
4715
|
|
|
@@ -4714,7 +4763,7 @@ const data = await metricsClient.metric({
|
|
|
4714
4763
|
### query
|
|
4715
4764
|
|
|
4716
4765
|
<div class="padding-bottom--md">
|
|
4717
|
-
<strong>metricsClient.query(config): Promise<<a href="#metricdata"
|
|
4766
|
+
<strong>metricsClient.query(config): Promise<<a href="#metricdata">MetricData</a>></strong>
|
|
4718
4767
|
|
|
4719
4768
|
<div class="padding-left--md">
|
|
4720
4769
|
|
|
@@ -4787,7 +4836,7 @@ import { metricsUnitsClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
4787
4836
|
### allUnits
|
|
4788
4837
|
|
|
4789
4838
|
<div class="padding-bottom--md">
|
|
4790
|
-
<strong>metricsUnitsClient.allUnits(config): Promise<<a href="#unitlist">UnitList</a>></strong>
|
|
4839
|
+
<strong>metricsUnitsClient.allUnits(config): Promise<<a href="#unitlist" target="_blank" rel="noopener noreferrer">UnitList</a>></strong>
|
|
4791
4840
|
|
|
4792
4841
|
<div class="padding-left--md">
|
|
4793
4842
|
|
|
@@ -4840,7 +4889,7 @@ const data = await metricsUnitsClient.allUnits();
|
|
|
4840
4889
|
### convert
|
|
4841
4890
|
|
|
4842
4891
|
<div class="padding-bottom--md">
|
|
4843
|
-
<strong>metricsUnitsClient.convert(config): Promise<<a href="#unitconversionresult"
|
|
4892
|
+
<strong>metricsUnitsClient.convert(config): Promise<<a href="#unitconversionresult">UnitConversionResult</a>></strong>
|
|
4844
4893
|
|
|
4845
4894
|
<div class="padding-left--md">
|
|
4846
4895
|
|
|
@@ -4898,7 +4947,7 @@ const data = await metricsUnitsClient.convert({
|
|
|
4898
4947
|
### unit
|
|
4899
4948
|
|
|
4900
4949
|
<div class="padding-bottom--md">
|
|
4901
|
-
<strong>metricsUnitsClient.unit(config): Promise<<a href="#unit">Unit</a>></strong>
|
|
4950
|
+
<strong>metricsUnitsClient.unit(config): Promise<<a href="#unit" target="_blank" rel="noopener noreferrer">Unit</a>></strong>
|
|
4902
4951
|
|
|
4903
4952
|
<div class="padding-left--md">
|
|
4904
4953
|
|
|
@@ -4956,7 +5005,7 @@ import { monitoredEntitiesClient } from '@dynatrace-sdk/client-classic-environme
|
|
|
4956
5005
|
### deleteSecurityContext
|
|
4957
5006
|
|
|
4958
5007
|
<div class="padding-bottom--md">
|
|
4959
|
-
<strong>monitoredEntitiesClient.deleteSecurityContext(config): Promise<<a href="#securitycontextresultdto"
|
|
5008
|
+
<strong>monitoredEntitiesClient.deleteSecurityContext(config): Promise<<a href="#securitycontextresultdto">SecurityContextResultDto</a>></strong>
|
|
4960
5009
|
|
|
4961
5010
|
<div class="padding-left--md">
|
|
4962
5011
|
|
|
@@ -5017,7 +5066,7 @@ const data =
|
|
|
5017
5066
|
### getEntities
|
|
5018
5067
|
|
|
5019
5068
|
<div class="padding-bottom--md">
|
|
5020
|
-
<strong>monitoredEntitiesClient.getEntities(config): Promise<<a href="#entitieslist">EntitiesList</a>></strong>
|
|
5069
|
+
<strong>monitoredEntitiesClient.getEntities(config): Promise<<a href="#entitieslist" target="_blank" rel="noopener noreferrer">EntitiesList</a>></strong>
|
|
5021
5070
|
|
|
5022
5071
|
<div class="padding-left--md">
|
|
5023
5072
|
|
|
@@ -5085,7 +5134,7 @@ const data = await monitoredEntitiesClient.getEntities();
|
|
|
5085
5134
|
### getEntity
|
|
5086
5135
|
|
|
5087
5136
|
<div class="padding-bottom--md">
|
|
5088
|
-
<strong>monitoredEntitiesClient.getEntity(config): Promise<<a href="#entity"
|
|
5137
|
+
<strong>monitoredEntitiesClient.getEntity(config): Promise<<a href="#entity">Entity</a>></strong>
|
|
5089
5138
|
|
|
5090
5139
|
<div class="padding-left--md">
|
|
5091
5140
|
|
|
@@ -5140,7 +5189,7 @@ const data = await monitoredEntitiesClient.getEntity({
|
|
|
5140
5189
|
### getEntityType
|
|
5141
5190
|
|
|
5142
5191
|
<div class="padding-bottom--md">
|
|
5143
|
-
<strong>monitoredEntitiesClient.getEntityType(config): Promise<<a href="#entitytype">EntityType</a>></strong>
|
|
5192
|
+
<strong>monitoredEntitiesClient.getEntityType(config): Promise<<a href="#entitytype" target="_blank" rel="noopener noreferrer">EntityType</a>></strong>
|
|
5144
5193
|
|
|
5145
5194
|
<div class="padding-left--md">
|
|
5146
5195
|
|
|
@@ -5192,7 +5241,7 @@ const data = await monitoredEntitiesClient.getEntityType({
|
|
|
5192
5241
|
### getEntityTypes
|
|
5193
5242
|
|
|
5194
5243
|
<div class="padding-bottom--md">
|
|
5195
|
-
<strong>monitoredEntitiesClient.getEntityTypes(config): Promise<<a href="#entitytypelist"
|
|
5244
|
+
<strong>monitoredEntitiesClient.getEntityTypes(config): Promise<<a href="#entitytypelist">EntityTypeList</a>></strong>
|
|
5196
5245
|
|
|
5197
5246
|
<div class="padding-left--md">
|
|
5198
5247
|
|
|
@@ -5247,7 +5296,7 @@ const data = await monitoredEntitiesClient.getEntityTypes();
|
|
|
5247
5296
|
### pushCustomDevice
|
|
5248
5297
|
|
|
5249
5298
|
<div class="padding-bottom--md">
|
|
5250
|
-
<strong>monitoredEntitiesClient.pushCustomDevice(config): Promise<void | <a href="#customdevicecreationresult">CustomDeviceCreationResult</a>></strong>
|
|
5299
|
+
<strong>monitoredEntitiesClient.pushCustomDevice(config): Promise<void | <a href="#customdevicecreationresult" target="_blank" rel="noopener noreferrer">CustomDeviceCreationResult</a>></strong>
|
|
5251
5300
|
|
|
5252
5301
|
<div class="padding-left--md">
|
|
5253
5302
|
|
|
@@ -5265,7 +5314,7 @@ Creates or updates a custom device
|
|
|
5265
5314
|
|
|
5266
5315
|
| Name | Type | Description |
|
|
5267
5316
|
| --- | --- | --- |
|
|
5268
|
-
|config.body<sup>*required</sup>|<a href="#customdevicecreation"
|
|
5317
|
+
|config.body<sup>*required</sup>|<a href="#customdevicecreation">CustomDeviceCreation</a>| |
|
|
5269
5318
|
|config.uiBased|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, it will be handled as if it was created via UI. It will be refreshed automatically and won't age out. |
|
|
5270
5319
|
|
|
5271
5320
|
|
|
@@ -5300,7 +5349,7 @@ const data = await monitoredEntitiesClient.pushCustomDevice(
|
|
|
5300
5349
|
### setSecurityContext
|
|
5301
5350
|
|
|
5302
5351
|
<div class="padding-bottom--md">
|
|
5303
|
-
<strong>monitoredEntitiesClient.setSecurityContext(config): Promise<<a href="#securitycontextresultdto">SecurityContextResultDto</a>></strong>
|
|
5352
|
+
<strong>monitoredEntitiesClient.setSecurityContext(config): Promise<<a href="#securitycontextresultdto" target="_blank" rel="noopener noreferrer">SecurityContextResultDto</a>></strong>
|
|
5304
5353
|
|
|
5305
5354
|
<div class="padding-left--md">
|
|
5306
5355
|
|
|
@@ -5326,7 +5375,7 @@ Automatic management zone rules will not apply to entities with a set security c
|
|
|
5326
5375
|
|
|
5327
5376
|
| Name | Type | Description |
|
|
5328
5377
|
| --- | --- | --- |
|
|
5329
|
-
|config.body<sup>*required</sup>|<a href="#securitycontextdtoimpl"
|
|
5378
|
+
|config.body<sup>*required</sup>|<a href="#securitycontextdtoimpl">SecurityContextDtoImpl</a>| |
|
|
5330
5379
|
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the entities to set the security context for. Only entities that can have management zones are considered for this operation</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&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> |
|
|
5331
5380
|
|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 three days is used (<code>now-3d</code>).</p> |
|
|
5332
5381
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
@@ -5371,7 +5420,7 @@ import { monitoredEntitiesCustomTagsClient } from '@dynatrace-sdk/client-classic
|
|
|
5371
5420
|
### deleteTags
|
|
5372
5421
|
|
|
5373
5422
|
<div class="padding-bottom--md">
|
|
5374
|
-
<strong>monitoredEntitiesCustomTagsClient.deleteTags(config): Promise<<a href="#deletedentitytags">DeletedEntityTags</a>></strong>
|
|
5423
|
+
<strong>monitoredEntitiesCustomTagsClient.deleteTags(config): Promise<<a href="#deletedentitytags" target="_blank" rel="noopener noreferrer">DeletedEntityTags</a>></strong>
|
|
5375
5424
|
|
|
5376
5425
|
<div class="padding-left--md">
|
|
5377
5426
|
|
|
@@ -5430,7 +5479,7 @@ const data =
|
|
|
5430
5479
|
### getTags
|
|
5431
5480
|
|
|
5432
5481
|
<div class="padding-bottom--md">
|
|
5433
|
-
<strong>monitoredEntitiesCustomTagsClient.getTags(config): Promise<<a href="#customentitytags"
|
|
5482
|
+
<strong>monitoredEntitiesCustomTagsClient.getTags(config): Promise<<a href="#customentitytags">CustomEntityTags</a>></strong>
|
|
5434
5483
|
|
|
5435
5484
|
<div class="padding-left--md">
|
|
5436
5485
|
|
|
@@ -5487,7 +5536,7 @@ const data =
|
|
|
5487
5536
|
### postTags
|
|
5488
5537
|
|
|
5489
5538
|
<div class="padding-bottom--md">
|
|
5490
|
-
<strong>monitoredEntitiesCustomTagsClient.postTags(config): Promise<<a href="#addedentitytags">AddedEntityTags</a>></strong>
|
|
5539
|
+
<strong>monitoredEntitiesCustomTagsClient.postTags(config): Promise<<a href="#addedentitytags" target="_blank" rel="noopener noreferrer">AddedEntityTags</a>></strong>
|
|
5491
5540
|
|
|
5492
5541
|
<div class="padding-left--md">
|
|
5493
5542
|
|
|
@@ -5507,7 +5556,7 @@ All existing tags remain unaffected.
|
|
|
5507
5556
|
|
|
5508
5557
|
| Name | Type | Description |
|
|
5509
5558
|
| --- | --- | --- |
|
|
5510
|
-
|config.body<sup>*required</sup>|<a href="#addentitytags"
|
|
5559
|
+
|config.body<sup>*required</sup>|<a href="#addentitytags">AddEntityTags</a>| |
|
|
5511
5560
|
|config.entitySelector<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the entities where you want to update tags.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&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> |
|
|
5512
5561
|
|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 24 hours is used (<code>now-24h</code>).</p> |
|
|
5513
5562
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
@@ -5552,7 +5601,7 @@ import { monitoredEntitiesMonitoringStateClient } from '@dynatrace-sdk/client-cl
|
|
|
5552
5601
|
### getStates
|
|
5553
5602
|
|
|
5554
5603
|
<div class="padding-bottom--md">
|
|
5555
|
-
<strong>monitoredEntitiesMonitoringStateClient.getStates(config): Promise<<a href="#monitoredstates">MonitoredStates</a>></strong>
|
|
5604
|
+
<strong>monitoredEntitiesMonitoringStateClient.getStates(config): Promise<<a href="#monitoredstates" target="_blank" rel="noopener noreferrer">MonitoredStates</a>></strong>
|
|
5556
5605
|
|
|
5557
5606
|
<div class="padding-left--md">
|
|
5558
5607
|
|
|
@@ -5573,8 +5622,10 @@ Only process group instances are supported.
|
|
|
5573
5622
|
| Name | Type | Description |
|
|
5574
5623
|
| --- | --- | --- |
|
|
5575
5624
|
|config.entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the process group instances where you're querying the state. Use the <code>PROCESS_GROUP_INSTANCE</code> entity type.</p> <p>You must set one of these criteria:</p> <ul> <li>Entity type: <code>type("TYPE")</code></li> <li>Dynatrace entity ID: <code>entityId("id")</code>. You can specify several IDs, separated by a comma (<code>entityId("id-1","id-2")</code>). All requested entities must be of the same type.</li> </ul> <p>You can add one or more of the following criteria. Values are case-sensitive and the <code>EQUALS</code> operator is used unless otherwise specified.</p> <ul> <li>Tag: <code>tag("value")</code>. Tags in <code>[context]key:value</code>, <code>key:value</code>, and <code>value</code> formats are detected and parsed automatically. Any colons (<code>:</code>) that are part of the key or value must be escaped with a backslash(<code>\\</code>). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.</li> <li>Management zone ID: <code>mzId(123)</code></li> <li>Management zone name: <code>mzName(&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> |
|
|
5625
|
+
|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 24 hours is used (<code>now-24h</code>).</p> |
|
|
5576
5626
|
|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> |
|
|
5577
5627
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of monitoring states in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 500 is used.</p> |
|
|
5628
|
+
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
5578
5629
|
|
|
5579
5630
|
|
|
5580
5631
|
|
|
@@ -5613,7 +5664,7 @@ import { networkZonesClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
5613
5664
|
### createOrUpdateNetworkZone
|
|
5614
5665
|
|
|
5615
5666
|
<div class="padding-bottom--md">
|
|
5616
|
-
<strong>networkZonesClient.createOrUpdateNetworkZone(config): Promise<void | <a href="#entityshortrepresentation"
|
|
5667
|
+
<strong>networkZonesClient.createOrUpdateNetworkZone(config): Promise<void | <a href="#entityshortrepresentation">EntityShortRepresentation</a>></strong>
|
|
5617
5668
|
|
|
5618
5669
|
<div class="padding-left--md">
|
|
5619
5670
|
|
|
@@ -5635,7 +5686,7 @@ If the network zone with the specified ID does not exist, a new network zone is
|
|
|
5635
5686
|
|
|
5636
5687
|
| Name | Type | Description |
|
|
5637
5688
|
| --- | --- | --- |
|
|
5638
|
-
|config.body<sup>*required</sup>|<a href="#networkzone">NetworkZone</a>| |
|
|
5689
|
+
|config.body<sup>*required</sup>|<a href="#networkzone" target="_blank" rel="noopener noreferrer">NetworkZone</a>| |
|
|
5639
5690
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The ID of the network zone to be updated.</p> <p>If you set the ID in the body as well, it must match this ID.</p> <p>The ID is not case sensitive. Dynatrace stores the ID in lowercase.</p> |
|
|
5640
5691
|
|
|
5641
5692
|
|
|
@@ -5724,7 +5775,7 @@ const data = await networkZonesClient.deleteNetworkZone({
|
|
|
5724
5775
|
### getAllNetworkZones
|
|
5725
5776
|
|
|
5726
5777
|
<div class="padding-bottom--md">
|
|
5727
|
-
<strong>networkZonesClient.getAllNetworkZones(abortSignal?): Promise<<a href="#networkzonelist"
|
|
5778
|
+
<strong>networkZonesClient.getAllNetworkZones(abortSignal?): Promise<<a href="#networkzonelist">NetworkZoneList</a>></strong>
|
|
5728
5779
|
|
|
5729
5780
|
<div class="padding-left--md">
|
|
5730
5781
|
|
|
@@ -5766,7 +5817,7 @@ const data = await networkZonesClient.getAllNetworkZones();
|
|
|
5766
5817
|
### getHostStats
|
|
5767
5818
|
|
|
5768
5819
|
<div class="padding-bottom--md">
|
|
5769
|
-
<strong>networkZonesClient.getHostStats(config): Promise<<a href="#networkzoneconnectionstatistics">NetworkZoneConnectionStatistics</a>></strong>
|
|
5820
|
+
<strong>networkZonesClient.getHostStats(config): Promise<<a href="#networkzoneconnectionstatistics" target="_blank" rel="noopener noreferrer">NetworkZoneConnectionStatistics</a>></strong>
|
|
5770
5821
|
|
|
5771
5822
|
<div class="padding-left--md">
|
|
5772
5823
|
|
|
@@ -5819,7 +5870,7 @@ const data = await networkZonesClient.getHostStats({
|
|
|
5819
5870
|
### getNetworkZoneSettings
|
|
5820
5871
|
|
|
5821
5872
|
<div class="padding-bottom--md">
|
|
5822
|
-
<strong>networkZonesClient.getNetworkZoneSettings(abortSignal?): Promise<<a href="#networkzonesettings"
|
|
5873
|
+
<strong>networkZonesClient.getNetworkZoneSettings(abortSignal?): Promise<<a href="#networkzonesettings">NetworkZoneSettings</a>></strong>
|
|
5823
5874
|
|
|
5824
5875
|
<div class="padding-left--md">
|
|
5825
5876
|
|
|
@@ -5862,7 +5913,7 @@ const data =
|
|
|
5862
5913
|
### getSingleNetworkZone
|
|
5863
5914
|
|
|
5864
5915
|
<div class="padding-bottom--md">
|
|
5865
|
-
<strong>networkZonesClient.getSingleNetworkZone(config): Promise<<a href="#networkzone">NetworkZone</a>></strong>
|
|
5916
|
+
<strong>networkZonesClient.getSingleNetworkZone(config): Promise<<a href="#networkzone" target="_blank" rel="noopener noreferrer">NetworkZone</a>></strong>
|
|
5866
5917
|
|
|
5867
5918
|
<div class="padding-left--md">
|
|
5868
5919
|
|
|
@@ -5932,7 +5983,7 @@ Updates the global configuration of network zones
|
|
|
5932
5983
|
|
|
5933
5984
|
| Name | Type |
|
|
5934
5985
|
| --- | --- |
|
|
5935
|
-
|config.body<sup>*required</sup>|<a href="#networkzonesettings"
|
|
5986
|
+
|config.body<sup>*required</sup>|<a href="#networkzonesettings">NetworkZoneSettings</a>|
|
|
5936
5987
|
|
|
5937
5988
|
|
|
5938
5989
|
|
|
@@ -5969,7 +6020,7 @@ import { problemsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
5969
6020
|
### closeProblem
|
|
5970
6021
|
|
|
5971
6022
|
<div class="padding-bottom--md">
|
|
5972
|
-
<strong>problemsClient.closeProblem(config): Promise<void | <a href="#problemcloseresult">ProblemCloseResult</a>></strong>
|
|
6023
|
+
<strong>problemsClient.closeProblem(config): Promise<void | <a href="#problemcloseresult" target="_blank" rel="noopener noreferrer">ProblemCloseResult</a>></strong>
|
|
5973
6024
|
|
|
5974
6025
|
<div class="padding-left--md">
|
|
5975
6026
|
|
|
@@ -5987,7 +6038,7 @@ Closes the specified problem and adds a closing comment on it
|
|
|
5987
6038
|
|
|
5988
6039
|
| Name | Type | Description |
|
|
5989
6040
|
| --- | --- | --- |
|
|
5990
|
-
|config.body<sup>*required</sup>|<a href="#problemcloserequestdtoimpl"
|
|
6041
|
+
|config.body<sup>*required</sup>|<a href="#problemcloserequestdtoimpl">ProblemCloseRequestDtoImpl</a>| |
|
|
5991
6042
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
5992
6043
|
|
|
5993
6044
|
|
|
@@ -6041,7 +6092,7 @@ Adds a new comment on the specified problem
|
|
|
6041
6092
|
|
|
6042
6093
|
| Name | Type | Description |
|
|
6043
6094
|
| --- | --- | --- |
|
|
6044
|
-
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a>| |
|
|
6095
|
+
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl" target="_blank" rel="noopener noreferrer">CommentRequestDtoImpl</a>| |
|
|
6045
6096
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
6046
6097
|
|
|
6047
6098
|
|
|
@@ -6123,7 +6174,7 @@ const data = await problemsClient.deleteComment({
|
|
|
6123
6174
|
### getComment
|
|
6124
6175
|
|
|
6125
6176
|
<div class="padding-bottom--md">
|
|
6126
|
-
<strong>problemsClient.getComment(config): Promise<<a href="#comment"
|
|
6177
|
+
<strong>problemsClient.getComment(config): Promise<<a href="#comment">Comment</a>></strong>
|
|
6127
6178
|
|
|
6128
6179
|
<div class="padding-left--md">
|
|
6129
6180
|
|
|
@@ -6177,7 +6228,7 @@ const data = await problemsClient.getComment({
|
|
|
6177
6228
|
### getComments
|
|
6178
6229
|
|
|
6179
6230
|
<div class="padding-bottom--md">
|
|
6180
|
-
<strong>problemsClient.getComments(config): Promise<<a href="#commentslist">CommentsList</a>></strong>
|
|
6231
|
+
<strong>problemsClient.getComments(config): Promise<<a href="#commentslist" target="_blank" rel="noopener noreferrer">CommentsList</a>></strong>
|
|
6181
6232
|
|
|
6182
6233
|
<div class="padding-left--md">
|
|
6183
6234
|
|
|
@@ -6231,7 +6282,7 @@ const data = await problemsClient.getComments({
|
|
|
6231
6282
|
### getProblem
|
|
6232
6283
|
|
|
6233
6284
|
<div class="padding-bottom--md">
|
|
6234
|
-
<strong>problemsClient.getProblem(config): Promise<<a href="#problem"
|
|
6285
|
+
<strong>problemsClient.getProblem(config): Promise<<a href="#problem">Problem</a>></strong>
|
|
6235
6286
|
|
|
6236
6287
|
<div class="padding-left--md">
|
|
6237
6288
|
|
|
@@ -6284,7 +6335,7 @@ const data = await problemsClient.getProblem({
|
|
|
6284
6335
|
### getProblems
|
|
6285
6336
|
|
|
6286
6337
|
<div class="padding-bottom--md">
|
|
6287
|
-
<strong>problemsClient.getProblems(config): Promise<<a href="#problems">Problems</a>></strong>
|
|
6338
|
+
<strong>problemsClient.getProblems(config): Promise<<a href="#problems" target="_blank" rel="noopener noreferrer">Problems</a>></strong>
|
|
6288
6339
|
|
|
6289
6340
|
<div class="padding-left--md">
|
|
6290
6341
|
|
|
@@ -6359,7 +6410,7 @@ Updates the specified comment on a problem
|
|
|
6359
6410
|
|
|
6360
6411
|
| Name | Type | Description |
|
|
6361
6412
|
| --- | --- | --- |
|
|
6362
|
-
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl"
|
|
6413
|
+
|config.body<sup>*required</sup>|<a href="#commentrequestdtoimpl">CommentRequestDtoImpl</a>| |
|
|
6363
6414
|
|config.commentId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required comment. |
|
|
6364
6415
|
|config.problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required problem. |
|
|
6365
6416
|
|
|
@@ -6399,7 +6450,7 @@ import { releasesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
6399
6450
|
### getReleases
|
|
6400
6451
|
|
|
6401
6452
|
<div class="padding-bottom--md">
|
|
6402
|
-
<strong>releasesClient.getReleases(config): Promise<<a href="#releases">Releases</a>></strong>
|
|
6453
|
+
<strong>releasesClient.getReleases(config): Promise<<a href="#releases" target="_blank" rel="noopener noreferrer">Releases</a>></strong>
|
|
6403
6454
|
|
|
6404
6455
|
<div class="padding-left--md">
|
|
6405
6456
|
|
|
@@ -6461,7 +6512,7 @@ import { securityProblemsClient } from '@dynatrace-sdk/client-classic-environmen
|
|
|
6461
6512
|
### bulkMuteRemediationItems
|
|
6462
6513
|
|
|
6463
6514
|
<div class="padding-bottom--md">
|
|
6464
|
-
<strong>securityProblemsClient.bulkMuteRemediationItems(config): Promise<<a href="#remediationitemsbulkmuteresponse"
|
|
6515
|
+
<strong>securityProblemsClient.bulkMuteRemediationItems(config): Promise<<a href="#remediationitemsbulkmuteresponse">RemediationItemsBulkMuteResponse</a>></strong>
|
|
6465
6516
|
|
|
6466
6517
|
<div class="padding-left--md">
|
|
6467
6518
|
|
|
@@ -6479,7 +6530,7 @@ Mutes several remediation items
|
|
|
6479
6530
|
|
|
6480
6531
|
| Name | Type | Description |
|
|
6481
6532
|
| --- | --- | --- |
|
|
6482
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkmute">RemediationItemsBulkMute</a>| |
|
|
6533
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkmute" target="_blank" rel="noopener noreferrer">RemediationItemsBulkMute</a>| |
|
|
6483
6534
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
6484
6535
|
|
|
6485
6536
|
|
|
@@ -6516,7 +6567,7 @@ const data =
|
|
|
6516
6567
|
### bulkMuteSecurityProblems
|
|
6517
6568
|
|
|
6518
6569
|
<div class="padding-bottom--md">
|
|
6519
|
-
<strong>securityProblemsClient.bulkMuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkmuteresponse"
|
|
6570
|
+
<strong>securityProblemsClient.bulkMuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkmuteresponse">SecurityProblemsBulkMuteResponse</a>></strong>
|
|
6520
6571
|
|
|
6521
6572
|
<div class="padding-left--md">
|
|
6522
6573
|
|
|
@@ -6534,7 +6585,7 @@ Mutes several security problems
|
|
|
6534
6585
|
|
|
6535
6586
|
| Name | Type |
|
|
6536
6587
|
| --- | --- |
|
|
6537
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkmute">SecurityProblemsBulkMute</a>|
|
|
6588
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkmute" target="_blank" rel="noopener noreferrer">SecurityProblemsBulkMute</a>|
|
|
6538
6589
|
|
|
6539
6590
|
|
|
6540
6591
|
|
|
@@ -6569,7 +6620,7 @@ const data =
|
|
|
6569
6620
|
### bulkUnmuteRemediationItems
|
|
6570
6621
|
|
|
6571
6622
|
<div class="padding-bottom--md">
|
|
6572
|
-
<strong>securityProblemsClient.bulkUnmuteRemediationItems(config): Promise<<a href="#remediationitemsbulkunmuteresponse"
|
|
6623
|
+
<strong>securityProblemsClient.bulkUnmuteRemediationItems(config): Promise<<a href="#remediationitemsbulkunmuteresponse">RemediationItemsBulkUnmuteResponse</a>></strong>
|
|
6573
6624
|
|
|
6574
6625
|
<div class="padding-left--md">
|
|
6575
6626
|
|
|
@@ -6587,7 +6638,7 @@ Un-mutes several remediation items
|
|
|
6587
6638
|
|
|
6588
6639
|
| Name | Type | Description |
|
|
6589
6640
|
| --- | --- | --- |
|
|
6590
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkunmute">RemediationItemsBulkUnmute</a>| |
|
|
6641
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkunmute" target="_blank" rel="noopener noreferrer">RemediationItemsBulkUnmute</a>| |
|
|
6591
6642
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
6592
6643
|
|
|
6593
6644
|
|
|
@@ -6624,7 +6675,7 @@ const data =
|
|
|
6624
6675
|
### bulkUnmuteSecurityProblems
|
|
6625
6676
|
|
|
6626
6677
|
<div class="padding-bottom--md">
|
|
6627
|
-
<strong>securityProblemsClient.bulkUnmuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkunmuteresponse"
|
|
6678
|
+
<strong>securityProblemsClient.bulkUnmuteSecurityProblems(config): Promise<<a href="#securityproblemsbulkunmuteresponse">SecurityProblemsBulkUnmuteResponse</a>></strong>
|
|
6628
6679
|
|
|
6629
6680
|
<div class="padding-left--md">
|
|
6630
6681
|
|
|
@@ -6642,7 +6693,7 @@ Un-mutes several security problems
|
|
|
6642
6693
|
|
|
6643
6694
|
| Name | Type |
|
|
6644
6695
|
| --- | --- |
|
|
6645
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkunmute">SecurityProblemsBulkUnmute</a>|
|
|
6696
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemsbulkunmute" target="_blank" rel="noopener noreferrer">SecurityProblemsBulkUnmute</a>|
|
|
6646
6697
|
|
|
6647
6698
|
|
|
6648
6699
|
|
|
@@ -6677,7 +6728,7 @@ const data =
|
|
|
6677
6728
|
### getEventsForSecurityProblem
|
|
6678
6729
|
|
|
6679
6730
|
<div class="padding-bottom--md">
|
|
6680
|
-
<strong>securityProblemsClient.getEventsForSecurityProblem(config): Promise<<a href="#securityproblemeventslist"
|
|
6731
|
+
<strong>securityProblemsClient.getEventsForSecurityProblem(config): Promise<<a href="#securityproblemeventslist">SecurityProblemEventsList</a>></strong>
|
|
6681
6732
|
|
|
6682
6733
|
<div class="padding-left--md">
|
|
6683
6734
|
|
|
@@ -6734,7 +6785,7 @@ const data =
|
|
|
6734
6785
|
### getRemediationItem
|
|
6735
6786
|
|
|
6736
6787
|
<div class="padding-bottom--md">
|
|
6737
|
-
<strong>securityProblemsClient.getRemediationItem(config): Promise<<a href="#remediationdetailsitem">RemediationDetailsItem</a>></strong>
|
|
6788
|
+
<strong>securityProblemsClient.getRemediationItem(config): Promise<<a href="#remediationdetailsitem" target="_blank" rel="noopener noreferrer">RemediationDetailsItem</a>></strong>
|
|
6738
6789
|
|
|
6739
6790
|
<div class="padding-left--md">
|
|
6740
6791
|
|
|
@@ -6791,7 +6842,7 @@ const data =
|
|
|
6791
6842
|
### getRemediationItems
|
|
6792
6843
|
|
|
6793
6844
|
<div class="padding-bottom--md">
|
|
6794
|
-
<strong>securityProblemsClient.getRemediationItems(config): Promise<<a href="#remediationitemlist"
|
|
6845
|
+
<strong>securityProblemsClient.getRemediationItems(config): Promise<<a href="#remediationitemlist">RemediationItemList</a>></strong>
|
|
6795
6846
|
|
|
6796
6847
|
<div class="padding-left--md">
|
|
6797
6848
|
|
|
@@ -6847,7 +6898,7 @@ const data =
|
|
|
6847
6898
|
### getRemediationProgressEntities
|
|
6848
6899
|
|
|
6849
6900
|
<div class="padding-bottom--md">
|
|
6850
|
-
<strong>securityProblemsClient.getRemediationProgressEntities(config): Promise<<a href="#remediationprogressentitylist">RemediationProgressEntityList</a>></strong>
|
|
6901
|
+
<strong>securityProblemsClient.getRemediationProgressEntities(config): Promise<<a href="#remediationprogressentitylist" target="_blank" rel="noopener noreferrer">RemediationProgressEntityList</a>></strong>
|
|
6851
6902
|
|
|
6852
6903
|
<div class="padding-left--md">
|
|
6853
6904
|
|
|
@@ -6904,7 +6955,7 @@ const data =
|
|
|
6904
6955
|
### getSecurityProblem
|
|
6905
6956
|
|
|
6906
6957
|
<div class="padding-bottom--md">
|
|
6907
|
-
<strong>securityProblemsClient.getSecurityProblem(config): Promise<<a href="#securityproblemdetails"
|
|
6958
|
+
<strong>securityProblemsClient.getSecurityProblem(config): Promise<<a href="#securityproblemdetails">SecurityProblemDetails</a>></strong>
|
|
6908
6959
|
|
|
6909
6960
|
<div class="padding-left--md">
|
|
6910
6961
|
|
|
@@ -6962,7 +7013,7 @@ const data =
|
|
|
6962
7013
|
### getSecurityProblems
|
|
6963
7014
|
|
|
6964
7015
|
<div class="padding-bottom--md">
|
|
6965
|
-
<strong>securityProblemsClient.getSecurityProblems(config): Promise<<a href="#securityproblemlist">SecurityProblemList</a>></strong>
|
|
7016
|
+
<strong>securityProblemsClient.getSecurityProblems(config): Promise<<a href="#securityproblemlist" target="_blank" rel="noopener noreferrer">SecurityProblemList</a>></strong>
|
|
6966
7017
|
|
|
6967
7018
|
<div class="padding-left--md">
|
|
6968
7019
|
|
|
@@ -7021,7 +7072,7 @@ const data =
|
|
|
7021
7072
|
### getVulnerableFunctions
|
|
7022
7073
|
|
|
7023
7074
|
<div class="padding-bottom--md">
|
|
7024
|
-
<strong>securityProblemsClient.getVulnerableFunctions(config): Promise<<a href="#vulnerablefunctionscontainer"
|
|
7075
|
+
<strong>securityProblemsClient.getVulnerableFunctions(config): Promise<<a href="#vulnerablefunctionscontainer">VulnerableFunctionsContainer</a>></strong>
|
|
7025
7076
|
|
|
7026
7077
|
<div class="padding-left--md">
|
|
7027
7078
|
|
|
@@ -7096,7 +7147,7 @@ Mutes a security problem
|
|
|
7096
7147
|
|
|
7097
7148
|
| Name | Type | Description |
|
|
7098
7149
|
| --- | --- | --- |
|
|
7099
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemmute">SecurityProblemMute</a>| |
|
|
7150
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemmute" target="_blank" rel="noopener noreferrer">SecurityProblemMute</a>| |
|
|
7100
7151
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
7101
7152
|
|
|
7102
7153
|
|
|
@@ -7147,7 +7198,7 @@ Sets the mute state of a remediation item
|
|
|
7147
7198
|
|
|
7148
7199
|
| Name | Type | Description |
|
|
7149
7200
|
| --- | --- | --- |
|
|
7150
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemmutestatechange"
|
|
7201
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemmutestatechange">RemediationItemMuteStateChange</a>| |
|
|
7151
7202
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
7152
7203
|
|config.remediationItemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation item. |
|
|
7153
7204
|
|
|
@@ -7200,7 +7251,7 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
|
|
|
7200
7251
|
|
|
7201
7252
|
| Name | Type | Description |
|
|
7202
7253
|
| --- | --- | --- |
|
|
7203
|
-
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkupdatedeletedto">RemediationItemsBulkUpdateDeleteDto</a>| |
|
|
7254
|
+
|config.body<sup>*required</sup>|<a href="#remediationitemsbulkupdatedeletedto" target="_blank" rel="noopener noreferrer">RemediationItemsBulkUpdateDeleteDto</a>| |
|
|
7204
7255
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested third-party security problem. |
|
|
7205
7256
|
|
|
7206
7257
|
|
|
@@ -7250,7 +7301,7 @@ Un-mutes a security problem
|
|
|
7250
7301
|
|
|
7251
7302
|
| Name | Type | Description |
|
|
7252
7303
|
| --- | --- | --- |
|
|
7253
|
-
|config.body<sup>*required</sup>|<a href="#securityproblemunmute"
|
|
7304
|
+
|config.body<sup>*required</sup>|<a href="#securityproblemunmute">SecurityProblemUnmute</a>| |
|
|
7254
7305
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
7255
7306
|
|
|
7256
7307
|
|
|
@@ -7289,7 +7340,7 @@ import { serviceLevelObjectivesClient } from '@dynatrace-sdk/client-classic-envi
|
|
|
7289
7340
|
### createAlert
|
|
7290
7341
|
|
|
7291
7342
|
<div class="padding-bottom--md">
|
|
7292
|
-
<strong>serviceLevelObjectivesClient.createAlert(config): Promise<<a href="#entityshortrepresentation">EntityShortRepresentation</a>></strong>
|
|
7343
|
+
<strong>serviceLevelObjectivesClient.createAlert(config): Promise<<a href="#entityshortrepresentation" target="_blank" rel="noopener noreferrer">EntityShortRepresentation</a>></strong>
|
|
7293
7344
|
|
|
7294
7345
|
<div class="padding-left--md">
|
|
7295
7346
|
|
|
@@ -7309,7 +7360,7 @@ Creates an alert of the provided alert type for an SLO
|
|
|
7309
7360
|
|
|
7310
7361
|
| Name | Type | Description |
|
|
7311
7362
|
| --- | --- | --- |
|
|
7312
|
-
|config.body<sup>*required</sup>|<a href="#abstractsloalertdto"
|
|
7363
|
+
|config.body<sup>*required</sup>|<a href="#abstractsloalertdto">AbstractSloAlertDto</a>| |
|
|
7313
7364
|
|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 weeks is used (<code>now-2w</code>).</p> |
|
|
7314
7365
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
7315
7366
|
|config.timeFrame|CreateAlertQueryTimeFrame|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> |
|
|
@@ -7370,7 +7421,7 @@ Creates a new SLO
|
|
|
7370
7421
|
|
|
7371
7422
|
| Name | Type |
|
|
7372
7423
|
| --- | --- |
|
|
7373
|
-
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a>|
|
|
7424
|
+
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl" target="_blank" rel="noopener noreferrer">SloConfigItemDtoImpl</a>|
|
|
7374
7425
|
|
|
7375
7426
|
|
|
7376
7427
|
|
|
@@ -7455,7 +7506,7 @@ const data = await serviceLevelObjectivesClient.deleteSlo({
|
|
|
7455
7506
|
### getSlo
|
|
7456
7507
|
|
|
7457
7508
|
<div class="padding-bottom--md">
|
|
7458
|
-
<strong>serviceLevelObjectivesClient.getSlo(config): Promise<<a href="#slos"
|
|
7509
|
+
<strong>serviceLevelObjectivesClient.getSlo(config): Promise<<a href="#slos">SLOs</a>></strong>
|
|
7459
7510
|
|
|
7460
7511
|
<div class="padding-left--md">
|
|
7461
7512
|
|
|
@@ -7524,7 +7575,7 @@ const data = await serviceLevelObjectivesClient.getSlo();
|
|
|
7524
7575
|
### getSloById
|
|
7525
7576
|
|
|
7526
7577
|
<div class="padding-bottom--md">
|
|
7527
|
-
<strong>serviceLevelObjectivesClient.getSloById(config): Promise<<a href="#slo">SLO</a>></strong>
|
|
7578
|
+
<strong>serviceLevelObjectivesClient.getSloById(config): Promise<<a href="#slo" target="_blank" rel="noopener noreferrer">SLO</a>></strong>
|
|
7528
7579
|
|
|
7529
7580
|
<div class="padding-left--md">
|
|
7530
7581
|
|
|
@@ -7605,7 +7656,7 @@ Updates an existing SLO
|
|
|
7605
7656
|
|
|
7606
7657
|
| Name | Type | Description |
|
|
7607
7658
|
| --- | --- | --- |
|
|
7608
|
-
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl"
|
|
7659
|
+
|config.body<sup>*required</sup>|<a href="#sloconfigitemdtoimpl">SloConfigItemDtoImpl</a>| |
|
|
7609
7660
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
7610
7661
|
|
|
7611
7662
|
|
|
@@ -7649,7 +7700,7 @@ import { settingsManagementZonesClient } from '@dynatrace-sdk/client-classic-env
|
|
|
7649
7700
|
### getManagementZoneDetails
|
|
7650
7701
|
|
|
7651
7702
|
<div class="padding-bottom--md">
|
|
7652
|
-
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails">ManagementZoneDetails</a>></strong>
|
|
7703
|
+
<strong>settingsManagementZonesClient.getManagementZoneDetails(config): Promise<<a href="#managementzonedetails" target="_blank" rel="noopener noreferrer">ManagementZoneDetails</a>></strong>
|
|
7653
7704
|
|
|
7654
7705
|
<div class="padding-left--md">
|
|
7655
7706
|
|
|
@@ -7766,7 +7817,7 @@ const data =
|
|
|
7766
7817
|
### getEffectiveSettingsValues
|
|
7767
7818
|
|
|
7768
7819
|
<div class="padding-bottom--md">
|
|
7769
|
-
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist"
|
|
7820
|
+
<strong>settingsObjectsClient.getEffectiveSettingsValues(config): Promise<<a href="#effectivesettingsvalueslist">EffectiveSettingsValuesList</a>></strong>
|
|
7770
7821
|
|
|
7771
7822
|
<div class="padding-left--md">
|
|
7772
7823
|
|
|
@@ -7831,7 +7882,7 @@ const data =
|
|
|
7831
7882
|
### getSettingsHistory
|
|
7832
7883
|
|
|
7833
7884
|
<div class="padding-bottom--md">
|
|
7834
|
-
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage">RevisionDiffPage</a>></strong>
|
|
7885
|
+
<strong>settingsObjectsClient.getSettingsHistory(config): Promise<<a href="#revisiondiffpage" target="_blank" rel="noopener noreferrer">RevisionDiffPage</a>></strong>
|
|
7835
7886
|
|
|
7836
7887
|
<div class="padding-left--md">
|
|
7837
7888
|
|
|
@@ -7890,7 +7941,7 @@ const data =
|
|
|
7890
7941
|
### getSettingsObjectByObjectId
|
|
7891
7942
|
|
|
7892
7943
|
<div class="padding-bottom--md">
|
|
7893
|
-
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse"
|
|
7944
|
+
<strong>settingsObjectsClient.getSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectbyobjectidresponse">SettingsObjectByObjectIdResponse</a>></strong>
|
|
7894
7945
|
|
|
7895
7946
|
<div class="padding-left--md">
|
|
7896
7947
|
|
|
@@ -7945,7 +7996,7 @@ const data =
|
|
|
7945
7996
|
### getSettingsObjects
|
|
7946
7997
|
|
|
7947
7998
|
<div class="padding-bottom--md">
|
|
7948
|
-
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist">ObjectsList</a>></strong>
|
|
7999
|
+
<strong>settingsObjectsClient.getSettingsObjects(config): Promise<<a href="#objectslist" target="_blank" rel="noopener noreferrer">ObjectsList</a>></strong>
|
|
7949
8000
|
|
|
7950
8001
|
<div class="padding-left--md">
|
|
7951
8002
|
|
|
@@ -7974,7 +8025,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
7974
8025
|
| Name | Type | Description |
|
|
7975
8026
|
| --- | --- | --- |
|
|
7976
8027
|
|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> |
|
|
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> |
|
|
8028
|
+
|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>owner</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
7978
8029
|
|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> |
|
|
7979
8030
|
|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> |
|
|
7980
8031
|
|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> |
|
|
@@ -8013,7 +8064,7 @@ const data =
|
|
|
8013
8064
|
### postSettingsObjects
|
|
8014
8065
|
|
|
8015
8066
|
<div class="padding-bottom--md">
|
|
8016
|
-
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse"
|
|
8067
|
+
<strong>settingsObjectsClient.postSettingsObjects(config): Promise<Array<<a href="#settingsobjectresponse">SettingsObjectResponse</a>>></strong>
|
|
8017
8068
|
|
|
8018
8069
|
<div class="padding-left--md">
|
|
8019
8070
|
|
|
@@ -8037,7 +8088,7 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
8037
8088
|
|
|
8038
8089
|
| Name | Type | Description |
|
|
8039
8090
|
| --- | --- | --- |
|
|
8040
|
-
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate">SettingsObjectCreate</a>>| |
|
|
8091
|
+
|config.body<sup>*required</sup>|Array<<a href="#settingsobjectcreate" target="_blank" rel="noopener noreferrer">SettingsObjectCreate</a>>| |
|
|
8041
8092
|
|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. |
|
|
8042
8093
|
|
|
8043
8094
|
|
|
@@ -8080,7 +8131,7 @@ const data =
|
|
|
8080
8131
|
### putSettingsObjectByObjectId
|
|
8081
8132
|
|
|
8082
8133
|
<div class="padding-bottom--md">
|
|
8083
|
-
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse"
|
|
8134
|
+
<strong>settingsObjectsClient.putSettingsObjectByObjectId(config): Promise<<a href="#settingsobjectresponse">SettingsObjectResponse</a>></strong>
|
|
8084
8135
|
|
|
8085
8136
|
<div class="padding-left--md">
|
|
8086
8137
|
|
|
@@ -8106,7 +8157,7 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
8106
8157
|
|
|
8107
8158
|
| Name | Type | Description |
|
|
8108
8159
|
| --- | --- | --- |
|
|
8109
|
-
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate">SettingsObjectUpdate</a>| |
|
|
8160
|
+
|config.body<sup>*required</sup>|<a href="#settingsobjectupdate" target="_blank" rel="noopener noreferrer">SettingsObjectUpdate</a>| |
|
|
8110
8161
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
8111
8162
|
|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. |
|
|
8112
8163
|
|
|
@@ -8144,7 +8195,7 @@ const data =
|
|
|
8144
8195
|
### resolveEffectivePermissions
|
|
8145
8196
|
|
|
8146
8197
|
<div class="padding-bottom--md">
|
|
8147
|
-
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission"
|
|
8198
|
+
<strong>settingsObjectsClient.resolveEffectivePermissions(config): Promise<Array<<a href="#effectivepermission">EffectivePermission</a>>></strong>
|
|
8148
8199
|
|
|
8149
8200
|
<div class="padding-left--md">
|
|
8150
8201
|
|
|
@@ -8169,7 +8220,7 @@ Get the effective settings permissions of the calling user in the environment
|
|
|
8169
8220
|
|
|
8170
8221
|
| Name | Type |
|
|
8171
8222
|
| --- | --- |
|
|
8172
|
-
|config.body<sup>*required</sup>|<a href="#resolutionrequest">ResolutionRequest</a>|
|
|
8223
|
+
|config.body<sup>*required</sup>|<a href="#resolutionrequest" target="_blank" rel="noopener noreferrer">ResolutionRequest</a>|
|
|
8173
8224
|
|
|
8174
8225
|
|
|
8175
8226
|
|
|
@@ -8210,7 +8261,7 @@ import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
8210
8261
|
### getAvailableSchemaDefinitions
|
|
8211
8262
|
|
|
8212
8263
|
<div class="padding-bottom--md">
|
|
8213
|
-
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist"
|
|
8264
|
+
<strong>settingsSchemasClient.getAvailableSchemaDefinitions(config): Promise<<a href="#schemalist">SchemaList</a>></strong>
|
|
8214
8265
|
|
|
8215
8266
|
<div class="padding-left--md">
|
|
8216
8267
|
|
|
@@ -8263,7 +8314,7 @@ const data =
|
|
|
8263
8314
|
### getSchemaDefinition
|
|
8264
8315
|
|
|
8265
8316
|
<div class="padding-bottom--md">
|
|
8266
|
-
<strong>settingsSchemasClient.getSchemaDefinition(config): Promise<<a href="#schemadefinitionrestdto">SchemaDefinitionRestDto</a>></strong>
|
|
8317
|
+
<strong>settingsSchemasClient.getSchemaDefinition(config): Promise<<a href="#schemadefinitionrestdto" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDto</a>></strong>
|
|
8267
8318
|
|
|
8268
8319
|
<div class="padding-left--md">
|
|
8269
8320
|
|
|
@@ -8325,7 +8376,7 @@ import { syntheticHttpMonitorExecutionsClient } from '@dynatrace-sdk/client-clas
|
|
|
8325
8376
|
### getExecutionResult
|
|
8326
8377
|
|
|
8327
8378
|
<div class="padding-bottom--md">
|
|
8328
|
-
<strong>syntheticHttpMonitorExecutionsClient.getExecutionResult(config): Promise<<a href="#monitorexecutionresults"
|
|
8379
|
+
<strong>syntheticHttpMonitorExecutionsClient.getExecutionResult(config): Promise<<a href="#monitorexecutionresults">MonitorExecutionResults</a>></strong>
|
|
8329
8380
|
|
|
8330
8381
|
<div class="padding-left--md">
|
|
8331
8382
|
|
|
@@ -8389,7 +8440,7 @@ import { syntheticLocationsNodesAndConfigurationClient } from '@dynatrace-sdk/cl
|
|
|
8389
8440
|
### addLocation
|
|
8390
8441
|
|
|
8391
8442
|
<div class="padding-bottom--md">
|
|
8392
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.addLocation(config): Promise<<a href="#syntheticlocationidsdto">SyntheticLocationIdsDto</a>></strong>
|
|
8443
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.addLocation(config): Promise<<a href="#syntheticlocationidsdto" target="_blank" rel="noopener noreferrer">SyntheticLocationIdsDto</a>></strong>
|
|
8393
8444
|
|
|
8394
8445
|
<div class="padding-left--md">
|
|
8395
8446
|
|
|
@@ -8407,7 +8458,7 @@ Creates a new private synthetic location
|
|
|
8407
8458
|
|
|
8408
8459
|
| Name | Type |
|
|
8409
8460
|
| --- | --- |
|
|
8410
|
-
|config.body<sup>*required</sup>|<a href="#privatesyntheticlocation"
|
|
8461
|
+
|config.body<sup>*required</sup>|<a href="#privatesyntheticlocation">PrivateSyntheticLocation</a>|
|
|
8411
8462
|
|
|
8412
8463
|
|
|
8413
8464
|
|
|
@@ -8442,7 +8493,7 @@ const data =
|
|
|
8442
8493
|
### getConfiguration
|
|
8443
8494
|
|
|
8444
8495
|
<div class="padding-bottom--md">
|
|
8445
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getConfiguration(abortSignal?): Promise<<a href="#syntheticconfigdto">SyntheticConfigDto</a>></strong>
|
|
8496
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getConfiguration(abortSignal?): Promise<<a href="#syntheticconfigdto" target="_blank" rel="noopener noreferrer">SyntheticConfigDto</a>></strong>
|
|
8446
8497
|
|
|
8447
8498
|
<div class="padding-left--md">
|
|
8448
8499
|
|
|
@@ -8485,7 +8536,7 @@ const data =
|
|
|
8485
8536
|
### getLocation
|
|
8486
8537
|
|
|
8487
8538
|
<div class="padding-bottom--md">
|
|
8488
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocation(config): Promise<<a href="#syntheticlocation"
|
|
8539
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocation(config): Promise<<a href="#syntheticlocation">SyntheticLocation</a>></strong>
|
|
8489
8540
|
|
|
8490
8541
|
<div class="padding-left--md">
|
|
8491
8542
|
|
|
@@ -8706,7 +8757,7 @@ const data =
|
|
|
8706
8757
|
### getLocations
|
|
8707
8758
|
|
|
8708
8759
|
<div class="padding-bottom--md">
|
|
8709
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocations(config): Promise<<a href="#syntheticlocations">SyntheticLocations</a>></strong>
|
|
8760
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocations(config): Promise<<a href="#syntheticlocations" target="_blank" rel="noopener noreferrer">SyntheticLocations</a>></strong>
|
|
8710
8761
|
|
|
8711
8762
|
<div class="padding-left--md">
|
|
8712
8763
|
|
|
@@ -8759,7 +8810,7 @@ const data =
|
|
|
8759
8810
|
### getLocationsStatus
|
|
8760
8811
|
|
|
8761
8812
|
<div class="padding-bottom--md">
|
|
8762
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationsStatus(abortSignal?): Promise<<a href="#syntheticpubliclocationsstatus"
|
|
8813
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getLocationsStatus(abortSignal?): Promise<<a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a>></strong>
|
|
8763
8814
|
|
|
8764
8815
|
<div class="padding-left--md">
|
|
8765
8816
|
|
|
@@ -8802,7 +8853,7 @@ const data =
|
|
|
8802
8853
|
### getNode
|
|
8803
8854
|
|
|
8804
8855
|
<div class="padding-bottom--md">
|
|
8805
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getNode(config): Promise<<a href="#node">Node</a>></strong>
|
|
8856
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getNode(config): Promise<<a href="#node" target="_blank" rel="noopener noreferrer">Node</a>></strong>
|
|
8806
8857
|
|
|
8807
8858
|
<div class="padding-left--md">
|
|
8808
8859
|
|
|
@@ -8855,7 +8906,7 @@ const data =
|
|
|
8855
8906
|
### getNodes
|
|
8856
8907
|
|
|
8857
8908
|
<div class="padding-bottom--md">
|
|
8858
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.getNodes(abortSignal?): Promise<<a href="#nodes"
|
|
8909
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.getNodes(abortSignal?): Promise<<a href="#nodes">Nodes</a>></strong>
|
|
8859
8910
|
|
|
8860
8911
|
<div class="padding-left--md">
|
|
8861
8912
|
|
|
@@ -8947,7 +8998,7 @@ const data =
|
|
|
8947
8998
|
### updateConfiguration
|
|
8948
8999
|
|
|
8949
9000
|
<div class="padding-bottom--md">
|
|
8950
|
-
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<<a href="#syntheticconfigdto">SyntheticConfigDto</a>></strong>
|
|
9001
|
+
<strong>syntheticLocationsNodesAndConfigurationClient.updateConfiguration(config): Promise<<a href="#syntheticconfigdto" target="_blank" rel="noopener noreferrer">SyntheticConfigDto</a>></strong>
|
|
8951
9002
|
|
|
8952
9003
|
<div class="padding-left--md">
|
|
8953
9004
|
|
|
@@ -8965,7 +9016,7 @@ Updates set of synthetic related parameters defined for whole tenant (affects al
|
|
|
8965
9016
|
|
|
8966
9017
|
| Name | Type |
|
|
8967
9018
|
| --- | --- |
|
|
8968
|
-
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto"
|
|
9019
|
+
|config.body<sup>*required</sup>|<a href="#syntheticconfigdto">SyntheticConfigDto</a>|
|
|
8969
9020
|
|
|
8970
9021
|
|
|
8971
9022
|
|
|
@@ -9020,7 +9071,7 @@ For public locations you can only change the location status.
|
|
|
9020
9071
|
|
|
9021
9072
|
| Name | Type | Description |
|
|
9022
9073
|
| --- | --- | --- |
|
|
9023
|
-
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate">SyntheticLocationUpdate</a>| |
|
|
9074
|
+
|config.body<sup>*required</sup>|<a href="#syntheticlocationupdate" target="_blank" rel="noopener noreferrer">SyntheticLocationUpdate</a>| |
|
|
9024
9075
|
|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the synthetic location to be updated. |
|
|
9025
9076
|
|
|
9026
9077
|
|
|
@@ -9070,7 +9121,7 @@ Changes the status of public synthetic locations
|
|
|
9070
9121
|
|
|
9071
9122
|
| Name | Type |
|
|
9072
9123
|
| --- | --- |
|
|
9073
|
-
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus"
|
|
9124
|
+
|config.body<sup>*required</sup>|<a href="#syntheticpubliclocationsstatus">SyntheticPublicLocationsStatus</a>|
|
|
9074
9125
|
|
|
9075
9126
|
|
|
9076
9127
|
|
|
@@ -9107,7 +9158,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
9107
9158
|
### createMonitor
|
|
9108
9159
|
|
|
9109
9160
|
<div class="padding-bottom--md">
|
|
9110
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto">MonitorEntityIdDto</a>></strong>
|
|
9161
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.createMonitor(config): Promise<<a href="#monitorentityiddto" target="_blank" rel="noopener noreferrer">MonitorEntityIdDto</a>></strong>
|
|
9111
9162
|
|
|
9112
9163
|
<div class="padding-left--md">
|
|
9113
9164
|
|
|
@@ -9125,7 +9176,7 @@ Creates a synthetic monitor definition. Currently network availability monitors
|
|
|
9125
9176
|
|
|
9126
9177
|
| Name | Type |
|
|
9127
9178
|
| --- | --- |
|
|
9128
|
-
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorupdatedto"
|
|
9179
|
+
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a>|
|
|
9129
9180
|
|
|
9130
9181
|
|
|
9131
9182
|
|
|
@@ -9209,7 +9260,7 @@ const data =
|
|
|
9209
9260
|
### getMonitor
|
|
9210
9261
|
|
|
9211
9262
|
<div class="padding-bottom--md">
|
|
9212
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticmultiprotocolmonitordto">SyntheticMultiProtocolMonitorDto</a>></strong>
|
|
9263
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitor(config): Promise<<a href="#syntheticmultiprotocolmonitordto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorDto</a>></strong>
|
|
9213
9264
|
|
|
9214
9265
|
<div class="padding-left--md">
|
|
9215
9266
|
|
|
@@ -9262,7 +9313,7 @@ const data =
|
|
|
9262
9313
|
### getMonitors
|
|
9263
9314
|
|
|
9264
9315
|
<div class="padding-bottom--md">
|
|
9265
|
-
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto"
|
|
9316
|
+
<strong>syntheticNetworkAvailabilityMonitorsClient.getMonitors(config): Promise<<a href="#syntheticmonitorlistdto">SyntheticMonitorListDto</a>></strong>
|
|
9266
9317
|
|
|
9267
9318
|
<div class="padding-left--md">
|
|
9268
9319
|
|
|
@@ -9331,7 +9382,7 @@ Updates a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
9331
9382
|
|
|
9332
9383
|
| Name | Type | Description |
|
|
9333
9384
|
| --- | --- | --- |
|
|
9334
|
-
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorupdatedto">SyntheticMultiProtocolMonitorUpdateDto</a>| |
|
|
9385
|
+
|config.body<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorupdatedto" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorUpdateDto</a>| |
|
|
9335
9386
|
|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
9336
9387
|
|
|
9337
9388
|
|
|
@@ -9369,7 +9420,7 @@ import { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-
|
|
|
9369
9420
|
### execute
|
|
9370
9421
|
|
|
9371
9422
|
<div class="padding-bottom--md">
|
|
9372
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.execute(config): Promise<<a href="#syntheticondemandexecutionresult"
|
|
9423
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.execute(config): Promise<<a href="#syntheticondemandexecutionresult">SyntheticOnDemandExecutionResult</a>></strong>
|
|
9373
9424
|
|
|
9374
9425
|
<div class="padding-left--md">
|
|
9375
9426
|
|
|
@@ -9387,7 +9438,7 @@ Triggers on-demand executions for synthetic monitors
|
|
|
9387
9438
|
|
|
9388
9439
|
| Name | Type |
|
|
9389
9440
|
| --- | --- |
|
|
9390
|
-
|config.body<sup>*required</sup>|<a href="#syntheticondemandexecutionrequest">SyntheticOnDemandExecutionRequest</a>|
|
|
9441
|
+
|config.body<sup>*required</sup>|<a href="#syntheticondemandexecutionrequest" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequest</a>|
|
|
9391
9442
|
|
|
9392
9443
|
|
|
9393
9444
|
|
|
@@ -9422,7 +9473,7 @@ const data =
|
|
|
9422
9473
|
### getBatch
|
|
9423
9474
|
|
|
9424
9475
|
<div class="padding-bottom--md">
|
|
9425
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getBatch(config): Promise<<a href="#syntheticondemandbatchstatus"
|
|
9476
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getBatch(config): Promise<<a href="#syntheticondemandbatchstatus">SyntheticOnDemandBatchStatus</a>></strong>
|
|
9426
9477
|
|
|
9427
9478
|
<div class="padding-left--md">
|
|
9428
9479
|
|
|
@@ -9475,7 +9526,7 @@ const data =
|
|
|
9475
9526
|
### getExecution
|
|
9476
9527
|
|
|
9477
9528
|
<div class="padding-bottom--md">
|
|
9478
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecution(config): Promise<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>></strong>
|
|
9529
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecution(config): Promise<<a href="#syntheticondemandexecution" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecution</a>></strong>
|
|
9479
9530
|
|
|
9480
9531
|
<div class="padding-left--md">
|
|
9481
9532
|
|
|
@@ -9528,7 +9579,7 @@ const data =
|
|
|
9528
9579
|
### getExecutionFullReport
|
|
9529
9580
|
|
|
9530
9581
|
<div class="padding-bottom--md">
|
|
9531
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(config): Promise<<a href="#syntheticondemandexecution"
|
|
9582
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(config): Promise<<a href="#syntheticondemandexecution">SyntheticOnDemandExecution</a>></strong>
|
|
9532
9583
|
|
|
9533
9584
|
<div class="padding-left--md">
|
|
9534
9585
|
|
|
@@ -9581,7 +9632,7 @@ const data =
|
|
|
9581
9632
|
### getExecutions
|
|
9582
9633
|
|
|
9583
9634
|
<div class="padding-bottom--md">
|
|
9584
|
-
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutions(config): Promise<<a href="#syntheticondemandexecutions">SyntheticOnDemandExecutions</a>></strong>
|
|
9635
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.getExecutions(config): Promise<<a href="#syntheticondemandexecutions" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutions</a>></strong>
|
|
9585
9636
|
|
|
9586
9637
|
<div class="padding-left--md">
|
|
9587
9638
|
|
|
@@ -9636,10 +9687,148 @@ const data =
|
|
|
9636
9687
|
|
|
9637
9688
|
|
|
9638
9689
|
|
|
9690
|
+
</div>
|
|
9691
|
+
|
|
9692
|
+
|
|
9693
|
+
<a name="rerun"></a>
|
|
9694
|
+
### rerun
|
|
9695
|
+
|
|
9696
|
+
<div class="padding-bottom--md">
|
|
9697
|
+
<strong>syntheticOnDemandMonitorExecutionsClient.rerun(config): Promise<<a href="#syntheticondemandexecutionresult">SyntheticOnDemandExecutionResult</a>></strong>
|
|
9698
|
+
|
|
9699
|
+
<div class="padding-left--md">
|
|
9700
|
+
|
|
9701
|
+
Reruns specified on-demand execution of synthetic monitors
|
|
9702
|
+
|
|
9703
|
+
**Required scope:** environment-api:synthetic-execution:write
|
|
9704
|
+
**Required permission:** environment:roles:viewer
|
|
9705
|
+
|
|
9706
|
+
|
|
9707
|
+
|
|
9708
|
+
</div>
|
|
9709
|
+
|
|
9710
|
+
|
|
9711
|
+
#### Parameters
|
|
9712
|
+
|
|
9713
|
+
| Name | Type | Description |
|
|
9714
|
+
| --- | --- | --- |
|
|
9715
|
+
|config.executionId<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The identifier of the on-demand execution. |
|
|
9716
|
+
|
|
9717
|
+
|
|
9718
|
+
|
|
9719
|
+
|
|
9720
|
+
#### Returns
|
|
9721
|
+
|
|
9722
|
+
Success. The monitor&apos;s execution response details
|
|
9723
|
+
|
|
9724
|
+
|
|
9725
|
+
<details>
|
|
9726
|
+
<summary>
|
|
9727
|
+
Code example
|
|
9728
|
+
</summary>
|
|
9729
|
+
|
|
9730
|
+
```ts
|
|
9731
|
+
import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
9732
|
+
|
|
9733
|
+
const data =
|
|
9734
|
+
await syntheticOnDemandMonitorExecutionsClient.rerun({
|
|
9735
|
+
executionId: 10,
|
|
9736
|
+
});
|
|
9737
|
+
```
|
|
9738
|
+
|
|
9739
|
+
</details>
|
|
9740
|
+
|
|
9741
|
+
|
|
9742
|
+
|
|
9639
9743
|
</div>
|
|
9640
9744
|
|
|
9641
9745
|
## Types
|
|
9642
9746
|
|
|
9747
|
+
### ApiClientError
|
|
9748
|
+
|
|
9749
|
+
|
|
9750
|
+
|
|
9751
|
+
|
|
9752
|
+
Error base. All client errors should extend this class.
|
|
9753
|
+
|
|
9754
|
+
| Name | Type | Description |
|
|
9755
|
+
| --- | --- | --- |
|
|
9756
|
+
|cause|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| |
|
|
9757
|
+
|errorType<sup>*required</sup>|ErrorType| |
|
|
9758
|
+
|isApiClientError<sup>*required</sup>|true| |
|
|
9759
|
+
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9760
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9761
|
+
|stack|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9762
|
+
|prepareStackTrace|Object|Optional override for formatting stack traces |
|
|
9763
|
+
|stackTraceLimit<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9764
|
+
|
|
9765
|
+
### ApiGatewayError
|
|
9766
|
+
|
|
9767
|
+
|
|
9768
|
+
|
|
9769
|
+
|
|
9770
|
+
Error base. All client errors should extend this class.
|
|
9771
|
+
|
|
9772
|
+
| Name | Type | Description |
|
|
9773
|
+
| --- | --- | --- |
|
|
9774
|
+
|body<sup>*required</sup>|ApiGatewayErrorResponseBody| |
|
|
9775
|
+
|cause|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| |
|
|
9776
|
+
|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9777
|
+
|errorType<sup>*required</sup>|ErrorType| |
|
|
9778
|
+
|isApiClientError<sup>*required</sup>|true| |
|
|
9779
|
+
|isApiGatewayError<sup>*required</sup>|true| |
|
|
9780
|
+
|isClientRequestError<sup>*required</sup>|true| |
|
|
9781
|
+
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9782
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9783
|
+
|response<sup>*required</sup>|HttpClientResponse| |
|
|
9784
|
+
|retryAfterSeconds<sup>*required</sup>|undefined | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9785
|
+
|stack|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9786
|
+
|prepareStackTrace|Object|Optional override for formatting stack traces |
|
|
9787
|
+
|stackTraceLimit<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9788
|
+
|
|
9789
|
+
### ClientRequestError
|
|
9790
|
+
|
|
9791
|
+
|
|
9792
|
+
|
|
9793
|
+
|
|
9794
|
+
Error base. All client errors should extend this class.
|
|
9795
|
+
|
|
9796
|
+
| Name | Type | Description |
|
|
9797
|
+
| --- | --- | --- |
|
|
9798
|
+
|body<sup>*required</sup>|DTO| |
|
|
9799
|
+
|cause|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| |
|
|
9800
|
+
|errorType<sup>*required</sup>|ErrorType| |
|
|
9801
|
+
|isApiClientError<sup>*required</sup>|true| |
|
|
9802
|
+
|isClientRequestError<sup>*required</sup>|true| |
|
|
9803
|
+
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9804
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9805
|
+
|response<sup>*required</sup>|HttpClientResponse| |
|
|
9806
|
+
|stack|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9807
|
+
|prepareStackTrace|Object|Optional override for formatting stack traces |
|
|
9808
|
+
|stackTraceLimit<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9809
|
+
|
|
9810
|
+
### InvalidResponseError
|
|
9811
|
+
|
|
9812
|
+
|
|
9813
|
+
|
|
9814
|
+
|
|
9815
|
+
Error base. All client errors should extend this class.
|
|
9816
|
+
|
|
9817
|
+
| Name | Type | Description |
|
|
9818
|
+
| --- | --- | --- |
|
|
9819
|
+
|cause|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| |
|
|
9820
|
+
|errorType<sup>*required</sup>|ErrorType| |
|
|
9821
|
+
|expectedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9822
|
+
|isApiClientError<sup>*required</sup>|true| |
|
|
9823
|
+
|isInvalidResponseError<sup>*required</sup>|true| |
|
|
9824
|
+
|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9825
|
+
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9826
|
+
|nestedError|<a href="#error" target="_blank" rel="noopener noreferrer">Error</a>| |
|
|
9827
|
+
|responseBody<sup>*required</sup>|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| |
|
|
9828
|
+
|stack|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
9829
|
+
|prepareStackTrace|Object|Optional override for formatting stack traces |
|
|
9830
|
+
|stackTraceLimit<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
9831
|
+
|
|
9643
9832
|
### AbstractCredentialsResponseElement
|
|
9644
9833
|
|
|
9645
9834
|
|
|
@@ -9649,15 +9838,15 @@ Credentials set.
|
|
|
9649
9838
|
|
|
9650
9839
|
| Name | Type | Description |
|
|
9651
9840
|
| --- | --- | --- |
|
|
9652
|
-
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler"
|
|
9841
|
+
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
9653
9842
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
9654
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>| |
|
|
9843
|
+
|externalVault|<a href="#externalvaultconfig" target="_blank" rel="noopener noreferrer">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
9655
9844
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
9656
9845
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
9657
9846
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
9658
9847
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
9659
|
-
|scope|AbstractCredentialsResponseElementScope| |
|
|
9660
|
-
|type<sup>*required</sup>|AbstractCredentialsResponseElementType
|
|
9848
|
+
|scope|AbstractCredentialsResponseElementScope|The scope of the credentials set. |
|
|
9849
|
+
|type<sup>*required</sup>|AbstractCredentialsResponseElementType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
9661
9850
|
|
|
9662
9851
|
### AbstractSloAlertDto
|
|
9663
9852
|
|
|
@@ -9670,7 +9859,7 @@ Credentials set.
|
|
|
9670
9859
|
| --- | --- | --- |
|
|
9671
9860
|
|alertName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the alert. |
|
|
9672
9861
|
|alertThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value. |
|
|
9673
|
-
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType
|
|
9862
|
+
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BURN_RATE</code> -> BurnRateAlert</li> <li><code>STATUS</code> -> StatusAlert</li> </ul> |
|
|
9674
9863
|
|
|
9675
9864
|
### ActiveGate
|
|
9676
9865
|
|
|
@@ -9681,10 +9870,10 @@ Parameters of the ActiveGate.
|
|
|
9681
9870
|
|
|
9682
9871
|
| Name | Type | Description |
|
|
9683
9872
|
| --- | --- | --- |
|
|
9684
|
-
|activeGateTokens|Array<<a href="#activegatetokeninfodto"
|
|
9685
|
-
|autoUpdateSettings|<a href="#activegateautoupdateconfig">ActiveGateAutoUpdateConfig</a>| |
|
|
9686
|
-
|autoUpdateStatus|ActiveGateAutoUpdateStatus| |
|
|
9687
|
-
|connectedHosts|<a href="#activegateconnectedhosts"
|
|
9873
|
+
|activeGateTokens|Array<<a href="#activegatetokeninfodto">ActiveGateTokenInfoDto</a>>|A list of the ActiveGate tokens. |
|
|
9874
|
+
|autoUpdateSettings|<a href="#activegateautoupdateconfig" target="_blank" rel="noopener noreferrer">ActiveGateAutoUpdateConfig</a>|Configuration of the ActiveGate auto-updates. |
|
|
9875
|
+
|autoUpdateStatus|ActiveGateAutoUpdateStatus|The current status of auto-updates of the ActiveGate. |
|
|
9876
|
+
|connectedHosts|<a href="#activegateconnectedhosts">ActiveGateConnectedHosts</a>|Information about hosts currently connected to the ActiveGate |
|
|
9688
9877
|
|containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ActiveGate is deployed in container (<code>true</code>) or not (<code>false</code>). |
|
|
9689
9878
|
|environments|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of environments (specified by IDs) the ActiveGate can connect to. |
|
|
9690
9879
|
|group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The group of the ActiveGate. |
|
|
@@ -9692,14 +9881,14 @@ Parameters of the ActiveGate.
|
|
|
9692
9881
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the ActiveGate. |
|
|
9693
9882
|
|loadBalancerAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of Load Balancer addresses of the ActiveGate. |
|
|
9694
9883
|
|mainEnvironment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the main environment for a multi-environment ActiveGate. |
|
|
9695
|
-
|modules|Array<<a href="#activegatemodule">ActiveGateModule</a>>|A list of modules of the ActiveGate. |
|
|
9884
|
+
|modules|Array<<a href="#activegatemodule" target="_blank" rel="noopener noreferrer">ActiveGateModule</a>>|A list of modules of the ActiveGate. |
|
|
9696
9885
|
|networkAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of network addresses of the ActiveGate. |
|
|
9697
9886
|
|networkZone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The network zone of the ActiveGate. |
|
|
9698
9887
|
|offlineSince|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp since when the ActiveGate is offline.</p> <p>The <code>null</code> value means the ActiveGate is online.</p> |
|
|
9699
|
-
|osArchitecture|ActiveGateOsArchitecture| |
|
|
9700
|
-
|osBitness|_64| |
|
|
9701
|
-
|osType|ActiveGateOsType| |
|
|
9702
|
-
|type|ActiveGateType| |
|
|
9888
|
+
|osArchitecture|ActiveGateOsArchitecture|The OS architecture that the ActiveGate is running on. |
|
|
9889
|
+
|osBitness|_64|The OS bitness that the ActiveGate is running on. |
|
|
9890
|
+
|osType|ActiveGateOsType|The OS type that the ActiveGate is running on. |
|
|
9891
|
+
|type|ActiveGateType|The type of the ActiveGate. |
|
|
9703
9892
|
|version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The current version of the ActiveGate in the <code><major>.<minor>.<revision>.<timestamp></code> format. |
|
|
9704
9893
|
|
|
9705
9894
|
### ActiveGateAutoUpdateConfig
|
|
@@ -9709,10 +9898,10 @@ Parameters of the ActiveGate.
|
|
|
9709
9898
|
|
|
9710
9899
|
Configuration of the ActiveGate auto-updates.
|
|
9711
9900
|
|
|
9712
|
-
| Name | Type |
|
|
9713
|
-
| --- | --- |
|
|
9714
|
-
|effectiveSetting|ActiveGateAutoUpdateConfigEffectiveSetting|
|
|
9715
|
-
|setting<sup>*required</sup>|ActiveGateAutoUpdateConfigSetting|
|
|
9901
|
+
| Name | Type | Description |
|
|
9902
|
+
| --- | --- | --- |
|
|
9903
|
+
|effectiveSetting|ActiveGateAutoUpdateConfigEffectiveSetting|<p>The actual state of the ActiveGate auto-update.</p> <p>Applicable only if the <strong>setting</strong> parameter is set to <code>INHERITED</code>. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the <strong>setting</strong> value.</p> |
|
|
9904
|
+
|setting<sup>*required</sup>|ActiveGateAutoUpdateConfigSetting|<p>The state of the ActiveGate auto-update: enabled, disabled, or inherited.</p> <p>If set to <code>INHERITED</code>, the setting is inherited from the global configuration set on the environment or Managed cluster level.</p> |
|
|
9716
9905
|
|
|
9717
9906
|
### ActiveGateConnectedHosts
|
|
9718
9907
|
|
|
@@ -9732,10 +9921,21 @@ Information about hosts currently connected to the ActiveGate
|
|
|
9732
9921
|
|
|
9733
9922
|
Global configuration of ActiveGates auto-update.
|
|
9734
9923
|
|
|
9735
|
-
| Name | Type |
|
|
9736
|
-
| --- | --- |
|
|
9737
|
-
|globalSetting<sup>*required</sup>|ActiveGateGlobalAutoUpdateConfigGlobalSetting|
|
|
9738
|
-
|metadata|<a href="#configurationmetadata"
|
|
9924
|
+
| Name | Type | Description |
|
|
9925
|
+
| --- | --- | --- |
|
|
9926
|
+
|globalSetting<sup>*required</sup>|ActiveGateGlobalAutoUpdateConfigGlobalSetting|<p>The state of auto-updates for all ActiveGates connected to the environment or Managed cluster.</p> <p>This setting is inherited by all ActiveGates that have the <code>INHERITED</code> setting.</p> |
|
|
9927
|
+
|metadata|<a href="#configurationmetadata">ConfigurationMetadata</a>|Metadata useful for debugging |
|
|
9928
|
+
|
|
9929
|
+
### ActiveGateGroup
|
|
9930
|
+
|
|
9931
|
+
|
|
9932
|
+
|
|
9933
|
+
|
|
9934
|
+
Information about ActiveGate group.
|
|
9935
|
+
|
|
9936
|
+
| Name | Type | Description |
|
|
9937
|
+
| --- | --- | --- |
|
|
9938
|
+
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of ActiveGate group |
|
|
9739
9939
|
|
|
9740
9940
|
### ActiveGateGroupInfoDto
|
|
9741
9941
|
|
|
@@ -9746,10 +9946,21 @@ Metadata for each ActiveGate group.
|
|
|
9746
9946
|
|
|
9747
9947
|
| Name | Type | Description |
|
|
9748
9948
|
| --- | --- | --- |
|
|
9749
|
-
|activeGates<sup>*required</sup>|Array<<a href="#activegateinfodto">ActiveGateInfoDto</a>>|ActiveGates in group. |
|
|
9949
|
+
|activeGates<sup>*required</sup>|Array<<a href="#activegateinfodto" target="_blank" rel="noopener noreferrer">ActiveGateInfoDto</a>>|ActiveGates in group. |
|
|
9750
9950
|
|availableActiveGates<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of ActiveGates in group available for extension. |
|
|
9751
9951
|
|groupName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ActiveGate group name. |
|
|
9752
9952
|
|
|
9953
|
+
### ActiveGateGroups
|
|
9954
|
+
|
|
9955
|
+
|
|
9956
|
+
|
|
9957
|
+
|
|
9958
|
+
The collection of ActiveGate groups.
|
|
9959
|
+
|
|
9960
|
+
| Name | Type | Description |
|
|
9961
|
+
| --- | --- | --- |
|
|
9962
|
+
|groups|Array<<a href="#activegategroup">ActiveGateGroup</a>>|List of ActiveGate groups |
|
|
9963
|
+
|
|
9753
9964
|
### ActiveGateGroupsInfoDto
|
|
9754
9965
|
|
|
9755
9966
|
|
|
@@ -9793,10 +10004,10 @@ Information about ActiveGate module
|
|
|
9793
10004
|
|
|
9794
10005
|
| Name | Type | Description |
|
|
9795
10006
|
| --- | --- | --- |
|
|
9796
|
-
|attributes|<a href="#activegatemoduleattributes" target="_blank" rel="noopener noreferrer">ActiveGateModuleAttributes</a>| |
|
|
10007
|
+
|attributes|<a href="#activegatemoduleattributes" target="_blank" rel="noopener noreferrer">ActiveGateModuleAttributes</a>|The attributes of the ActiveGate module. |
|
|
9797
10008
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
9798
10009
|
|misconfigured|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The module is misconfigured (<code>true</code>) or not (<code>false</code>). |
|
|
9799
|
-
|type|ActiveGateModuleType| |
|
|
10010
|
+
|type|ActiveGateModuleType|The type of ActiveGate module. |
|
|
9800
10011
|
|version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the ActiveGate module. |
|
|
9801
10012
|
|
|
9802
10013
|
### ActiveGateModuleAttributes
|
|
@@ -9815,7 +10026,7 @@ Metadata of an ActiveGate token.
|
|
|
9815
10026
|
|
|
9816
10027
|
| Name | Type | Description |
|
|
9817
10028
|
| --- | --- | --- |
|
|
9818
|
-
|activeGateType<sup>*required</sup>|ActiveGateTokenActiveGateType| |
|
|
10029
|
+
|activeGateType<sup>*required</sup>|ActiveGateTokenActiveGateType|The type of the ActiveGate for which the token is valid. |
|
|
9819
10030
|
|creationDate<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The token creation date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>). |
|
|
9820
10031
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The token expiration date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).</p> <p>If not set, the token never expires.</p> |
|
|
9821
10032
|
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ActiveGate token identifier, consisting of <a href="https://dt-url.net/rn00tjg" target="_blank" rel="noopener noreferrer" >prefix and public part</a> of the token. |
|
|
@@ -9833,7 +10044,7 @@ Parameters of a new ActiveGate token.
|
|
|
9833
10044
|
|
|
9834
10045
|
| Name | Type | Description |
|
|
9835
10046
|
| --- | --- | --- |
|
|
9836
|
-
|activeGateType<sup>*required</sup>|ActiveGateTokenCreateActiveGateType| |
|
|
10047
|
+
|activeGateType<sup>*required</sup>|ActiveGateTokenCreateActiveGateType|The type of the ActiveGate for which the token is valid. |
|
|
9837
10048
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The expiration date of the token.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the token never expires.</p> <p>Ensure that it is not set in the past and does not exceed <code>2 years</code> from the moment of creation."</p> |
|
|
9838
10049
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9839
10050
|
|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The token is a seed token (<code>true</code>) or an individual token (<code>false</code>).</p> <p>We recommend the individual token option (false).</p> |
|
|
@@ -9862,7 +10073,7 @@ Information about ActiveGate token.
|
|
|
9862
10073
|
| --- | --- | --- |
|
|
9863
10074
|
|environmentId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The environment ID to which the token belongs.</p> <p>Only available if more than one environment is supported.</p> |
|
|
9864
10075
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ActiveGate token identifier, consisting of <a href="https://dt-url.net/rn00tjg" target="_blank" rel="noopener noreferrer" >prefix and public part</a> of the token. |
|
|
9865
|
-
|state|ActiveGateTokenInfoDtoState| |
|
|
10076
|
+
|state|ActiveGateTokenInfoDtoState|State of the ActiveGate token. |
|
|
9866
10077
|
|
|
9867
10078
|
### ActiveGateTokenList
|
|
9868
10079
|
|
|
@@ -9920,10 +10131,10 @@ A list of custom tags added to monitored entities.
|
|
|
9920
10131
|
|
|
9921
10132
|
Information about affected entities of an attack.
|
|
9922
10133
|
|
|
9923
|
-
| Name | Type |
|
|
9924
|
-
| --- | --- |
|
|
9925
|
-
|processGroup|<a href="#affectedentity" target="_blank" rel="noopener noreferrer">AffectedEntity</a>|
|
|
9926
|
-
|processGroupInstance|<a href="#affectedentity">AffectedEntity</a>|
|
|
10134
|
+
| Name | Type | Description |
|
|
10135
|
+
| --- | --- | --- |
|
|
10136
|
+
|processGroup|<a href="#affectedentity" target="_blank" rel="noopener noreferrer">AffectedEntity</a>|Information about an affected entity. |
|
|
10137
|
+
|processGroupInstance|<a href="#affectedentity">AffectedEntity</a>|Information about an affected entity. |
|
|
9927
10138
|
|
|
9928
10139
|
### AffectedEntity
|
|
9929
10140
|
|
|
@@ -9946,7 +10157,7 @@ Aggregated log records.
|
|
|
9946
10157
|
|
|
9947
10158
|
| Name | Type | Description |
|
|
9948
10159
|
| --- | --- | --- |
|
|
9949
|
-
|aggregationResult|<a href="#aggregatedlogaggregationresult" target="_blank" rel="noopener noreferrer">AggregatedLogAggregationResult</a>| |
|
|
10160
|
+
|aggregationResult|<a href="#aggregatedlogaggregationresult" target="_blank" rel="noopener noreferrer">AggregatedLogAggregationResult</a>|Aggregated log records. |
|
|
9950
10161
|
|warnings|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional warning messages. |
|
|
9951
10162
|
|
|
9952
10163
|
### AggregatedLogAggregationResult
|
|
@@ -9977,7 +10188,7 @@ Metadata of an API token.
|
|
|
9977
10188
|
|
|
9978
10189
|
| Name | Type | Description |
|
|
9979
10190
|
| --- | --- | --- |
|
|
9980
|
-
|additionalMetadata|ApiTokenAdditionalMetadata
|
|
10191
|
+
|additionalMetadata|ApiTokenAdditionalMetadata|<p>Contains additional properties for specific kinds of token. Examples:</p> <ul> <li>A <code>dashboardId</code> property for dashboard sharing tokens.</li> <li>A <code>reportId</code> property for report sharing tokens</li> </ul> |
|
|
9981
10192
|
|creationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Token creation date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>) |
|
|
9982
10193
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
9983
10194
|
|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Token expiration date in ISO 8601 format (<code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code>).</p> <p>If not set, the token never expires.</p> |
|
|
@@ -10002,7 +10213,7 @@ Parameters of a new API token.
|
|
|
10002
10213
|
|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> |
|
|
10003
10214
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
10004
10215
|
|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> |
|
|
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
|
|
10216
|
+
|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 Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (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> |
|
|
10006
10217
|
|
|
10007
10218
|
### ApiTokenCreated
|
|
10008
10219
|
|
|
@@ -10053,7 +10264,7 @@ The update of the API token.
|
|
|
10053
10264
|
| --- | --- | --- |
|
|
10054
10265
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
10055
10266
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
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
|
|
10267
|
+
|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 Security Events (Built-in).</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Security Events (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> |
|
|
10057
10268
|
|
|
10058
10269
|
### ApplicationImpact
|
|
10059
10270
|
|
|
@@ -10065,8 +10276,8 @@ Analysis of problem impact to an application.
|
|
|
10065
10276
|
| Name | Type | Description |
|
|
10066
10277
|
| --- | --- | --- |
|
|
10067
10278
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
10068
|
-
|impactType<sup>*required</sup>|ImpactImpactType
|
|
10069
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
10279
|
+
|impactType<sup>*required</sup>|ImpactImpactType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
10280
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
10070
10281
|
|
|
10071
10282
|
### AppliedFilter
|
|
10072
10283
|
|
|
@@ -10078,7 +10289,7 @@ Optional filters that took effect.
|
|
|
10078
10289
|
| Name | Type | Description |
|
|
10079
10290
|
| --- | --- | --- |
|
|
10080
10291
|
|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> |
|
|
10081
|
-
|filter|<a href="#filter">Filter</a>| |
|
|
10292
|
+
|filter|<a href="#filter">Filter</a>|A dimensional or series filter on a metric. |
|
|
10082
10293
|
|
|
10083
10294
|
### AssessmentAccuracyDetails
|
|
10084
10295
|
|
|
@@ -10112,10 +10323,10 @@ Metadata for an extension asset.
|
|
|
10112
10323
|
|
|
10113
10324
|
| Name | Type | Description |
|
|
10114
10325
|
| --- | --- | --- |
|
|
10115
|
-
|assetSchemaDetails|<a href="#assetschemadetailsdto" target="_blank" rel="noopener noreferrer">AssetSchemaDetailsDto</a>| |
|
|
10326
|
+
|assetSchemaDetails|<a href="#assetschemadetailsdto" target="_blank" rel="noopener noreferrer">AssetSchemaDetailsDto</a>|Settings schema details for asset |
|
|
10116
10327
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-friendly name of the asset. |
|
|
10117
10328
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ID of the asset. Identifies the asset in REST API and/or UI (where applicable). |
|
|
10118
|
-
|type|AssetInfoDtoType| |
|
|
10329
|
+
|type|AssetInfoDtoType|The type of the asset. |
|
|
10119
10330
|
|
|
10120
10331
|
### AssetSchemaDetailsDto
|
|
10121
10332
|
|
|
@@ -10139,21 +10350,21 @@ Describes an attack.
|
|
|
10139
10350
|
|
|
10140
10351
|
| Name | Type | Description |
|
|
10141
10352
|
| --- | --- | --- |
|
|
10142
|
-
|affectedEntities|<a href="#affectedentities">AffectedEntities</a>| |
|
|
10353
|
+
|affectedEntities|<a href="#affectedentities">AffectedEntities</a>|Information about affected entities of an attack. |
|
|
10143
10354
|
|attackId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the attack. |
|
|
10144
|
-
|attackTarget|<a href="#attacktarget" target="_blank" rel="noopener noreferrer">AttackTarget</a>| |
|
|
10145
|
-
|attackType|AttackAttackType| |
|
|
10146
|
-
|attacker|<a href="#attacker">Attacker</a>| |
|
|
10355
|
+
|attackTarget|<a href="#attacktarget" target="_blank" rel="noopener noreferrer">AttackTarget</a>|Information about the targeted host/database of an attack. |
|
|
10356
|
+
|attackType|AttackAttackType|The type of the attack. |
|
|
10357
|
+
|attacker|<a href="#attacker">Attacker</a>|Attacker of an attack. |
|
|
10147
10358
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the attack. |
|
|
10148
10359
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the attack. |
|
|
10149
|
-
|entrypoint|<a href="#attackentrypoint" target="_blank" rel="noopener noreferrer">AttackEntrypoint</a>| |
|
|
10360
|
+
|entrypoint|<a href="#attackentrypoint" target="_blank" rel="noopener noreferrer">AttackEntrypoint</a>|Describes the entrypoint used by an attacker to start a specific attack. |
|
|
10150
10361
|
|managementZones|Array<<a href="#managementzone">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
10151
|
-
|request|<a href="#requestinformation" target="_blank" rel="noopener noreferrer">RequestInformation</a>| |
|
|
10152
|
-
|securityProblem|<a href="#attacksecurityproblem">AttackSecurityProblem</a>| |
|
|
10153
|
-
|state|AttackState| |
|
|
10154
|
-
|technology|AttackTechnology| |
|
|
10362
|
+
|request|<a href="#requestinformation" target="_blank" rel="noopener noreferrer">RequestInformation</a>|Describes the complete request information of an attack. |
|
|
10363
|
+
|securityProblem|<a href="#attacksecurityproblem">AttackSecurityProblem</a>|Assessment information and the ID of a security problem related to an attack. |
|
|
10364
|
+
|state|AttackState|The state of the attack. |
|
|
10365
|
+
|technology|AttackTechnology|The technology of the attack. |
|
|
10155
10366
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the attack occurred. |
|
|
10156
|
-
|vulnerability|<a href="#vulnerability" target="_blank" rel="noopener noreferrer">Vulnerability</a>| |
|
|
10367
|
+
|vulnerability|<a href="#vulnerability" target="_blank" rel="noopener noreferrer">Vulnerability</a>|Describes the exploited vulnerability. |
|
|
10157
10368
|
|
|
10158
10369
|
### AttackEntrypoint
|
|
10159
10370
|
|
|
@@ -10164,8 +10375,8 @@ Describes the entrypoint used by an attacker to start a specific attack.
|
|
|
10164
10375
|
|
|
10165
10376
|
| Name | Type | Description |
|
|
10166
10377
|
| --- | --- | --- |
|
|
10167
|
-
|codeLocation|<a href="#codelocation">CodeLocation</a>| |
|
|
10168
|
-
|entrypointFunction|<a href="#functiondefinition" target="_blank" rel="noopener noreferrer">FunctionDefinition</a>| |
|
|
10378
|
+
|codeLocation|<a href="#codelocation">CodeLocation</a>|Information about a code location. |
|
|
10379
|
+
|entrypointFunction|<a href="#functiondefinition" target="_blank" rel="noopener noreferrer">FunctionDefinition</a>|Information about a function definition. |
|
|
10169
10380
|
|payload|Array<<a href="#attackentrypointpayloaditem">AttackEntrypointPayloadItem</a>>|All relevant payload data that has been sent during the attack. |
|
|
10170
10381
|
|
|
10171
10382
|
### AttackEntrypointPayloadItem
|
|
@@ -10177,7 +10388,7 @@ A list of values that has possibly been truncated.
|
|
|
10177
10388
|
|
|
10178
10389
|
| Name | Type | Description |
|
|
10179
10390
|
| --- | --- | --- |
|
|
10180
|
-
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>| |
|
|
10391
|
+
|truncationInfo|<a href="#truncationinfo" target="_blank" rel="noopener noreferrer">TruncationInfo</a>|Information on a possible truncation. |
|
|
10181
10392
|
|values|Array<<a href="#entrypointpayload">EntrypointPayload</a>>|Values of the list. |
|
|
10182
10393
|
|
|
10183
10394
|
### AttackList
|
|
@@ -10215,7 +10426,7 @@ Assessment information and the ID of a security problem related to an attack.
|
|
|
10215
10426
|
|
|
10216
10427
|
| Name | Type | Description |
|
|
10217
10428
|
| --- | --- | --- |
|
|
10218
|
-
|assessment|<a href="#attacksecurityproblemassessmentdto">AttackSecurityProblemAssessmentDto</a>| |
|
|
10429
|
+
|assessment|<a href="#attacksecurityproblemassessmentdto">AttackSecurityProblemAssessmentDto</a>|The assessment of a security problem related to an attack. |
|
|
10219
10430
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The security problem ID. |
|
|
10220
10431
|
|
|
10221
10432
|
### AttackSecurityProblemAssessmentDto
|
|
@@ -10227,8 +10438,8 @@ The assessment of a security problem related to an attack.
|
|
|
10227
10438
|
|
|
10228
10439
|
| Name | Type | Description |
|
|
10229
10440
|
| --- | --- | --- |
|
|
10230
|
-
|dataAssets|AttackSecurityProblemAssessmentDtoDataAssets| |
|
|
10231
|
-
|exposure|AttackSecurityProblemAssessmentDtoExposure| |
|
|
10441
|
+
|dataAssets|AttackSecurityProblemAssessmentDtoDataAssets|The reachability of data assets by the attacked target. |
|
|
10442
|
+
|exposure|AttackSecurityProblemAssessmentDtoExposure|The level of exposure of the attacked target |
|
|
10232
10443
|
|numberOfReachableDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of data assets reachable by the attacked target. |
|
|
10233
10444
|
|
|
10234
10445
|
### AttackTarget
|
|
@@ -10252,7 +10463,7 @@ Attacker of an attack.
|
|
|
10252
10463
|
|
|
10253
10464
|
| Name | Type | Description |
|
|
10254
10465
|
| --- | --- | --- |
|
|
10255
|
-
|location|<a href="#attackerlocation" target="_blank" rel="noopener noreferrer">AttackerLocation</a>| |
|
|
10466
|
+
|location|<a href="#attackerlocation" target="_blank" rel="noopener noreferrer">AttackerLocation</a>|Location of an attacker. |
|
|
10256
10467
|
|sourceIp|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The source IP of the attacker. |
|
|
10257
10468
|
|
|
10258
10469
|
### AttackerLocation
|
|
@@ -10291,7 +10502,7 @@ An entry of the audit log.
|
|
|
10291
10502
|
|
|
10292
10503
|
| Name | Type | Description |
|
|
10293
10504
|
| --- | --- | --- |
|
|
10294
|
-
|category<sup>*required</sup>|AuditLogEntryCategory| |
|
|
10505
|
+
|category<sup>*required</sup>|AuditLogEntryCategory|The category of the recorded operation. |
|
|
10295
10506
|
|dt.settings.key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the affected object of a setting for entries of category <code>CONFIG</code>. |
|
|
10296
10507
|
|dt.settings.object_id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the affected object of a setting for entries of category <code>CONFIG</code>. |
|
|
10297
10508
|
|dt.settings.object_summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value summary for entries of category <code>CONFIG</code>. |
|
|
@@ -10300,7 +10511,7 @@ An entry of the audit log.
|
|
|
10300
10511
|
|dt.settings.scope_name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the scope for entries of category <code>CONFIG</code>. |
|
|
10301
10512
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The ID of an entity from the <strong>category</strong>.</p> <p>For example, it can be config ID for the <code>CONFIG</code> category or token ID for the <code>TOKEN</code> category.</p> |
|
|
10302
10513
|
|environmentId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the Dynatrace environment where the recorded operation occurred. |
|
|
10303
|
-
|eventType<sup>*required</sup>|AuditLogEntryEventType
|
|
10514
|
+
|eventType<sup>*required</sup>|AuditLogEntryEventType|<p>The type of the recorded operation.</p> <ul> <li><code>LOGIN</code> -> A user logged in</li> <li><code>LOGOUT</code> -> A user logged out</li> <li><code>CREATE</code> -> An object was created</li> <li><code>UPDATE</code> -> An object was updated</li> <li><code>DELETE</code> -> An object was deleted</li> <li><code>REVOKE</code> -> An Active Gate token was revoked</li> <li><code>TAG_ADD</code> -> A manual tag was added</li> <li><code>TAG_REMOVE</code> -> A manual tag was removed</li> <li><code>TAG_UPDATE</code> -> A manual tag was updated</li> <li><code>REMOTE_CONFIGURATION_MANAGEMENT</code> -> A Remote Configuration Management related operation occurred</li> </ul> |
|
|
10304
10515
|
|logId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the log entry. |
|
|
10305
10516
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The logged message. |
|
|
10306
10517
|
|patch|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The patch of the recorded operation as the JSON representation.</p> <p>The format is an enhanced RFC 6902. The patch also carries the previous value in the <strong>oldValue</strong> field.</p> |
|
|
@@ -10308,7 +10519,7 @@ An entry of the audit log.
|
|
|
10308
10519
|
|timestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the record creation, in UTC milliseconds. |
|
|
10309
10520
|
|user<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the user who performed the recorded operation. |
|
|
10310
10521
|
|userOrigin|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The origin and the IP address of the <strong>user</strong>. |
|
|
10311
|
-
|userType<sup>*required</sup>|AuditLogEntryUserType
|
|
10522
|
+
|userType<sup>*required</sup>|AuditLogEntryUserType|<p>The type of the authentication of the <strong>user</strong>.</p> <ul> <li><code>USER_NAME</code> -> User was logged in the UI</li> <li><code>TOKEN_HASH</code> -> URL Token or DevOps Token, the hash of the token is logged</li> <li><code>SERVICE_NAME</code> -> No authenticated user at all, this action was performed by a system service automatically</li> <li><code>PUBLIC_TOKEN_IDENTIFIER</code> -> API Token, the public token id is logged</li> </ul> |
|
|
10312
10523
|
|
|
10313
10524
|
### AuthorDto
|
|
10314
10525
|
|
|
@@ -10334,9 +10545,9 @@ Indicates an entity that has been unavailable during the problem lifespan and th
|
|
|
10334
10545
|
| --- | --- | --- |
|
|
10335
10546
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
10336
10547
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds. |
|
|
10337
|
-
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
10338
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
10339
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>| |
|
|
10548
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
10549
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
10550
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
10340
10551
|
|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. |
|
|
10341
10552
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
10342
10553
|
|
|
@@ -10353,7 +10564,7 @@ Synchronization credentials with Azure Key Vault using client secret authenticat
|
|
|
10353
10564
|
|clientSecret|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Client secret generated for Azure application in Azure Active Directory used for proving identity when requesting a token used later for accessing secrets in Azure Key Vault. |
|
|
10354
10565
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
10355
10566
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
10356
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
10567
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
10357
10568
|
|tenantId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Tenant (directory) ID of Azure application in Azure Active Directory which has permission to access secrets in Azure Key Vault. |
|
|
10358
10569
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
10359
10570
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
@@ -10366,18 +10577,18 @@ Synchronization credentials with Azure Key Vault using client secret authenticat
|
|
|
10366
10577
|
|
|
10367
10578
|
Configuration for external vault synchronization for username and password credentials.
|
|
10368
10579
|
|
|
10369
|
-
| Name | Type |
|
|
10370
|
-
| --- | --- |
|
|
10371
|
-
|clientId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10372
|
-
|clientSecret|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10373
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
10374
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10375
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
10376
|
-
|tenantId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10377
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10378
|
-
|type|ExternalVaultConfigType|
|
|
10379
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10380
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10580
|
+
| Name | Type | Description |
|
|
10581
|
+
| --- | --- | --- |
|
|
10582
|
+
|clientId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10583
|
+
|clientSecret|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10584
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
10585
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10586
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
10587
|
+
|tenantId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10588
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10589
|
+
|type|ExternalVaultConfigType| |
|
|
10590
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10591
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10381
10592
|
|
|
10382
10593
|
### BMAction
|
|
10383
10594
|
|
|
@@ -10410,7 +10621,7 @@ Contains detailed information about Browser monitor action.
|
|
|
10410
10621
|
|largestContentfulPaint|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The largest contentful paint (LCP) is the time (in milliseconds) that the largest element on the page took to render. |
|
|
10411
10622
|
|loadEventEnd|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of time until the load event ended, in milliseconds. |
|
|
10412
10623
|
|loadEventStart|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of time until the load event started, in milliseconds. |
|
|
10413
|
-
|monitorType<sup>*required</sup>|ExecutionStepMonitorType
|
|
10624
|
+
|monitorType<sup>*required</sup>|ExecutionStepMonitorType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BROWSER</code> -> BMAction</li> <li><code>HTTP</code> -> MonitorRequestExecutionResult</li> </ul> |
|
|
10414
10625
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the action. |
|
|
10415
10626
|
|navigationStartTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the navigation start, in UTC milliseconds. |
|
|
10416
10627
|
|networkTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of time spent on the data transfer for the action, in milliseconds. |
|
|
@@ -10467,7 +10678,7 @@ Parameters of an error budget burn rate alert.
|
|
|
10467
10678
|
| --- | --- | --- |
|
|
10468
10679
|
|alertName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the alert. |
|
|
10469
10680
|
|alertThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value. |
|
|
10470
|
-
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType
|
|
10681
|
+
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BURN_RATE</code> -> BurnRateAlert</li> <li><code>STATUS</code> -> StatusAlert</li> </ul> |
|
|
10471
10682
|
|
|
10472
10683
|
### CertificateCredentials
|
|
10473
10684
|
|
|
@@ -10487,9 +10698,9 @@ A credentials set of the `CERTIFICATE` type.
|
|
|
10487
10698
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10488
10699
|
|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>). |
|
|
10489
10700
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (Base64 encoded). |
|
|
10490
|
-
|scope|CredentialsScope| |
|
|
10701
|
+
|scope|CredentialsScope|The scope of the credentials set. |
|
|
10491
10702
|
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10492
|
-
|type|CredentialsType
|
|
10703
|
+
|type|CredentialsType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> </ul> |
|
|
10493
10704
|
|
|
10494
10705
|
### CloudEvent
|
|
10495
10706
|
|
|
@@ -10525,10 +10736,10 @@ The details of a code-level vulnerability.
|
|
|
10525
10736
|
|processGroupIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of encoded MEIdentifier of the process groups. |
|
|
10526
10737
|
|processGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of affected process groups. |
|
|
10527
10738
|
|shortVulnerabilityLocation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The code location of the vulnerability without package and parameter. |
|
|
10528
|
-
|type|CodeLevelVulnerabilityDetailsType| |
|
|
10739
|
+
|type|CodeLevelVulnerabilityDetailsType|The type of code level vulnerability. |
|
|
10529
10740
|
|vulnerabilityLocation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The code location of the vulnerability. |
|
|
10530
10741
|
|vulnerableFunction|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The vulnerable function of the vulnerability. |
|
|
10531
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>| |
|
|
10742
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability. |
|
|
10532
10743
|
|
|
10533
10744
|
### CodeLocation
|
|
10534
10745
|
|
|
@@ -10545,7 +10756,7 @@ Information about a code location.
|
|
|
10545
10756
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the code location. |
|
|
10546
10757
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the code location. |
|
|
10547
10758
|
|lineNumber|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The line number of the code location. |
|
|
10548
|
-
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>| |
|
|
10759
|
+
|parameterTypes|<a href="#truncatableliststring">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
10549
10760
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function. |
|
|
10550
10761
|
|
|
10551
10762
|
### Comment
|
|
@@ -10605,7 +10816,7 @@ A constraint on the values accepted for a complex settings property.
|
|
|
10605
10816
|
|minimumPropertyCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of properties that must be set. |
|
|
10606
10817
|
|properties|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of properties (defined by IDs) that are used to check the constraint. |
|
|
10607
10818
|
|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |
|
|
10608
|
-
|type<sup>*required</sup>|ComplexConstraintType| |
|
|
10819
|
+
|type<sup>*required</sup>|ComplexConstraintType|The type of the constraint. |
|
|
10609
10820
|
|
|
10610
10821
|
### ConfigurationMetadata
|
|
10611
10822
|
|
|
@@ -10637,7 +10848,7 @@ A constraint on the values accepted for a settings property.
|
|
|
10637
10848
|
|minimum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum allowed value. |
|
|
10638
10849
|
|pattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The regular expression pattern for valid string values. |
|
|
10639
10850
|
|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |
|
|
10640
|
-
|type<sup>*required</sup>|ConstraintType| |
|
|
10851
|
+
|type<sup>*required</sup>|ConstraintType|The type of the constraint. |
|
|
10641
10852
|
|uniqueProperties|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of properties for which the combination of values must be unique. |
|
|
10642
10853
|
|
|
10643
10854
|
### ConstraintViolation
|
|
@@ -10695,9 +10906,9 @@ The actual set of fields depends on the type of credentials. Find the list of ac
|
|
|
10695
10906
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
10696
10907
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10697
10908
|
|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>). |
|
|
10698
|
-
|scope|CredentialsScope| |
|
|
10909
|
+
|scope|CredentialsScope|The scope of the credentials set. |
|
|
10699
10910
|
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
10700
|
-
|type|CredentialsType
|
|
10911
|
+
|type|CredentialsType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> </ul> |
|
|
10701
10912
|
|
|
10702
10913
|
### CredentialsDetailsCertificateResponseElement
|
|
10703
10914
|
|
|
@@ -10712,14 +10923,14 @@ Details of certificate credentials set.
|
|
|
10712
10923
|
|certificateType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Certificate type: PEM, PKCS12 or UNKNOWN |
|
|
10713
10924
|
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler" target="_blank" rel="noopener noreferrer">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
10714
10925
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
10715
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>| |
|
|
10926
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
10716
10927
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
10717
10928
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10718
10929
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
10719
10930
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
10720
10931
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Base64 encoded password |
|
|
10721
|
-
|scope|AbstractCredentialsResponseElementScope| |
|
|
10722
|
-
|type<sup>*required</sup>|AbstractCredentialsResponseElementType
|
|
10932
|
+
|scope|AbstractCredentialsResponseElementScope|The scope of the credentials set. |
|
|
10933
|
+
|type<sup>*required</sup>|AbstractCredentialsResponseElementType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
10723
10934
|
|
|
10724
10935
|
### CredentialsDetailsTokenResponseElement
|
|
10725
10936
|
|
|
@@ -10732,14 +10943,14 @@ Details of the token credentials set.
|
|
|
10732
10943
|
| --- | --- | --- |
|
|
10733
10944
|
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler" target="_blank" rel="noopener noreferrer">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
10734
10945
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
10735
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>| |
|
|
10946
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
10736
10947
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
10737
10948
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10738
10949
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
10739
10950
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
10740
|
-
|scope|AbstractCredentialsResponseElementScope| |
|
|
10951
|
+
|scope|AbstractCredentialsResponseElementScope|The scope of the credentials set. |
|
|
10741
10952
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text token value |
|
|
10742
|
-
|type<sup>*required</sup>|AbstractCredentialsResponseElementType
|
|
10953
|
+
|type<sup>*required</sup>|AbstractCredentialsResponseElementType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
10743
10954
|
|
|
10744
10955
|
### CredentialsDetailsUsernamePasswordResponseElement
|
|
10745
10956
|
|
|
@@ -10752,14 +10963,14 @@ Details of username and password credentials set.
|
|
|
10752
10963
|
| --- | --- | --- |
|
|
10753
10964
|
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler" target="_blank" rel="noopener noreferrer">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
10754
10965
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
10755
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>| |
|
|
10966
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
10756
10967
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
10757
10968
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10758
10969
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
10759
10970
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
10760
10971
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text password value |
|
|
10761
|
-
|scope|AbstractCredentialsResponseElementScope| |
|
|
10762
|
-
|type<sup>*required</sup>|AbstractCredentialsResponseElementType
|
|
10972
|
+
|scope|AbstractCredentialsResponseElementScope|The scope of the credentials set. |
|
|
10973
|
+
|type<sup>*required</sup>|AbstractCredentialsResponseElementType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>USERNAME_PASSWORD</code> -> CredentialsDetailsUsernamePasswordResponseElement</li> <li><code>CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> <li><code>TOKEN</code> -> CredentialsDetailsTokenResponseElement</li> <li><code>PUBLIC_CERTIFICATE</code> -> CredentialsDetailsCertificateResponseElement</li> </ul> |
|
|
10763
10974
|
|username|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Plain text username value |
|
|
10764
10975
|
|
|
10765
10976
|
### CredentialsId
|
|
@@ -10800,14 +11011,14 @@ Metadata of the credentials set.
|
|
|
10800
11011
|
|allowedEntities<sup>*required</sup>|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
10801
11012
|
|credentialUsageSummary<sup>*required</sup>|Array<<a href="#credentialusagehandler" target="_blank" rel="noopener noreferrer">CredentialUsageHandler</a>>|The list contains summary data related to the use of credentials. |
|
|
10802
11013
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
10803
|
-
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>| |
|
|
11014
|
+
|externalVault|<a href="#externalvaultconfig">ExternalVaultConfig</a>|Configuration for external vault synchronization for username and password credentials. |
|
|
10804
11015
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
10805
11016
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
10806
11017
|
|owner<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the credential (user for which used API token was created). |
|
|
10807
11018
|
|ownerAccessOnly<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag indicating that this credential is visible only to the owner. |
|
|
10808
|
-
|scope|CredentialsResponseElementScope| |
|
|
11019
|
+
|scope|CredentialsResponseElementScope|The scope of the credentials set. |
|
|
10809
11020
|
|scopes|Array<CredentialsResponseElementScopesItem>|The set of scopes of the credentials set. |
|
|
10810
|
-
|type<sup>*required</sup>|CredentialsResponseElementType| |
|
|
11021
|
+
|type<sup>*required</sup>|CredentialsResponseElementType|The type of the credentials set. |
|
|
10811
11022
|
|
|
10812
11023
|
### CustomApplicationImpact
|
|
10813
11024
|
|
|
@@ -10819,8 +11030,8 @@ Analysis of problem impact to a custom application.
|
|
|
10819
11030
|
| Name | Type | Description |
|
|
10820
11031
|
| --- | --- | --- |
|
|
10821
11032
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
10822
|
-
|impactType<sup>*required</sup>|ImpactImpactType
|
|
10823
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
11033
|
+
|impactType<sup>*required</sup>|ImpactImpactType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
11034
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
10824
11035
|
|
|
10825
11036
|
### CustomDeviceCreation
|
|
10826
11037
|
|
|
@@ -10839,7 +11050,7 @@ Configuration of a custom device.
|
|
|
10839
11050
|
|group|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>User defined group ID of entity.</p> <p>The group ID helps to keep a consistent picture of device-group relations. One of many cases where a proper group is important is service detection: you can define which custom devices should lead to the same service by defining the same group ID for them.</p> <p>If you set a group ID, it will be hashed into the Dynatrace entity ID of the custom device. In that case the custom device can only be part of one custom device group.</p> <p>If you don't set the group ID, Dynatrace will create it based on the ID or type of the custom device. Also, the group will not be hashed into the device ID which means the device may switch groups.</p> |
|
|
10840
11051
|
|ipAddresses|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The list of IP addresses that belong to the custom device.</p> <p>These addresses are used to automatically discover the horizontal communication relationship between this component and all other observed components within Smartscape. Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If you send a value (including an empty value), the existing values will be overwritten.</p> <p>If you send <code>null</code> or omit this field, the existing values will be kept.</p> |
|
|
10841
11052
|
|listenPorts|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>The list of ports the custom devices listens to.</p> <p>These ports are used to discover the horizontal communication relationship between this component and all other observed components within Smartscape.</p> <p>Once a connection is discovered, it is automatically mapped and shown within Smartscape.</p> <p>If ports are specified, you should also add at least one IP address or a DNS name for the custom device.</p> <p>If you send a value, the existing values will be overwritten.</p> <p>If you send <code>null</code>, or an empty value, or omit this field, the existing values will be kept.</p> |
|
|
10842
|
-
|properties|<a href="#customdevicecreationproperties">CustomDeviceCreationProperties</a>| |
|
|
11053
|
+
|properties|<a href="#customdevicecreationproperties">CustomDeviceCreationProperties</a>|The list of key-value pair properties that will be shown beneath the infographics of your custom device. |
|
|
10843
11054
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The technology type definition of the custom device.</p> <p>It must be the same technology type of the metric you're reporting.</p> <p>If you send a value, the existing value will be overwritten.</p> <p>If you send <code>null</code>, empty or omit this field, the existing value will be kept.</p> |
|
|
10844
11055
|
|
|
10845
11056
|
### CustomDeviceCreationProperties
|
|
@@ -10893,20 +11104,20 @@ A custom script log line
|
|
|
10893
11104
|
|
|
10894
11105
|
Configuration for external vault synchronization for username and password credentials.
|
|
10895
11106
|
|
|
10896
|
-
| Name | Type |
|
|
10897
|
-
| --- | --- |
|
|
10898
|
-
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10899
|
-
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10900
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10901
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
10902
|
-
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10903
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10904
|
-
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10905
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
10906
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10907
|
-
|type|ExternalVaultConfigType|
|
|
10908
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10909
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11107
|
+
| Name | Type | Description |
|
|
11108
|
+
| --- | --- | --- |
|
|
11109
|
+
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11110
|
+
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11111
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11112
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
11113
|
+
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11114
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11115
|
+
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11116
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
11117
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11118
|
+
|type|ExternalVaultConfigType| |
|
|
11119
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11120
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10910
11121
|
|
|
10911
11122
|
### CyberArkAllowedLocationDto
|
|
10912
11123
|
|
|
@@ -10919,12 +11130,12 @@ Synchronization credentials with CyberArk Vault using allowed machines (location
|
|
|
10919
11130
|
| --- | --- | --- |
|
|
10920
11131
|
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
10921
11132
|
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
10922
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[
|
|
11133
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
10923
11134
|
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
10924
11135
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
10925
11136
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
10926
11137
|
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
10927
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
11138
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
10928
11139
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
10929
11140
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
10930
11141
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External vault URL. |
|
|
@@ -10940,12 +11151,12 @@ Synchronization credentials with CyberArk Vault using username password authenti
|
|
|
10940
11151
|
| --- | --- | --- |
|
|
10941
11152
|
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Account name that stores the username and password to retrieve and synchronize with the Dynatrace Credential Vault: This is NOT the name of the account logged into the CyberArk Central Credential Provider. |
|
|
10942
11153
|
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Application ID connected to CyberArk Vault. |
|
|
10943
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[
|
|
11154
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[Recommended] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV. |
|
|
10944
11155
|
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|[Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'. |
|
|
10945
11156
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
10946
11157
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
10947
11158
|
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Safe name connected to CyberArk Vault. |
|
|
10948
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
11159
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
10949
11160
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
10950
11161
|
|usernamePasswordForCPM|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Dynatrace credential ID of the username-password pair used for authentication to the CyberArk Central Credential Provider |
|
|
10951
11162
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
@@ -10958,21 +11169,21 @@ Synchronization credentials with CyberArk Vault using username password authenti
|
|
|
10958
11169
|
|
|
10959
11170
|
Configuration for external vault synchronization for username and password credentials.
|
|
10960
11171
|
|
|
10961
|
-
| Name | Type |
|
|
10962
|
-
| --- | --- |
|
|
10963
|
-
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10964
|
-
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10965
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10966
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
10967
|
-
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10968
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10969
|
-
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10970
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
10971
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10972
|
-
|type|ExternalVaultConfigType|
|
|
10973
|
-
|usernamePasswordForCPM|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10974
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
10975
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11172
|
+
| Name | Type | Description |
|
|
11173
|
+
| --- | --- | --- |
|
|
11174
|
+
|accountName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11175
|
+
|applicationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11176
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11177
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
11178
|
+
|folderName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11179
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11180
|
+
|safeName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11181
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
11182
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11183
|
+
|type|ExternalVaultConfigType| |
|
|
11184
|
+
|usernamePasswordForCPM|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11185
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11186
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
10976
11187
|
|
|
10977
11188
|
### DatasourceDefinition
|
|
10978
11189
|
|
|
@@ -10986,7 +11197,7 @@ Configuration of a datasource for a property.
|
|
|
10986
11197
|
|filterProperties<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The properties to filter the datasource options on. |
|
|
10987
11198
|
|fullContext<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this datasource expects full setting payload as the context. |
|
|
10988
11199
|
|identifier<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of a custom data source of the property's value. |
|
|
10989
|
-
|resetValue|DatasourceDefinitionResetValue| |
|
|
11200
|
+
|resetValue|DatasourceDefinitionResetValue|When to reset datasource value in the UI on filter change. |
|
|
10990
11201
|
|useApiSearch<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the datasource should use the api to filter the results instead of client-side filtering. |
|
|
10991
11202
|
|validate<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to validate input to only allow values returned by the datasource. |
|
|
10992
11203
|
|
|
@@ -10999,14 +11210,14 @@ Security advice from the Davis security advisor.
|
|
|
10999
11210
|
|
|
11000
11211
|
| Name | Type | Description |
|
|
11001
11212
|
| --- | --- | --- |
|
|
11002
|
-
|adviceType|Upgrade| |
|
|
11213
|
+
|adviceType|Upgrade|The type of the advice. |
|
|
11003
11214
|
|critical|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|IDs of <code>critical</code> level <a href="https://dt-url.net/p103u1h" target="_blank" rel="noopener noreferrer" >security problems</a> caused by vulnerable component. |
|
|
11004
11215
|
|high|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|IDs of <code>high</code> level <a href="https://dt-url.net/p103u1h" target="_blank" rel="noopener noreferrer" >security problems</a> caused by vulnerable component. |
|
|
11005
11216
|
|low|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|IDs of <code>low</code> level <a href="https://dt-url.net/p103u1h" target="_blank" rel="noopener noreferrer" >security problems</a> caused by vulnerable component. |
|
|
11006
11217
|
|medium|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|IDs of <code>medium</code> level <a href="https://dt-url.net/p103u1h" target="_blank" rel="noopener noreferrer" >security problems</a> caused by vulnerable component. |
|
|
11007
11218
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the advice. |
|
|
11008
11219
|
|none|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|IDs of <code>none</code> level <a href="https://dt-url.net/p103u1h" target="_blank" rel="noopener noreferrer" >security problems</a> caused by vulnerable component. |
|
|
11009
|
-
|technology|DavisSecurityAdviceTechnology| |
|
|
11220
|
+
|technology|DavisSecurityAdviceTechnology|The technology of the vulnerable component. |
|
|
11010
11221
|
|vulnerableComponent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The vulnerable component to which advice applies. |
|
|
11011
11222
|
|
|
11012
11223
|
### DavisSecurityAdviceList
|
|
@@ -11118,13 +11329,13 @@ The properties of a monitored entity.
|
|
|
11118
11329
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the entity, displayed in the UI. |
|
|
11119
11330
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the entity. |
|
|
11120
11331
|
|firstSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was first seen, in UTC milliseconds. |
|
|
11121
|
-
|fromRelationships|<a href="#entityfromrelationships" target="_blank" rel="noopener noreferrer">EntityFromRelationships</a>| |
|
|
11122
|
-
|icon|<a href="#entityicon">EntityIcon</a>| |
|
|
11332
|
+
|fromRelationships|<a href="#entityfromrelationships" target="_blank" rel="noopener noreferrer">EntityFromRelationships</a>|A list of relationships where the entity occupies the FROM position. |
|
|
11333
|
+
|icon|<a href="#entityicon">EntityIcon</a>|The icon of a monitored entity. |
|
|
11123
11334
|
|lastSeenTms|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp at which the entity was last seen, in UTC milliseconds. |
|
|
11124
11335
|
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A set of management zones to which the entity belongs. |
|
|
11125
|
-
|properties|<a href="#entityproperties">EntityProperties</a>| |
|
|
11336
|
+
|properties|<a href="#entityproperties">EntityProperties</a>|A list of additional properties of the entity. |
|
|
11126
11337
|
|tags|Array<<a href="#metag" target="_blank" rel="noopener noreferrer">METag</a>>|A set of tags assigned to the entity. |
|
|
11127
|
-
|toRelationships|<a href="#entitytorelationships">EntityToRelationships</a>| |
|
|
11338
|
+
|toRelationships|<a href="#entitytorelationships">EntityToRelationships</a>|A list of relationships where the entity occupies the TO position. |
|
|
11128
11339
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the entity. |
|
|
11129
11340
|
|
|
11130
11341
|
### EntityFromRelationships
|
|
@@ -11188,7 +11399,7 @@ A short representation of a monitored entity.
|
|
|
11188
11399
|
|
|
11189
11400
|
| Name | Type | Description |
|
|
11190
11401
|
| --- | --- | --- |
|
|
11191
|
-
|entityId|<a href="#entityid" target="_blank" rel="noopener noreferrer">EntityId</a>| |
|
|
11402
|
+
|entityId|<a href="#entityid" target="_blank" rel="noopener noreferrer">EntityId</a>|A short representation of a monitored entity. |
|
|
11192
11403
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The name of the entity.</p> <p>Not included in the response in case no entity with the relevant ID was found.</p> |
|
|
11193
11404
|
|
|
11194
11405
|
### EntityToRelationships
|
|
@@ -11265,10 +11476,10 @@ Describes one segment that was passed into a usage and the associated source nam
|
|
|
11265
11476
|
|
|
11266
11477
|
| Name | Type | Description |
|
|
11267
11478
|
| --- | --- | --- |
|
|
11268
|
-
|segmentType|EntryPointUsageSegmentSegmentType| |
|
|
11479
|
+
|segmentType|EntryPointUsageSegmentSegmentType|The type of this input segment. |
|
|
11269
11480
|
|segmentValue|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of this input segment. |
|
|
11270
11481
|
|sourceArgumentName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name used in the source for this segment. |
|
|
11271
|
-
|sourceType|EntryPointUsageSegmentSourceType| |
|
|
11482
|
+
|sourceType|EntryPointUsageSegmentSourceType|The type of the HTTP request part that contains the value that was used in this segment. |
|
|
11272
11483
|
|
|
11273
11484
|
### EntryPoints
|
|
11274
11485
|
|
|
@@ -11292,7 +11503,7 @@ Describes a payload sent to an entrypoint during an attack.
|
|
|
11292
11503
|
| Name | Type | Description |
|
|
11293
11504
|
| --- | --- | --- |
|
|
11294
11505
|
|name|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the payload, if applicable. |
|
|
11295
|
-
|type|EntrypointPayloadType| |
|
|
11506
|
+
|type|EntrypointPayloadType|Type of the payload. |
|
|
11296
11507
|
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Value of the payload. |
|
|
11297
11508
|
|
|
11298
11509
|
### EnumType
|
|
@@ -11309,7 +11520,7 @@ Definition of an enum property.
|
|
|
11309
11520
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
11310
11521
|
|enumClass|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An existing Java enum class that holds the allowed values of the enum. |
|
|
11311
11522
|
|items<sup>*required</sup>|Array<<a href="#enumvalue">EnumValue</a>>|A list of allowed values of the enum. |
|
|
11312
|
-
|type<sup>*required</sup>|Enum| |
|
|
11523
|
+
|type<sup>*required</sup>|Enum|The type of the property. |
|
|
11313
11524
|
|
|
11314
11525
|
### EnumValue
|
|
11315
11526
|
|
|
@@ -11361,7 +11572,7 @@ Configuration of an event.
|
|
|
11361
11572
|
| --- | --- | --- |
|
|
11362
11573
|
|correlationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The correlation ID of the event. |
|
|
11363
11574
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp when the event was closed, in UTC milliseconds.</p> <p>Has the value of <code>null</code> if the event is still active.</p> |
|
|
11364
|
-
|entityId|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
11575
|
+
|entityId|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
11365
11576
|
|entityTags|Array<<a href="#metag">METag</a>>|A list of tags of the related entity. |
|
|
11366
11577
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
11367
11578
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
@@ -11369,7 +11580,7 @@ Configuration of an event.
|
|
|
11369
11580
|
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of all management zones that the event belongs to. |
|
|
11370
11581
|
|properties|Array<<a href="#eventproperty">EventProperty</a>>|A list of event properties. |
|
|
11371
11582
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event was raised, in UTC milliseconds. |
|
|
11372
|
-
|status|EventStatus| |
|
|
11583
|
+
|status|EventStatus|The status of the event. |
|
|
11373
11584
|
|suppressAlert|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The alerting status during a <a href="https://dt-url.net/b2123rg0" target="_blank" rel="noopener noreferrer" >maintenance</a>:</p> <ul> <li><code>false</code>: Alerting works as usual.</li> <li><code>true</code>: Alerting is disabled.</li> </ul> |
|
|
11374
11585
|
|suppressProblem|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The problem detection status during a <a href="https://dt-url.net/b2123rg0" target="_blank" rel="noopener noreferrer" >maintenance</a>:</p> <ul> <li><code>false</code>: Problem detection works as usual.</li> <li><code>true</code>: Problem detection is disabled.</li> </ul> |
|
|
11375
11586
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the event. |
|
|
@@ -11386,14 +11597,14 @@ An event that occurred during the problem lifespan that might be related to the
|
|
|
11386
11597
|
|
|
11387
11598
|
| Name | Type | Description |
|
|
11388
11599
|
| --- | --- | --- |
|
|
11389
|
-
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>| |
|
|
11600
|
+
|data|<a href="#event" target="_blank" rel="noopener noreferrer">Event</a>|Configuration of an event. |
|
|
11390
11601
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
11391
11602
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end timestamp of the event, in UTC milliseconds.</p> <p>Has <code>-1</code> value, if the event is still active.</p> |
|
|
11392
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
11603
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
11393
11604
|
|eventId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the event. |
|
|
11394
11605
|
|eventType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the event. |
|
|
11395
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
11396
|
-
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
11606
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
11607
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
11397
11608
|
|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. |
|
|
11398
11609
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
11399
11610
|
|
|
@@ -11408,8 +11619,8 @@ The configuration of an event to be ingested.
|
|
|
11408
11619
|
| --- | --- | --- |
|
|
11409
11620
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end time of the event, in UTC milliseconds.</p> <p>If not set, the start time plus timeout is used.</p> |
|
|
11410
11621
|
|entitySelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The <a href="https://dt-url.net/apientityselector" target="_blank" rel="noopener noreferrer" >entity selector</a>, defining a set of Dynatrace entities to be associated with the event.</p> <p>Only entities that have been active within the last 24 hours can be selected.</p> <p>If not set, the event is associated with the environment (<code>dt.entity.environment</code>) entity.</p> |
|
|
11411
|
-
|eventType<sup>*required</sup>|EventIngestEventType| |
|
|
11412
|
-
|properties|<a href="#eventingestproperties">EventIngestProperties</a
|
|
11622
|
+
|eventType<sup>*required</sup>|EventIngestEventType|The type of the event. |
|
|
11623
|
+
|properties|<a href="#eventingestproperties">EventIngestProperties</a>|<p>A map of event properties.</p> <p>Keys with prefix <code>dt.\*</code> are generally disallowed, with the exceptions of <code>dt.event.\*</code>, <code>dt.davis.\*</code> and <code>dt.entity.\*</code>. These reserved keys may be used to set event properties with predefined semantics within the Dynatrace product. <code>dt.entity.\*</code> keys may be used to provide additional information on an event, but will not lead to the event being tied to the specified entities. All other keys are interpreted as user-defined event properties.</p> <p>Values of Dynatrace-reserved properties must fulfill the requirements of the respective property.</p> <p>A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.</p> |
|
|
11413
11624
|
|startTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The start time of the event, in UTC milliseconds.</p> <p>If not set, the current timestamp is used.</p> <p>Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events.</p> <p>Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events.</p> |
|
|
11414
11625
|
|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timeout of the event, in minutes.</p> <p>If not set, 15 is used.</p> <p>The timeout will automatically be capped to a maximum of 360 minutes (6 hours).</p> <p>Problem-opening events can be refreshed and therefore kept open by sending the same payload again.</p> |
|
|
11415
11626
|
|title<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the event. |
|
|
@@ -11439,7 +11650,7 @@ The result of a created event report.
|
|
|
11439
11650
|
| Name | Type | Description |
|
|
11440
11651
|
| --- | --- | --- |
|
|
11441
11652
|
|correlationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The correlation ID of the created event. |
|
|
11442
|
-
|status|EventIngestResultStatus| |
|
|
11653
|
+
|status|EventIngestResultStatus|The status of the ingestion. |
|
|
11443
11654
|
|
|
11444
11655
|
### EventIngestResults
|
|
11445
11656
|
|
|
@@ -11520,7 +11731,7 @@ Configuration of an event type.
|
|
|
11520
11731
|
| --- | --- | --- |
|
|
11521
11732
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the event type. |
|
|
11522
11733
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the event type. |
|
|
11523
|
-
|severityLevel|EventTypeSeverityLevel| |
|
|
11734
|
+
|severityLevel|EventTypeSeverityLevel|The severity level associated with the event type. |
|
|
11524
11735
|
|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The event type. |
|
|
11525
11736
|
|
|
11526
11737
|
### EventTypeList
|
|
@@ -11549,9 +11760,9 @@ An evidence of a root cause.
|
|
|
11549
11760
|
| Name | Type | Description |
|
|
11550
11761
|
| --- | --- | --- |
|
|
11551
11762
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
11552
|
-
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
11553
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
11554
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>| |
|
|
11763
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
11764
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
11765
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
11555
11766
|
|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. |
|
|
11556
11767
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
11557
11768
|
|
|
@@ -11574,9 +11785,9 @@ The evidence details of a problem.
|
|
|
11574
11785
|
|
|
11575
11786
|
|
|
11576
11787
|
|
|
11577
|
-
| Name | Type |
|
|
11578
|
-
| --- | --- |
|
|
11579
|
-
|actions|<a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a>|
|
|
11788
|
+
| Name | Type | Description |
|
|
11789
|
+
| --- | --- | --- |
|
|
11790
|
+
|actions|<a href="#executeactionsdtoactions">ExecuteActionsDtoActions</a>|Data Source defined action objects |
|
|
11580
11791
|
|
|
11581
11792
|
### ExecuteActionsDtoActions
|
|
11582
11793
|
**type**: Record<string, JsonNode | undefined>
|
|
@@ -11651,9 +11862,9 @@ Contains basic results of the monitor's on-demand execution.
|
|
|
11651
11862
|
|
|
11652
11863
|
Contains detailed information about the monitor's step execution.
|
|
11653
11864
|
|
|
11654
|
-
| Name | Type |
|
|
11655
|
-
| --- | --- |
|
|
11656
|
-
|monitorType<sup>*required</sup>|ExecutionStepMonitorType|
|
|
11865
|
+
| Name | Type | Description |
|
|
11866
|
+
| --- | --- | --- |
|
|
11867
|
+
|monitorType<sup>*required</sup>|ExecutionStepMonitorType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BROWSER</code> -> BMAction</li> <li><code>HTTP</code> -> MonitorRequestExecutionResult</li> </ul> |
|
|
11657
11868
|
|
|
11658
11869
|
### ExportedLogRecordList
|
|
11659
11870
|
|
|
@@ -11679,11 +11890,11 @@ A list of exported log records.
|
|
|
11679
11890
|
|
|
11680
11891
|
| Name | Type | Description |
|
|
11681
11892
|
| --- | --- | --- |
|
|
11682
|
-
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>| |
|
|
11893
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author |
|
|
11683
11894
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
11684
11895
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
11685
11896
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
11686
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails">ExtensionFeatureSetsDetails</a>| |
|
|
11897
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionfeaturesetsdetails">ExtensionFeatureSetsDetails</a>|Details of feature sets |
|
|
11687
11898
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
11688
11899
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
11689
11900
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -11729,7 +11940,7 @@ A list of extension events.
|
|
|
11729
11940
|
|dt.entity.host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Host that uses this monitoring configuration.</p> <p>Example: <code>HOST-ABCDEF0123456789</code></p> |
|
|
11730
11941
|
|dt.extension.ds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Data source that uses this monitoring configuration.</p> <p>Example: <code>snmp</code></p> |
|
|
11731
11942
|
|severity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Severity of the event |
|
|
11732
|
-
|status|ExtensionEventDtoStatus| |
|
|
11943
|
+
|status|ExtensionEventDtoStatus|Status of the event |
|
|
11733
11944
|
|timestamp|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Timestamp of the event |
|
|
11734
11945
|
|
|
11735
11946
|
### ExtensionEventsList
|
|
@@ -11803,7 +12014,7 @@ A list of extensions with additional metadata.
|
|
|
11803
12014
|
| --- | --- | --- |
|
|
11804
12015
|
|objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Configuration id |
|
|
11805
12016
|
|scope<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Configuration scope |
|
|
11806
|
-
|value<sup>*required</sup>|ExtensionMonitoringConfigurationValue| |
|
|
12017
|
+
|value<sup>*required</sup>|ExtensionMonitoringConfigurationValue|Configuration |
|
|
11807
12018
|
|
|
11808
12019
|
### ExtensionMonitoringConfigurationsList
|
|
11809
12020
|
|
|
@@ -11828,7 +12039,7 @@ A list of extensions with additional metadata.
|
|
|
11828
12039
|
|
|
11829
12040
|
| Name | Type | Description |
|
|
11830
12041
|
| --- | --- | --- |
|
|
11831
|
-
|status<sup>*required</sup>|ExtensionStatusDtoStatus| |
|
|
12042
|
+
|status<sup>*required</sup>|ExtensionStatusDtoStatus|Latest status of given configuration. |
|
|
11832
12043
|
|timestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Timestamp of the latest status of given configuration. |
|
|
11833
12044
|
|
|
11834
12045
|
### ExtensionUploadResponseDto
|
|
@@ -11841,11 +12052,11 @@ A list of extensions with additional metadata.
|
|
|
11841
12052
|
| Name | Type | Description |
|
|
11842
12053
|
| --- | --- | --- |
|
|
11843
12054
|
|assetsInfo<sup>*required</sup>|Array<<a href="#assetinfo">AssetInfo</a>>|Information about extension assets included |
|
|
11844
|
-
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>| |
|
|
12055
|
+
|author<sup>*required</sup>|<a href="#authordto" target="_blank" rel="noopener noreferrer">AuthorDto</a>|Extension author |
|
|
11845
12056
|
|dataSources<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Data sources that extension uses to gather data |
|
|
11846
12057
|
|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |
|
|
11847
12058
|
|featureSets<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Available feature sets |
|
|
11848
|
-
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails">ExtensionUploadResponseDtoFeatureSetsDetails</a>| |
|
|
12059
|
+
|featureSetsDetails<sup>*required</sup>|<a href="#extensionuploadresponsedtofeaturesetsdetails">ExtensionUploadResponseDtoFeatureSetsDetails</a>|Details of feature sets |
|
|
11849
12060
|
|fileHash<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|SHA-256 hash of uploaded Extension file |
|
|
11850
12061
|
|minDynatraceVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Dynatrace version that works with the extension |
|
|
11851
12062
|
|minEECVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Minimal Extension Execution Controller version that works with the extension |
|
|
@@ -11870,7 +12081,7 @@ Information for synchronization credentials with external vault
|
|
|
11870
12081
|
| --- | --- | --- |
|
|
11871
12082
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
11872
12083
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
11873
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
12084
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
11874
12085
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
11875
12086
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
11876
12087
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External vault URL. |
|
|
@@ -11882,15 +12093,15 @@ Information for synchronization credentials with external vault
|
|
|
11882
12093
|
|
|
11883
12094
|
Configuration for external vault synchronization for username and password credentials.
|
|
11884
12095
|
|
|
11885
|
-
| Name | Type |
|
|
11886
|
-
| --- | --- |
|
|
11887
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
11888
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11889
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
11890
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11891
|
-
|type|ExternalVaultConfigType|
|
|
11892
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
11893
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12096
|
+
| Name | Type | Description |
|
|
12097
|
+
| --- | --- | --- |
|
|
12098
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
12099
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12100
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
12101
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12102
|
+
|type|ExternalVaultConfigType| |
|
|
12103
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12104
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
11894
12105
|
|
|
11895
12106
|
### FeatureSetDetails
|
|
11896
12107
|
|
|
@@ -11913,13 +12124,13 @@ A dimensional or series filter on a metric.
|
|
|
11913
12124
|
| Name | Type | Description |
|
|
11914
12125
|
| --- | --- | --- |
|
|
11915
12126
|
|operands|Array<<a href="#filter">Filter</a>>|If the type is <code>not</code>, <code>and</code> or <code>or</code>, then holds the contained filters. |
|
|
11916
|
-
|referenceInvocation|<a href="#invocation" target="_blank" rel="noopener noreferrer">Invocation</a>| |
|
|
12127
|
+
|referenceInvocation|<a href="#invocation" target="_blank" rel="noopener noreferrer">Invocation</a>|Invocation of a function, e.g. the <code>entitySelector</code> function. |
|
|
11917
12128
|
|referenceString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|For filters that match a dimension against a valkue, such as <code>eq</code> or <code>ne</code>, holds the value to compare the dimension against. |
|
|
11918
12129
|
|referenceValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|For the operands of <code>series</code> filters that match against a number, holds the number to compare against. |
|
|
11919
|
-
|rollup|<a href="#rollup">Rollup</a>| |
|
|
12130
|
+
|rollup|<a href="#rollup">Rollup</a>|A way of viewing a series as a single value for the purpose of sorting or series-based filters. |
|
|
11920
12131
|
|targetDimension|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|If the type applies to a dimension, then holds the target dimension. |
|
|
11921
12132
|
|targetDimensions|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|If the type applies to n dimensions, then holds the target dimensions. Currently only used for the <code>remainder</code> filter. |
|
|
11922
|
-
|type|FilterType
|
|
12133
|
+
|type|FilterType|<p>Type of this filter, determines which other fields are present.Can be any of:</p> <ul> <li><code>eq</code>,</li> <li><code>ne</code>,</li> <li><code>prefix</code>,</li> <li><code>in</code>,</li> <li><code>remainder</code>,</li> <li><code>suffix</code>,</li> <li><code>contains</code>,</li> <li><code>existsKey</code>,</li> <li><code>series</code>,</li> <li><code>or</code>,</li> <li><code>and</code>,</li> <li><code>not</code>,</li> <li><code>ge</code>,</li> <li><code>gt</code>,</li> <li><code>le</code>,</li> <li><code>lt</code>,</li> <li><code>otherwise</code>.</li> </ul> |
|
|
11923
12134
|
|
|
11924
12135
|
### FilteredCountsDto
|
|
11925
12136
|
|
|
@@ -11969,7 +12180,7 @@ Information about a function definition.
|
|
|
11969
12180
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A human readable string representation of the function definition. |
|
|
11970
12181
|
|fileName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The file name of the function definition. |
|
|
11971
12182
|
|functionName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The function/method name of the function definition. |
|
|
11972
|
-
|parameterTypes|<a href="#truncatableliststring" target="_blank" rel="noopener noreferrer">TruncatableListString</a>| |
|
|
12183
|
+
|parameterTypes|<a href="#truncatableliststring" target="_blank" rel="noopener noreferrer">TruncatableListString</a>|A list of values that has possibly been truncated. |
|
|
11973
12184
|
|returnType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The return type of the function. |
|
|
11974
12185
|
|
|
11975
12186
|
### GlobalCountsDto
|
|
@@ -12008,7 +12219,7 @@ Synchronization credentials with HashiCorp Vault using appRole authentication me
|
|
|
12008
12219
|
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Path to folder where credentials in HashiCorp Vault are stored. |
|
|
12009
12220
|
|roleId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Role ID is similar to username when you want to authenticate in HashiCorp Vault using AppRole. |
|
|
12010
12221
|
|secretId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Secret ID is similar to password when you want to authenticate in HashiCorp Vault using AppRole. ID of token representing secret ID saved in Dynatrace CV. |
|
|
12011
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
12222
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
12012
12223
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
12013
12224
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
12014
12225
|
|vaultNamespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Vault namespace in HashiCorp Vault. It is an information you set as environmental variable VAULT_NAMESPACE if you are accessing HashiCorp Vault from command line. |
|
|
@@ -12021,19 +12232,19 @@ Synchronization credentials with HashiCorp Vault using appRole authentication me
|
|
|
12021
12232
|
|
|
12022
12233
|
Configuration for external vault synchronization for username and password credentials.
|
|
12023
12234
|
|
|
12024
|
-
| Name | Type |
|
|
12025
|
-
| --- | --- |
|
|
12026
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
12027
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12028
|
-
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12029
|
-
|roleId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12030
|
-
|secretId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12031
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
12032
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12033
|
-
|type|ExternalVaultConfigType|
|
|
12034
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12035
|
-
|vaultNamespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12036
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12235
|
+
| Name | Type | Description |
|
|
12236
|
+
| --- | --- | --- |
|
|
12237
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
12238
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12239
|
+
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12240
|
+
|roleId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12241
|
+
|secretId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12242
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
12243
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12244
|
+
|type|ExternalVaultConfigType| |
|
|
12245
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12246
|
+
|vaultNamespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12247
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12037
12248
|
|
|
12038
12249
|
### HashicorpCertificate
|
|
12039
12250
|
|
|
@@ -12048,7 +12259,7 @@ Synchronization credentials with HashiCorp Vault using certificate authenticatio
|
|
|
12048
12259
|
|locationForSynchronizationId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of a location used by the synchronizing monitor |
|
|
12049
12260
|
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where password is stored. |
|
|
12050
12261
|
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Path to folder where credentials in HashiCorp Vault are stored. |
|
|
12051
|
-
|sourceAuthMethod|ExternalVaultSourceAuthMethod
|
|
12262
|
+
|sourceAuthMethod|ExternalVaultSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApprole</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificate</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecret</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePassword</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationDto</li> </ul> |
|
|
12052
12263
|
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where token is stored. |
|
|
12053
12264
|
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the secret saved in external vault where username is stored. |
|
|
12054
12265
|
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|External vault URL. |
|
|
@@ -12060,17 +12271,17 @@ Synchronization credentials with HashiCorp Vault using certificate authenticatio
|
|
|
12060
12271
|
|
|
12061
12272
|
Configuration for external vault synchronization for username and password credentials.
|
|
12062
12273
|
|
|
12063
|
-
| Name | Type |
|
|
12064
|
-
| --- | --- |
|
|
12065
|
-
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12066
|
-
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|
|
|
12067
|
-
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12068
|
-
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12069
|
-
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|
|
|
12070
|
-
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12071
|
-
|type|ExternalVaultConfigType|
|
|
12072
|
-
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12073
|
-
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
|
|
12274
|
+
| Name | Type | Description |
|
|
12275
|
+
| --- | --- | --- |
|
|
12276
|
+
|certificate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12277
|
+
|credentialsUsedForExternalSynchronization|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
12278
|
+
|passwordSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12279
|
+
|pathToCredentials|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12280
|
+
|sourceAuthMethod|ExternalVaultConfigSourceAuthMethod|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>HASHICORP_VAULT_APPROLE</code> -> HashicorpApproleConfig</li> <li><code>HASHICORP_VAULT_CERTIFICATE</code> -> HashicorpCertificateConfig</li> <li><code>AZURE_KEY_VAULT_CLIENT_SECRET</code> -> AzureClientSecretConfig</li> <li><code>CYBERARK_VAULT_USERNAME_PASSWORD</code> -> CyberArkUsernamePasswordConfig</li> <li><code>CYBERARK_VAULT_ALLOWED_LOCATION</code> -> CyberArkAllowedLocationConfig</li> </ul> |
|
|
12281
|
+
|tokenSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12282
|
+
|type|ExternalVaultConfigType| |
|
|
12283
|
+
|usernameSecretName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12284
|
+
|vaultUrl|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
12074
12285
|
|
|
12075
12286
|
### HistoryModificationInfo
|
|
12076
12287
|
|
|
@@ -12093,8 +12304,8 @@ HTTP specific request details.
|
|
|
12093
12304
|
|
|
12094
12305
|
| Name | Type | Description |
|
|
12095
12306
|
| --- | --- | --- |
|
|
12096
|
-
|headers|<a href="#truncatablelistattackrequestheader">TruncatableListAttackRequestHeader</a>| |
|
|
12097
|
-
|parameters|<a href="#truncatablelisthttprequestparameter" target="_blank" rel="noopener noreferrer">TruncatableListHttpRequestParameter</a>| |
|
|
12307
|
+
|headers|<a href="#truncatablelistattackrequestheader">TruncatableListAttackRequestHeader</a>|A list of values that has possibly been truncated. |
|
|
12308
|
+
|parameters|<a href="#truncatablelisthttprequestparameter" target="_blank" rel="noopener noreferrer">TruncatableListHttpRequestParameter</a>|A list of values that has possibly been truncated. |
|
|
12098
12309
|
|requestMethod|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The HTTP request method. |
|
|
12099
12310
|
|
|
12100
12311
|
### HttpRequestParameter
|
|
@@ -12109,6 +12320,18 @@ An HTTP request parameter.
|
|
|
12109
12320
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the parameter. |
|
|
12110
12321
|
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the parameter. |
|
|
12111
12322
|
|
|
12323
|
+
### Identity
|
|
12324
|
+
|
|
12325
|
+
|
|
12326
|
+
|
|
12327
|
+
|
|
12328
|
+
An Identity describing either a user, a group, or the all-users group (applying to all users).
|
|
12329
|
+
|
|
12330
|
+
| Name | Type | Description |
|
|
12331
|
+
| --- | --- | --- |
|
|
12332
|
+
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'. |
|
|
12333
|
+
|type<sup>*required</sup>|IdentityType|The type of the identity. |
|
|
12334
|
+
|
|
12112
12335
|
### Impact
|
|
12113
12336
|
|
|
12114
12337
|
|
|
@@ -12121,8 +12344,8 @@ The impact analysis of the problem on other entities/users.
|
|
|
12121
12344
|
| Name | Type | Description |
|
|
12122
12345
|
| --- | --- | --- |
|
|
12123
12346
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
12124
|
-
|impactType<sup>*required</sup>|ImpactImpactType
|
|
12125
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
12347
|
+
|impactType<sup>*required</sup>|ImpactImpactType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
12348
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
12126
12349
|
|
|
12127
12350
|
### ImpactAnalysis
|
|
12128
12351
|
|
|
@@ -12180,15 +12403,15 @@ An item of a collection property.
|
|
|
12180
12403
|
| Name | Type | Description |
|
|
12181
12404
|
| --- | --- | --- |
|
|
12182
12405
|
|constraints|Array<<a href="#constraint">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
12183
|
-
|datasource|<a href="#datasourcedefinition" target="_blank" rel="noopener noreferrer">DatasourceDefinition</a>| |
|
|
12406
|
+
|datasource|<a href="#datasourcedefinition" target="_blank" rel="noopener noreferrer">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
12184
12407
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the item. |
|
|
12185
12408
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the item. |
|
|
12186
12409
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
12187
|
-
|metadata|<a href="#itemmetadata">ItemMetadata</a>| |
|
|
12410
|
+
|metadata|<a href="#itemmetadata">ItemMetadata</a>|Metadata of the items. |
|
|
12188
12411
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the item's value. |
|
|
12189
12412
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the item's value. |
|
|
12190
12413
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer" target="_blank" rel="noopener noreferrer">RefPointer</a>|The type of the item's value. |
|
|
12191
|
-
|uiCustomization|<a href="#uicustomization">UiCustomization</a>| |
|
|
12414
|
+
|uiCustomization|<a href="#uicustomization">UiCustomization</a>|Customization for UI elements |
|
|
12192
12415
|
|
|
12193
12416
|
### ItemMetadata
|
|
12194
12417
|
**type**: Record<string, string | undefined>
|
|
@@ -12219,7 +12442,7 @@ A synthetic location.
|
|
|
12219
12442
|
| Name | Type | Description |
|
|
12220
12443
|
| --- | --- | --- |
|
|
12221
12444
|
|capabilities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of location's capabilities. |
|
|
12222
|
-
|cloudPlatform|LocationCollectionElementCloudPlatform
|
|
12445
|
+
|cloudPlatform|LocationCollectionElementCloudPlatform|<p>The cloud provider where the location is hosted.</p> <p>Only applicable to <code>PUBLIC</code> locations.</p> |
|
|
12223
12446
|
|entityId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the location. |
|
|
12224
12447
|
|geoCity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location's city. |
|
|
12225
12448
|
|geoContinent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Location's continent. |
|
|
@@ -12229,9 +12452,9 @@ A synthetic location.
|
|
|
12229
12452
|
|geoLongitude|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Location's longitude. |
|
|
12230
12453
|
|ips|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The list of IP addresses assigned to the location.</p> <p>Only applicable to <code>PUBLIC</code> locations.</p> |
|
|
12231
12454
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
12232
|
-
|stage|LocationCollectionElementStage| |
|
|
12233
|
-
|status|LocationCollectionElementStatus| |
|
|
12234
|
-
|type<sup>*required</sup>|LocationCollectionElementType| |
|
|
12455
|
+
|stage|LocationCollectionElementStage|The release stage of the location. |
|
|
12456
|
+
|status|LocationCollectionElementStatus|The status of the location. |
|
|
12457
|
+
|type<sup>*required</sup>|LocationCollectionElementType|The type of the location. |
|
|
12235
12458
|
|
|
12236
12459
|
### LocationExecutionResults
|
|
12237
12460
|
|
|
@@ -12255,10 +12478,10 @@ A single log record.
|
|
|
12255
12478
|
|
|
12256
12479
|
| Name | Type | Description |
|
|
12257
12480
|
| --- | --- | --- |
|
|
12258
|
-
|additionalColumns|<a href="#logrecordadditionalcolumns">LogRecordAdditionalColumns</a>| |
|
|
12481
|
+
|additionalColumns|<a href="#logrecordadditionalcolumns">LogRecordAdditionalColumns</a>|Additional columns of the log record. |
|
|
12259
12482
|
|content|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The content of the log record. |
|
|
12260
|
-
|eventType|LogRecordEventType| |
|
|
12261
|
-
|status|LogRecordStatus| |
|
|
12483
|
+
|eventType|LogRecordEventType|Type of event |
|
|
12484
|
+
|status|LogRecordStatus|The log status (based on the log level). |
|
|
12262
12485
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the log record, in UTC milliseconds. |
|
|
12263
12486
|
|
|
12264
12487
|
### LogRecordAdditionalColumns
|
|
@@ -12309,9 +12532,9 @@ The maintenance window during which the problem occurred.
|
|
|
12309
12532
|
| --- | --- | --- |
|
|
12310
12533
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
12311
12534
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds. |
|
|
12312
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
12313
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
12314
|
-
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
12535
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
12536
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
12537
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
12315
12538
|
|maintenanceWindowConfigId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the related maintenance window. |
|
|
12316
12539
|
|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. |
|
|
12317
12540
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
@@ -12364,7 +12587,7 @@ The default aggregation of a metric.
|
|
|
12364
12587
|
| Name | Type | Description |
|
|
12365
12588
|
| --- | --- | --- |
|
|
12366
12589
|
|parameter|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The percentile to be delivered. Valid values are between <code>0</code> and <code>100</code>.</p> <p>Applicable only to the <code>percentile</code> aggregation type.</p> |
|
|
12367
|
-
|type<sup>*required</sup>|MetricDefaultAggregationType| |
|
|
12590
|
+
|type<sup>*required</sup>|MetricDefaultAggregationType|The type of default aggregation. |
|
|
12368
12591
|
|
|
12369
12592
|
### MetricDescriptor
|
|
12370
12593
|
|
|
@@ -12379,7 +12602,7 @@ The descriptor of a metric.
|
|
|
12379
12602
|
|billable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code>the usage of metric is billable.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12380
12603
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp of metric creation.</p> <p>Built-in metrics and metric expressions have the value of <code>null</code>.</p> |
|
|
12381
12604
|
|dduBillable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the usage of metric consumes <a href="https://dt-url.net/ddu" target="_blank" rel="noopener noreferrer" >Davis data units</a>. Deprecated and always <code>false</code> for Dynatrace Platform Subscription. Superseded by <code>isBillable</code>.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12382
|
-
|defaultAggregation|<a href="#metricdefaultaggregation" target="_blank" rel="noopener noreferrer">MetricDefaultAggregation</a>| |
|
|
12605
|
+
|defaultAggregation|<a href="#metricdefaultaggregation" target="_blank" rel="noopener noreferrer">MetricDefaultAggregation</a>|The default aggregation of a metric. |
|
|
12383
12606
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the metric. |
|
|
12384
12607
|
|dimensionCardinalities|Array<<a href="#metricdimensioncardinality">MetricDimensionCardinality</a>>|The cardinalities of MINT metric dimensions. |
|
|
12385
12608
|
|dimensionDefinitions|Array<<a href="#metricdimensiondefinition" target="_blank" rel="noopener noreferrer">MetricDimensionDefinition</a>>|<p>The fine metric division (for example, process group and process ID for some process-related metric).</p> <p>For <a href="https://dt-url.net/5d63ic1" target="_blank" rel="noopener noreferrer" >ingested metrics</a>, dimensions that doesn't have have any data within the last 15 days are omitted.</p> |
|
|
@@ -12391,7 +12614,7 @@ The descriptor of a metric.
|
|
|
12391
12614
|
|maximumValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum allowed value of the metric.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12392
12615
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The fully qualified key of the metric.</p> <p>If a transformation has been used it is reflected in the metric key.</p> |
|
|
12393
12616
|
|metricSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The metric selector that is used when querying a func: metric. |
|
|
12394
|
-
|metricValueType|<a href="#metricvaluetype">MetricValueType</a>| |
|
|
12617
|
+
|metricValueType|<a href="#metricvaluetype">MetricValueType</a>|The value type for the metric. |
|
|
12395
12618
|
|minimumValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The minimum allowed value of the metric.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12396
12619
|
|resolutionInfSupported|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If 'true', resolution=Inf can be applied to the metric query. |
|
|
12397
12620
|
|rootCauseRelevant|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The metric is (<code>true</code>) or is not (<code>false</code>) root cause relevant.</p> <p>A root-cause relevant metric represents a strong indicator for a faulty component.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
@@ -12399,7 +12622,7 @@ The descriptor of a metric.
|
|
|
12399
12622
|
|tags|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The tags applied to the metric.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12400
12623
|
|transformations|Array<MetricDescriptorTransformationsItem>|Transform operators that could be appended to the current transformation list. |
|
|
12401
12624
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
12402
|
-
|unitDisplayFormat|MetricDescriptorUnitDisplayFormat
|
|
12625
|
+
|unitDisplayFormat|MetricDescriptorUnitDisplayFormat|<p>The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:</p> <p>Binary: 1 MiB = 1024 KiB = 1,048,576 bytes</p> <p>Decimal: 1 MB = 1000 kB = 1,000,000 bytes</p> <p>If not set, the decimal system is used.</p> <p><a href="https://dt-url.net/metricExpression" target="_blank" rel="noopener noreferrer" >Metric expressions</a> don't return this field.</p> |
|
|
12403
12626
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of potential warnings that affect this ID. For example deprecated feature usage etc. |
|
|
12404
12627
|
|
|
12405
12628
|
### MetricDescriptorCollection
|
|
@@ -12442,7 +12665,7 @@ The dimension of a metric.
|
|
|
12442
12665
|
|index<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The unique 0-based index of the dimension.</p> <p>Appending transformations such as :names or :parents may change the indexes of dimensions. <code>null</code> is used for the dimensions of a metric with flexible dimensions, which can be referenced with their dimension key, but do not have an intrinsic order that could be used for the index.</p> |
|
|
12443
12666
|
|key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The key of the dimension.</p> <p>It must be unique within the metric.</p> |
|
|
12444
12667
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the dimension. |
|
|
12445
|
-
|type<sup>*required</sup>|MetricDimensionDefinitionType| |
|
|
12668
|
+
|type<sup>*required</sup>|MetricDimensionDefinitionType|The type of the dimension. |
|
|
12446
12669
|
|
|
12447
12670
|
### MetricDto
|
|
12448
12671
|
|
|
@@ -12454,7 +12677,7 @@ Metric gathered by an extension
|
|
|
12454
12677
|
| Name | Type | Description |
|
|
12455
12678
|
| --- | --- | --- |
|
|
12456
12679
|
|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Metric key |
|
|
12457
|
-
|metadata|<a href="#metricmetadatadto">MetricMetadataDto</a>| |
|
|
12680
|
+
|metadata|<a href="#metricmetadatadto">MetricMetadataDto</a>|Metric metadata |
|
|
12458
12681
|
|
|
12459
12682
|
### MetricEvidence
|
|
12460
12683
|
|
|
@@ -12469,9 +12692,9 @@ A change of metric behavior that indicates the problem and/or is its root cause.
|
|
|
12469
12692
|
| --- | --- | --- |
|
|
12470
12693
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
12471
12694
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end time of the evidence, in UTC milliseconds.</p> <p>The value <code>null</code> indicates that the evidence is still open.</p> |
|
|
12472
|
-
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
12473
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
12474
|
-
|groupingEntity|<a href="#entitystub">EntityStub</a>| |
|
|
12695
|
+
|entity<sup>*required</sup>|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
12696
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
12697
|
+
|groupingEntity|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
12475
12698
|
|metricId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the metric. |
|
|
12476
12699
|
|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. |
|
|
12477
12700
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
@@ -12516,7 +12739,7 @@ Metric query translation to DQL.
|
|
|
12516
12739
|
| --- | --- | --- |
|
|
12517
12740
|
|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Error message - only present if the status is <code>not supported</code> |
|
|
12518
12741
|
|query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The DQL query corresponding to the metric query |
|
|
12519
|
-
|status|MetricQueryDQLTranslationStatus| |
|
|
12742
|
+
|status|MetricQueryDQLTranslationStatus|The status of the DQL translation, either <code>success</code> or <code>not supported</code> |
|
|
12520
12743
|
|
|
12521
12744
|
### MetricSeries
|
|
12522
12745
|
|
|
@@ -12530,7 +12753,7 @@ The data is represented by two arrays of the same length: **timestamps** and **v
|
|
|
12530
12753
|
| Name | Type | Description |
|
|
12531
12754
|
| --- | --- | --- |
|
|
12532
12755
|
|dimensionMap<sup>*required</sup>|<a href="#metricseriesdimensionmap">MetricSeriesDimensionMap</a>| |
|
|
12533
|
-
|dimensions<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The ordered list of dimensions to which the data point list belongs.</p> <p>Each metric can have a certain number of dimensions. Dimensions exceeding this number are aggregated into one, which is shown as <code>null</code> here.</p> |
|
|
12756
|
+
|dimensions<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>Deprecated, refer to <code>dimensionMap</code> instead.</p> <p>The ordered list of dimensions to which the data point list belongs.</p> <p>Each metric can have a certain number of dimensions. Dimensions exceeding this number are aggregated into one, which is shown as <code>null</code> here.</p> |
|
|
12534
12757
|
|timestamps<sup>*required</sup>|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>A list of timestamps of data points.</p> <p>The value of data point for each time from this array is located in <strong>values</strong> array at the same index.</p> |
|
|
12535
12758
|
|values<sup>*required</sup>|Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|<p>A list of values of data points.</p> <p>The timestamp of data point for each value from this array is located in <strong>timestamps</strong> array at the same index.</p> |
|
|
12536
12759
|
|
|
@@ -12547,7 +12770,7 @@ Data points of a metric.
|
|
|
12547
12770
|
|data<sup>*required</sup>|Array<<a href="#metricseries">MetricSeries</a>>|Data points of the metric. |
|
|
12548
12771
|
|dataPointCountRatio<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query. |
|
|
12549
12772
|
|dimensionCountRatio<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query. |
|
|
12550
|
-
|dql|<a href="#metricquerydqltranslation" target="_blank" rel="noopener noreferrer">MetricQueryDQLTranslation</a>| |
|
|
12773
|
+
|dql|<a href="#metricquerydqltranslation" target="_blank" rel="noopener noreferrer">MetricQueryDQLTranslation</a>|Metric query translation to DQL. |
|
|
12551
12774
|
|metricId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The key of the metric.</p> <p>If any transformation is applied, it is included here.</p> |
|
|
12552
12775
|
|warnings|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of potential warnings that affect this ID. For example deprecated feature usage etc. |
|
|
12553
12776
|
|
|
@@ -12561,9 +12784,9 @@ Data points of a metric.
|
|
|
12561
12784
|
|
|
12562
12785
|
The value type for the metric.
|
|
12563
12786
|
|
|
12564
|
-
| Name | Type |
|
|
12565
|
-
| --- | --- |
|
|
12566
|
-
|type<sup>*required</sup>|MetricValueTypeType|
|
|
12787
|
+
| Name | Type | Description |
|
|
12788
|
+
| --- | --- | --- |
|
|
12789
|
+
|type<sup>*required</sup>|MetricValueTypeType|The metric value type |
|
|
12567
12790
|
|
|
12568
12791
|
### MinimalExtension
|
|
12569
12792
|
|
|
@@ -12587,8 +12810,8 @@ Analysis of problem impact to a mobile application.
|
|
|
12587
12810
|
| Name | Type | Description |
|
|
12588
12811
|
| --- | --- | --- |
|
|
12589
12812
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
12590
|
-
|impactType<sup>*required</sup>|ImpactImpactType
|
|
12591
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
12813
|
+
|impactType<sup>*required</sup>|ImpactImpactType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
12814
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
12592
12815
|
|
|
12593
12816
|
### Modification
|
|
12594
12817
|
|
|
@@ -12660,7 +12883,7 @@ A result of the execution HTTP monitor's request.
|
|
|
12660
12883
|
|healthStatusCode|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request's health status code. |
|
|
12661
12884
|
|hostNameResolutionTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|A hostname resolution time measured in ms. |
|
|
12662
12885
|
|method|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request method type. |
|
|
12663
|
-
|monitorType<sup>*required</sup>|ExecutionStepMonitorType
|
|
12886
|
+
|monitorType<sup>*required</sup>|ExecutionStepMonitorType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BROWSER</code> -> BMAction</li> <li><code>HTTP</code> -> MonitorRequestExecutionResult</li> </ul> |
|
|
12664
12887
|
|peerCertificateDetails|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request's certificate details. |
|
|
12665
12888
|
|peerCertificateExpiryDate|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|An expiry date of the first SSL certificate from the certificate chain. |
|
|
12666
12889
|
|publicLocation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag informs whether request was executed on public location. |
|
|
@@ -12721,8 +12944,8 @@ Monitoring state of the process group instance.
|
|
|
12721
12944
|
| --- | --- | --- |
|
|
12722
12945
|
|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the process group instance. |
|
|
12723
12946
|
|params|Array<<a href="#monitoredentitystateparam" target="_blank" rel="noopener noreferrer">MonitoredEntityStateParam</a>>|Additional parameters of the monitoring state. |
|
|
12724
|
-
|severity|MonitoredEntityStatesSeverity| |
|
|
12725
|
-
|state|MonitoredEntityStatesState| |
|
|
12947
|
+
|severity|MonitoredEntityStatesSeverity|The type of the monitoring state. |
|
|
12948
|
+
|state|MonitoredEntityStatesState|The name of the monitoring state. |
|
|
12726
12949
|
|
|
12727
12950
|
### MonitoredStates
|
|
12728
12951
|
|
|
@@ -12748,7 +12971,7 @@ A list of entities and their monitoring states.
|
|
|
12748
12971
|
| Name | Type | Description |
|
|
12749
12972
|
| --- | --- | --- |
|
|
12750
12973
|
|scope<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The scope this monitoring configuration will be defined for |
|
|
12751
|
-
|value|JsonNode| |
|
|
12974
|
+
|value|JsonNode|The monitoring configuration |
|
|
12752
12975
|
|
|
12753
12976
|
### MonitoringConfigurationResponse
|
|
12754
12977
|
|
|
@@ -12769,9 +12992,9 @@ A list of entities and their monitoring states.
|
|
|
12769
12992
|
|
|
12770
12993
|
|
|
12771
12994
|
|
|
12772
|
-
| Name | Type |
|
|
12773
|
-
| --- | --- |
|
|
12774
|
-
|value|JsonNode|
|
|
12995
|
+
| Name | Type | Description |
|
|
12996
|
+
| --- | --- | --- |
|
|
12997
|
+
|value|JsonNode|The monitoring configuration |
|
|
12775
12998
|
|
|
12776
12999
|
### MuteState
|
|
12777
13000
|
|
|
@@ -12783,7 +13006,7 @@ Metadata of the muted state of a security problem in relation to an event.
|
|
|
12783
13006
|
| Name | Type | Description |
|
|
12784
13007
|
| --- | --- | --- |
|
|
12785
13008
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A user's comment. |
|
|
12786
|
-
|reason|MuteStateReason| |
|
|
13009
|
+
|reason|MuteStateReason|The reason for the mute state change. |
|
|
12787
13010
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user who has muted or unmuted the problem. |
|
|
12788
13011
|
|
|
12789
13012
|
### NetworkZone
|
|
@@ -12797,7 +13020,7 @@ Configuration of a network zone.
|
|
|
12797
13020
|
| --- | --- | --- |
|
|
12798
13021
|
|alternativeZones|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of alternative network zones. |
|
|
12799
13022
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the network zone. |
|
|
12800
|
-
|fallbackMode|NetworkZoneFallbackMode| |
|
|
13023
|
+
|fallbackMode|NetworkZoneFallbackMode|The fallback mode of the network zone. |
|
|
12801
13024
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the network zone. |
|
|
12802
13025
|
|numOfConfiguredActiveGates|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of ActiveGates in the network zone. |
|
|
12803
13026
|
|numOfConfiguredOneAgents|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of OneAgents that are configured to use the network zone as primary. |
|
|
@@ -12939,10 +13162,10 @@ A precondition for visibility of a property.
|
|
|
12939
13162
|
|expectedValue|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The expected value of the property.</p> <p>Only applicable to properties of the <code>EQUALS</code> type.</p> |
|
|
12940
13163
|
|expectedValues|Array<[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>|<p>A list of valid values of the property.</p> <p>Only applicable to properties of the <code>IN</code> type.</p> |
|
|
12941
13164
|
|pattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The Regular expression which is matched against the property.</p> <p>Only applicable to properties of the <code>REGEX_MATCH</code> type.</p> |
|
|
12942
|
-
|precondition|<a href="#precondition">Precondition</a>| |
|
|
13165
|
+
|precondition|<a href="#precondition">Precondition</a>|A precondition for visibility of a property. |
|
|
12943
13166
|
|preconditions|Array<<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>>|<p>A list of child preconditions to be evaluated.</p> <p>Only applicable to properties of the <code>AND</code> and <code>OR</code> types.</p> |
|
|
12944
13167
|
|property|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The property to be evaluated. |
|
|
12945
|
-
|type<sup>*required</sup>|PreconditionType| |
|
|
13168
|
+
|type<sup>*required</sup>|PreconditionType|The type of the precondition. |
|
|
12946
13169
|
|
|
12947
13170
|
### PrivateSyntheticLocation
|
|
12948
13171
|
|
|
@@ -12971,8 +13194,8 @@ Configuration of a private synthetic location.
|
|
|
12971
13194
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
12972
13195
|
|nodes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl" target="_blank" rel="noopener noreferrer" >GET all nodes</a> call.</p> |
|
|
12973
13196
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
12974
|
-
|status|SyntheticLocationStatus
|
|
12975
|
-
|type<sup>*required</sup>|SyntheticLocationType
|
|
13197
|
+
|status|SyntheticLocationStatus|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
13198
|
+
|type<sup>*required</sup>|SyntheticLocationType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> PublicSyntheticLocation</li> <li><code>PRIVATE</code> -> PrivateSyntheticLocation</li> <li><code>CLUSTER</code> -> PrivateSyntheticLocation</li> </ul> |
|
|
12976
13199
|
|useNewKubernetesVersion|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
|
|
12977
13200
|
|
|
12978
13201
|
### Problem
|
|
@@ -12988,22 +13211,22 @@ The properties of a problem.
|
|
|
12988
13211
|
|displayId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the problem. |
|
|
12989
13212
|
|endTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The end timestamp of the problem, in UTC milliseconds.</p> <p>Has <code>-1</code> value, if the problem is still open.</p> |
|
|
12990
13213
|
|entityTags|Array<<a href="#metag" target="_blank" rel="noopener noreferrer">METag</a>>|A list of all entity tags of the problem. |
|
|
12991
|
-
|evidenceDetails|<a href="#evidencedetails">EvidenceDetails</a>| |
|
|
12992
|
-
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>| |
|
|
12993
|
-
|impactLevel<sup>*required</sup>|ProblemImpactLevel| |
|
|
13214
|
+
|evidenceDetails|<a href="#evidencedetails">EvidenceDetails</a>|The evidence details of a problem. |
|
|
13215
|
+
|impactAnalysis|<a href="#impactanalysis" target="_blank" rel="noopener noreferrer">ImpactAnalysis</a>|A list of all impacts of the problem. |
|
|
13216
|
+
|impactLevel<sup>*required</sup>|ProblemImpactLevel|The impact level of the problem. It shows what is affected by the problem. |
|
|
12994
13217
|
|impactedEntities<sup>*required</sup>|Array<<a href="#entitystub">EntityStub</a>>|A list of all entities that are impacted by the problem. |
|
|
12995
13218
|
|k8s.cluster.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster names. |
|
|
12996
13219
|
|k8s.cluster.uid|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes cluster UIDs. |
|
|
12997
13220
|
|k8s.namespace.name|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The related Kubernetes namespace names. |
|
|
12998
|
-
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>| |
|
|
13221
|
+
|linkedProblemInfo|<a href="#linkedproblem" target="_blank" rel="noopener noreferrer">LinkedProblem</a>|The properties of the linked problem. |
|
|
12999
13222
|
|managementZones<sup>*required</sup>|Array<<a href="#managementzone">ManagementZone</a>>|A list of all management zones that the problem belongs to. |
|
|
13000
13223
|
|problemFilters<sup>*required</sup>|Array<<a href="#alertingprofilestub" target="_blank" rel="noopener noreferrer">AlertingProfileStub</a>>|A list of alerting profiles that match the problem. |
|
|
13001
13224
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
13002
|
-
|recentComments|<a href="#commentslist">CommentsList</a>| |
|
|
13003
|
-
|rootCauseEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
13004
|
-
|severityLevel<sup>*required</sup>|ProblemSeverityLevel| |
|
|
13225
|
+
|recentComments|<a href="#commentslist">CommentsList</a>|A list of comments. |
|
|
13226
|
+
|rootCauseEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
13227
|
+
|severityLevel<sup>*required</sup>|ProblemSeverityLevel|The severity of the problem. |
|
|
13005
13228
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start timestamp of the problem, in UTC milliseconds. |
|
|
13006
|
-
|status<sup>*required</sup>|ProblemStatus| |
|
|
13229
|
+
|status<sup>*required</sup>|ProblemStatus|The status of the problem. |
|
|
13007
13230
|
|title<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the problem, displayed in the UI. |
|
|
13008
13231
|
|
|
13009
13232
|
### ProblemCloseRequestDtoImpl
|
|
@@ -13028,7 +13251,7 @@ The result of closing a problem.
|
|
|
13028
13251
|
| --- | --- | --- |
|
|
13029
13252
|
|closeTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the user triggered the closing. |
|
|
13030
13253
|
|closing<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True, if the problem is being closed. |
|
|
13031
|
-
|comment|<a href="#comment">Comment</a>| |
|
|
13254
|
+
|comment|<a href="#comment">Comment</a>|The comment to a problem. |
|
|
13032
13255
|
|problemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the problem. |
|
|
13033
13256
|
|
|
13034
13257
|
### Problems
|
|
@@ -13070,24 +13293,24 @@ Configuration of a property in a settings schema.
|
|
|
13070
13293
|
| Name | Type | Description |
|
|
13071
13294
|
| --- | --- | --- |
|
|
13072
13295
|
|constraints|Array<<a href="#constraint" target="_blank" rel="noopener noreferrer">Constraint</a>>|A list of constraints limiting the values to be accepted. |
|
|
13073
|
-
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>| |
|
|
13296
|
+
|datasource|<a href="#datasourcedefinition">DatasourceDefinition</a>|Configuration of a datasource for a property. |
|
|
13074
13297
|
|default|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The default value to be used when no value is provided.</p> <p>If a non-singleton has the value of <code>null</code>, it means an empty collection.</p> |
|
|
13075
13298
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
13076
13299
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
13077
13300
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
13078
13301
|
|forceSecretResubmission|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if value is allowed to be modified when secret properties are not |
|
|
13079
|
-
|items|<a href="#item" target="_blank" rel="noopener noreferrer">Item</a>| |
|
|
13302
|
+
|items|<a href="#item" target="_blank" rel="noopener noreferrer">Item</a>|An item of a collection property. |
|
|
13080
13303
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum number of <strong>objects</strong> in a collection property.</p> <p>Has the value of <code>1</code> for singletons.</p> |
|
|
13081
|
-
|metadata|<a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>| |
|
|
13304
|
+
|metadata|<a href="#propertydefinitionmetadata">PropertyDefinitionMetadata</a>|Metadata of the property. |
|
|
13082
13305
|
|migrationPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Pattern with references to properties to create a new value. |
|
|
13083
13306
|
|minObjects|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of <strong>objects</strong> in a collection property. |
|
|
13084
|
-
|modificationPolicy|PropertyDefinitionModificationPolicy| |
|
|
13307
|
+
|modificationPolicy|PropertyDefinitionModificationPolicy|Modification policy of the property. |
|
|
13085
13308
|
|nullable<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The value can (<code>true</code>) or can't (<code>false</code>) be <code>null</code>. |
|
|
13086
|
-
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>| |
|
|
13309
|
+
|precondition|<a href="#precondition" target="_blank" rel="noopener noreferrer">Precondition</a>|A precondition for visibility of a property. |
|
|
13087
13310
|
|referencedType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type referenced by the property value |
|
|
13088
13311
|
|subType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The subtype of the property's value. |
|
|
13089
13312
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | <a href="#refpointer">RefPointer</a>|The type of the property's value. |
|
|
13090
|
-
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>| |
|
|
13313
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
13091
13314
|
|
|
13092
13315
|
### PropertyDefinitionMetadata
|
|
13093
13316
|
**type**: Record<string, string | undefined>
|
|
@@ -13103,9 +13326,9 @@ Metadata of the property.
|
|
|
13103
13326
|
|
|
13104
13327
|
Details that are specific to the used protocol.
|
|
13105
13328
|
|
|
13106
|
-
| Name | Type |
|
|
13107
|
-
| --- | --- |
|
|
13108
|
-
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|
|
|
13329
|
+
| Name | Type | Description |
|
|
13330
|
+
| --- | --- | --- |
|
|
13331
|
+
|http|<a href="#httpprotocoldetails">HttpProtocolDetails</a>|HTTP specific request details. |
|
|
13109
13332
|
|
|
13110
13333
|
### PublicCertificateCredentials
|
|
13111
13334
|
|
|
@@ -13125,9 +13348,9 @@ A credentials set of the `PUBLIC_CERTIFICATE` type.
|
|
|
13125
13348
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
13126
13349
|
|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>). |
|
|
13127
13350
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential (not supported). |
|
|
13128
|
-
|scope|CredentialsScope| |
|
|
13351
|
+
|scope|CredentialsScope|The scope of the credentials set. |
|
|
13129
13352
|
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
13130
|
-
|type|CredentialsType
|
|
13353
|
+
|type|CredentialsType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> </ul> |
|
|
13131
13354
|
|
|
13132
13355
|
### PublicSyntheticLocation
|
|
13133
13356
|
|
|
@@ -13154,8 +13377,8 @@ Configuration of a public synthetic location.
|
|
|
13154
13377
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
13155
13378
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
13156
13379
|
|stage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The stage of the location. |
|
|
13157
|
-
|status|SyntheticLocationStatus
|
|
13158
|
-
|type<sup>*required</sup>|SyntheticLocationType
|
|
13380
|
+
|status|SyntheticLocationStatus|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
13381
|
+
|type<sup>*required</sup>|SyntheticLocationType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> PublicSyntheticLocation</li> <li><code>PRIVATE</code> -> PrivateSyntheticLocation</li> <li><code>CLUSTER</code> -> PrivateSyntheticLocation</li> </ul> |
|
|
13159
13382
|
|
|
13160
13383
|
### RefPointer
|
|
13161
13384
|
|
|
@@ -13261,7 +13484,7 @@ A service related to a security problem.
|
|
|
13261
13484
|
| Name | Type | Description |
|
|
13262
13485
|
| --- | --- | --- |
|
|
13263
13486
|
|affectedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of affected entities related to the entity. |
|
|
13264
|
-
|exposure|RelatedServiceExposure| |
|
|
13487
|
+
|exposure|RelatedServiceExposure|The level of exposure of the service. |
|
|
13265
13488
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Dynatrace entity ID of the entity. |
|
|
13266
13489
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of affected entities related to the entity. |
|
|
13267
13490
|
|
|
@@ -13333,13 +13556,13 @@ Assessment of the remediation item.
|
|
|
13333
13556
|
|
|
13334
13557
|
| Name | Type | Description |
|
|
13335
13558
|
| --- | --- | --- |
|
|
13336
|
-
|assessmentAccuracy|RemediationAssessmentAssessmentAccuracy| |
|
|
13337
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13338
|
-
|dataAssets|RemediationAssessmentDataAssets| |
|
|
13339
|
-
|exposure|RemediationAssessmentExposure| |
|
|
13559
|
+
|assessmentAccuracy|RemediationAssessmentAssessmentAccuracy|The accuracy of the assessment. |
|
|
13560
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
13561
|
+
|dataAssets|RemediationAssessmentDataAssets|The reachability of related data assets by affected entities. |
|
|
13562
|
+
|exposure|RemediationAssessmentExposure|The level of exposure of affected entities. |
|
|
13340
13563
|
|numberOfDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related data assets. |
|
|
13341
13564
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13342
|
-
|vulnerableFunctionUsage|RemediationAssessmentVulnerableFunctionUsage| |
|
|
13565
|
+
|vulnerableFunctionUsage|RemediationAssessmentVulnerableFunctionUsage|The usage of vulnerable functions |
|
|
13343
13566
|
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13344
13567
|
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13345
13568
|
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
@@ -13353,15 +13576,15 @@ Detailed information of a remediation item for a security problem.
|
|
|
13353
13576
|
|
|
13354
13577
|
| Name | Type | Description |
|
|
13355
13578
|
| --- | --- | --- |
|
|
13356
|
-
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>| |
|
|
13579
|
+
|assessment|<a href="#remediationassessment" target="_blank" rel="noopener noreferrer">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
13357
13580
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13358
13581
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13359
13582
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13360
|
-
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>| |
|
|
13583
|
+
|muteState|<a href="#remediationitemmutestate">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
13361
13584
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13362
|
-
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>| |
|
|
13585
|
+
|remediationProgress|<a href="#remediationprogress" target="_blank" rel="noopener noreferrer">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
13363
13586
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13364
|
-
|trackingLink|<a href="#trackinglink">TrackingLink</a>| |
|
|
13587
|
+
|trackingLink|<a href="#trackinglink">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
13365
13588
|
|vulnerabilityState|RemediationDetailsItemVulnerabilityState| |
|
|
13366
13589
|
|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> |
|
|
13367
13590
|
|
|
@@ -13374,15 +13597,15 @@ A possible remediation for a security problem.
|
|
|
13374
13597
|
|
|
13375
13598
|
| Name | Type | Description |
|
|
13376
13599
|
| --- | --- | --- |
|
|
13377
|
-
|assessment|<a href="#remediationassessment">RemediationAssessment</a>| |
|
|
13600
|
+
|assessment|<a href="#remediationassessment">RemediationAssessment</a>|Assessment of the remediation item. |
|
|
13378
13601
|
|entityIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |
|
|
13379
13602
|
|firstAffectedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13380
13603
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13381
|
-
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>| |
|
|
13604
|
+
|muteState|<a href="#remediationitemmutestate" target="_blank" rel="noopener noreferrer">RemediationItemMuteState</a>|The mute state of a remediation item of a security problem. |
|
|
13382
13605
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
|
|
13383
|
-
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>| |
|
|
13606
|
+
|remediationProgress|<a href="#remediationprogress">RemediationProgress</a>|The progress of this remediation item. It contains affected and unaffected entities. |
|
|
13384
13607
|
|resolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
|
|
13385
|
-
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>| |
|
|
13608
|
+
|trackingLink|<a href="#trackinglink" target="_blank" rel="noopener noreferrer">TrackingLink</a>|External tracking link URL associated with the remediable entity of the security problem. |
|
|
13386
13609
|
|vulnerabilityState|RemediationItemVulnerabilityState| |
|
|
13387
13610
|
|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> |
|
|
13388
13611
|
|
|
@@ -13426,7 +13649,7 @@ The mute state of a remediation item of a security problem.
|
|
|
13426
13649
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short comment about the most recent mute state change. |
|
|
13427
13650
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp (UTC milliseconds) of the last update of the mute state. |
|
|
13428
13651
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The remediation is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
13429
|
-
|reason|RemediationItemMuteStateReason| |
|
|
13652
|
+
|reason|RemediationItemMuteStateReason|The reason for the most recent mute state change. |
|
|
13430
13653
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user who last changed the mute state. |
|
|
13431
13654
|
|
|
13432
13655
|
### RemediationItemMuteStateChange
|
|
@@ -13440,7 +13663,7 @@ An updated configuration of the remediation item's mute state.
|
|
|
13440
13663
|
| --- | --- | --- |
|
|
13441
13664
|
|comment<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the mute state change reason. |
|
|
13442
13665
|
|muted<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The desired mute state of the remediation item. |
|
|
13443
|
-
|reason<sup>*required</sup>|RemediationItemMuteStateChangeReason| |
|
|
13666
|
+
|reason<sup>*required</sup>|RemediationItemMuteStateChangeReason|The reason for the mute state change. |
|
|
13444
13667
|
|
|
13445
13668
|
### RemediationItemMutingSummary
|
|
13446
13669
|
|
|
@@ -13452,7 +13675,7 @@ Summary of (un-)muting a remediation item.
|
|
|
13452
13675
|
| Name | Type | Description |
|
|
13453
13676
|
| --- | --- | --- |
|
|
13454
13677
|
|muteStateChangeTriggered<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a mute state change for the given remediation item was triggered by this request. |
|
|
13455
|
-
|reason|RemediationItemMutingSummaryReason| |
|
|
13678
|
+
|reason|RemediationItemMutingSummaryReason|Contains a reason, in case the requested operation was not executed. |
|
|
13456
13679
|
|remediationItemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the remediation item that will be (un-)muted. |
|
|
13457
13680
|
|
|
13458
13681
|
### RemediationItemsBulkMute
|
|
@@ -13465,7 +13688,7 @@ Information on muting several remediation items.
|
|
|
13465
13688
|
| Name | Type | Description |
|
|
13466
13689
|
| --- | --- | --- |
|
|
13467
13690
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the muting reason. |
|
|
13468
|
-
|reason<sup>*required</sup>|RemediationItemsBulkMuteReason| |
|
|
13691
|
+
|reason<sup>*required</sup>|RemediationItemsBulkMuteReason|The reason for muting the remediation items. |
|
|
13469
13692
|
|remediationItemIds<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The ids of the remediation items to be muted. |
|
|
13470
13693
|
|
|
13471
13694
|
### RemediationItemsBulkMuteResponse
|
|
@@ -13489,7 +13712,7 @@ Information on un-muting several remediation items.
|
|
|
13489
13712
|
| Name | Type | Description |
|
|
13490
13713
|
| --- | --- | --- |
|
|
13491
13714
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the un-muting reason. |
|
|
13492
|
-
|reason<sup>*required</sup>|Affected| |
|
|
13715
|
+
|reason<sup>*required</sup>|Affected|The reason for un-muting the remediation items. |
|
|
13493
13716
|
|remediationItemIds<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The ids of the remediation items to be un-muted. |
|
|
13494
13717
|
|
|
13495
13718
|
### RemediationItemsBulkUnmuteResponse
|
|
@@ -13513,7 +13736,7 @@ Contains the external tracking link associations to be applied to the remediatio
|
|
|
13513
13736
|
| Name | Type | Description |
|
|
13514
13737
|
| --- | --- | --- |
|
|
13515
13738
|
|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> |
|
|
13516
|
-
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a
|
|
13739
|
+
|updates|<a href="#remediationitemsbulkupdatedeletedtoupdates">RemediationItemsBulkUpdateDeleteDtoUpdates</a>|<p>Tracking links to set for the security problem.</p> <p>Map of remediation item ID to tracking link objects.</p> <p>Keys must be valid remediation item IDs of the security problem, the associated value must contain the link to set for the item.</p> |
|
|
13517
13740
|
|
|
13518
13741
|
### RemediationItemsBulkUpdateDeleteDtoUpdates
|
|
13519
13742
|
**type**: Record<string, TrackingLinkUpdate | undefined>
|
|
@@ -13547,11 +13770,11 @@ An affected or unaffected entity of a remediation for a security problem.
|
|
|
13547
13770
|
|
|
13548
13771
|
| Name | Type | Description |
|
|
13549
13772
|
| --- | --- | --- |
|
|
13550
|
-
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>| |
|
|
13773
|
+
|assessment|<a href="#remediationprogressentityassessment" target="_blank" rel="noopener noreferrer">RemediationProgressEntityAssessment</a>|Assessment of the remediation progress entity. |
|
|
13551
13774
|
|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. |
|
|
13552
13775
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the remediation progress entity. |
|
|
13553
13776
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the remediation progress entity. |
|
|
13554
|
-
|state|RemediationProgressEntityState| |
|
|
13777
|
+
|state|RemediationProgressEntityState|The current state of the remediation progress entity. |
|
|
13555
13778
|
|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> |
|
|
13556
13779
|
|
|
13557
13780
|
### RemediationProgressEntityAssessment
|
|
@@ -13564,7 +13787,7 @@ Assessment of the remediation progress entity.
|
|
|
13564
13787
|
| Name | Type | Description |
|
|
13565
13788
|
| --- | --- | --- |
|
|
13566
13789
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for the latest vulnerable function data. |
|
|
13567
|
-
|vulnerableFunctionUsage|RemediationProgressEntityAssessmentVulnerableFunctionUsage| |
|
|
13790
|
+
|vulnerableFunctionUsage|RemediationProgressEntityAssessmentVulnerableFunctionUsage|The usage of vulnerable functions |
|
|
13568
13791
|
|vulnerableFunctionsInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are in use. |
|
|
13569
13792
|
|vulnerableFunctionsNotAvailable|Array<<a href="#vulnerablefunction">VulnerableFunction</a>>|A list of vulnerable functions that are not available. |
|
|
13570
13793
|
|vulnerableFunctionsNotInUse|Array<<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>>|A list of vulnerable functions that are not in use. |
|
|
@@ -13606,7 +13829,7 @@ Describes the complete request information of an attack.
|
|
|
13606
13829
|
| --- | --- | --- |
|
|
13607
13830
|
|host|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target host of the request. |
|
|
13608
13831
|
|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The request path. |
|
|
13609
|
-
|protocolDetails|<a href="#protocoldetails" target="_blank" rel="noopener noreferrer">ProtocolDetails</a>| |
|
|
13832
|
+
|protocolDetails|<a href="#protocoldetails" target="_blank" rel="noopener noreferrer">ProtocolDetails</a>|Details that are specific to the used protocol. |
|
|
13610
13833
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested URL. |
|
|
13611
13834
|
|
|
13612
13835
|
### ResolutionRequest
|
|
@@ -13629,7 +13852,7 @@ The resource context, which contains additional permission information about the
|
|
|
13629
13852
|
|
|
13630
13853
|
| Name | Type | Description |
|
|
13631
13854
|
| --- | --- | --- |
|
|
13632
|
-
|modifications<sup>*required</sup>|<a href="#modification" target="_blank" rel="noopener noreferrer">Modification</a>| |
|
|
13855
|
+
|modifications<sup>*required</sup>|<a href="#modification" target="_blank" rel="noopener noreferrer">Modification</a>|The additional modification details for this settings object. |
|
|
13633
13856
|
|operations<sup>*required</sup>|Array<ResourceContextOperationsItem>|The allowed operations on this settings object. |
|
|
13634
13857
|
|
|
13635
13858
|
### RevisionDiff
|
|
@@ -13644,11 +13867,11 @@ The diff between two revisions.
|
|
|
13644
13867
|
|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
13868
|
|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
13869
|
|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>| |
|
|
13870
|
+
|modificationInfo|<a href="#historymodificationinfo">HistoryModificationInfo</a>|Modification information about the setting. |
|
|
13648
13871
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
13649
13872
|
|revision|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The revision of the change. |
|
|
13650
13873
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema version the new value complies to |
|
|
13651
|
-
|type|RevisionDiffType| |
|
|
13874
|
+
|type|RevisionDiffType|The type of the difference. |
|
|
13652
13875
|
|
|
13653
13876
|
### RevisionDiffPage
|
|
13654
13877
|
|
|
@@ -13674,18 +13897,18 @@ Risk assessment of a security problem.
|
|
|
13674
13897
|
|
|
13675
13898
|
| Name | Type | Description |
|
|
13676
13899
|
| --- | --- | --- |
|
|
13677
|
-
|assessmentAccuracy|RiskAssessmentAssessmentAccuracy| |
|
|
13678
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>| |
|
|
13679
|
-
|baseRiskLevel|RiskAssessmentBaseRiskLevel| |
|
|
13900
|
+
|assessmentAccuracy|RiskAssessmentAssessmentAccuracy|The accuracy of the assessment. |
|
|
13901
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
13902
|
+
|baseRiskLevel|RiskAssessmentBaseRiskLevel|The risk level from the CVSS score. |
|
|
13680
13903
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13681
13904
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
13682
|
-
|dataAssets|RiskAssessmentDataAssets| |
|
|
13683
|
-
|exposure|RiskAssessmentExposure| |
|
|
13684
|
-
|publicExploit|RiskAssessmentPublicExploit| |
|
|
13685
|
-
|riskLevel|RiskAssessmentRiskLevel
|
|
13905
|
+
|dataAssets|RiskAssessmentDataAssets|The reachability of related data assets by affected entities. |
|
|
13906
|
+
|exposure|RiskAssessmentExposure|The level of exposure of affected entities. |
|
|
13907
|
+
|publicExploit|RiskAssessmentPublicExploit|The availability status of public exploits. |
|
|
13908
|
+
|riskLevel|RiskAssessmentRiskLevel|<p>The Davis risk level.</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13686
13909
|
|riskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The Davis risk score (1-10).</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13687
13910
|
|riskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The attack vector calculated by Dynatrace based on the CVSS attack vector. |
|
|
13688
|
-
|vulnerableFunctionUsage|RiskAssessmentVulnerableFunctionUsage| |
|
|
13911
|
+
|vulnerableFunctionUsage|RiskAssessmentVulnerableFunctionUsage|The state of vulnerable code execution. |
|
|
13689
13912
|
|
|
13690
13913
|
### RiskAssessmentChanges
|
|
13691
13914
|
|
|
@@ -13702,9 +13925,9 @@ All changes of the risk assessment.
|
|
|
13702
13925
|
|deltaNumberOfReachableDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The delta of the number of data assets that are currently reachable by affected entities. |
|
|
13703
13926
|
|deltaNumberOfRelatedAttacks|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The delta of the number of related attacks. |
|
|
13704
13927
|
|deltaRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The delta of the Davis risk score. |
|
|
13705
|
-
|previousExposure|RiskAssessmentChangesPreviousExposure| |
|
|
13706
|
-
|previousPublicExploit|RiskAssessmentChangesPreviousPublicExploit| |
|
|
13707
|
-
|previousVulnerableFunctionUsage|RiskAssessmentChangesPreviousVulnerableFunctionUsage| |
|
|
13928
|
+
|previousExposure|RiskAssessmentChangesPreviousExposure|The previous level of exposure of affected entities. |
|
|
13929
|
+
|previousPublicExploit|RiskAssessmentChangesPreviousPublicExploit|The previous availability status of public exploits. |
|
|
13930
|
+
|previousVulnerableFunctionUsage|RiskAssessmentChangesPreviousVulnerableFunctionUsage|The previous state of vulnerable code execution. |
|
|
13708
13931
|
|
|
13709
13932
|
### RiskAssessmentDetails
|
|
13710
13933
|
|
|
@@ -13715,19 +13938,19 @@ Risk assessment of a security problem.
|
|
|
13715
13938
|
|
|
13716
13939
|
| Name | Type | Description |
|
|
13717
13940
|
| --- | --- | --- |
|
|
13718
|
-
|assessmentAccuracy|RiskAssessmentDetailsAssessmentAccuracy| |
|
|
13719
|
-
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>| |
|
|
13720
|
-
|baseRiskLevel|RiskAssessmentDetailsBaseRiskLevel| |
|
|
13941
|
+
|assessmentAccuracy|RiskAssessmentDetailsAssessmentAccuracy|The accuracy of the assessment. |
|
|
13942
|
+
|assessmentAccuracyDetails|<a href="#assessmentaccuracydetails" target="_blank" rel="noopener noreferrer">AssessmentAccuracyDetails</a>|The assessment accuracy details. |
|
|
13943
|
+
|baseRiskLevel|RiskAssessmentDetailsBaseRiskLevel|The risk level from the CVSS score. |
|
|
13721
13944
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13722
13945
|
|baseRiskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The original attack vector of the CVSS assessment. |
|
|
13723
|
-
|dataAssets|RiskAssessmentDetailsDataAssets| |
|
|
13724
|
-
|exposure|RiskAssessmentDetailsExposure| |
|
|
13725
|
-
|publicExploit|RiskAssessmentDetailsPublicExploit| |
|
|
13726
|
-
|riskLevel|RiskAssessmentDetailsRiskLevel
|
|
13946
|
+
|dataAssets|RiskAssessmentDetailsDataAssets|The reachability of related data assets by affected entities. |
|
|
13947
|
+
|exposure|RiskAssessmentDetailsExposure|The level of exposure of affected entities. |
|
|
13948
|
+
|publicExploit|RiskAssessmentDetailsPublicExploit|The availability status of public exploits. |
|
|
13949
|
+
|riskLevel|RiskAssessmentDetailsRiskLevel|<p>The Davis risk level.</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13727
13950
|
|riskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The Davis risk score (1-10).</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13728
13951
|
|riskVector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The attack vector calculated by Dynatrace based on the CVSS attack vector. |
|
|
13729
13952
|
|vulnerableFunctionRestartRequired|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a restart is required for new vulnerable function data. |
|
|
13730
|
-
|vulnerableFunctionUsage|RiskAssessmentDetailsVulnerableFunctionUsage| |
|
|
13953
|
+
|vulnerableFunctionUsage|RiskAssessmentDetailsVulnerableFunctionUsage|The state of vulnerable code execution. |
|
|
13731
13954
|
|
|
13732
13955
|
### RiskAssessmentSnapshot
|
|
13733
13956
|
|
|
@@ -13739,17 +13962,17 @@ A snapshot of the risk assessment of a security problem.
|
|
|
13739
13962
|
| Name | Type | Description |
|
|
13740
13963
|
| --- | --- | --- |
|
|
13741
13964
|
|baseRiskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The risk score (1-10) from the CVSS score. |
|
|
13742
|
-
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>| |
|
|
13743
|
-
|exposure|RiskAssessmentSnapshotExposure| |
|
|
13965
|
+
|changes|<a href="#riskassessmentchanges">RiskAssessmentChanges</a>|All changes of the risk assessment. |
|
|
13966
|
+
|exposure|RiskAssessmentSnapshotExposure|The level of exposure of affected entities. |
|
|
13744
13967
|
|numberOfAffectedEntities|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected entities. |
|
|
13745
13968
|
|numberOfAffectedNodes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected nodes. |
|
|
13746
13969
|
|numberOfAffectedProcessGroups|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of currently affected process groups. |
|
|
13747
13970
|
|numberOfReachableDataAssets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of data assets that are currently reachable by affected entities. |
|
|
13748
13971
|
|numberOfRelatedAttacks|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of related attacks. |
|
|
13749
|
-
|publicExploit|RiskAssessmentSnapshotPublicExploit| |
|
|
13750
|
-
|riskLevel|RiskAssessmentSnapshotRiskLevel
|
|
13972
|
+
|publicExploit|RiskAssessmentSnapshotPublicExploit|The availability status of public exploits. |
|
|
13973
|
+
|riskLevel|RiskAssessmentSnapshotRiskLevel|<p>The Davis risk level.</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13751
13974
|
|riskScore|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The Davis risk score (1-10).</p> <p>It is calculated by Dynatrace on the basis of CVSS score.</p> |
|
|
13752
|
-
|vulnerableFunctionUsage|RiskAssessmentSnapshotVulnerableFunctionUsage| |
|
|
13975
|
+
|vulnerableFunctionUsage|RiskAssessmentSnapshotVulnerableFunctionUsage|The state of vulnerable code execution. |
|
|
13753
13976
|
|
|
13754
13977
|
### Rollup
|
|
13755
13978
|
|
|
@@ -13778,10 +14001,10 @@ Parameters of a service-level objective (SLO).
|
|
|
13778
14001
|
|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>). |
|
|
13779
14002
|
|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> |
|
|
13780
14003
|
|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> |
|
|
13781
|
-
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate" target="_blank" rel="noopener noreferrer">SloBurnRate</a>| |
|
|
14004
|
+
|errorBudgetBurnRate<sup>*required</sup>|<a href="#sloburnrate" target="_blank" rel="noopener noreferrer">SloBurnRate</a>|Error budget burn rate evaluation of a service-level objective (SLO). |
|
|
13782
14005
|
|errorBudgetMetricKey<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key for the SLO's error budget func metric. |
|
|
13783
14006
|
|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> |
|
|
13784
|
-
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
14007
|
+
|evaluationType<sup>*required</sup>|Aggregate|The evaluation type of the SLO. |
|
|
13785
14008
|
|filter<sup>*required</sup>|[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>. |
|
|
13786
14009
|
|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the SLO |
|
|
13787
14010
|
|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> |
|
|
@@ -13795,7 +14018,7 @@ Parameters of a service-level objective (SLO).
|
|
|
13795
14018
|
|problemFilters|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO. |
|
|
13796
14019
|
|relatedOpenProblems|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>Number of open problems related to the SLO.</p> <p>Has the value of <code>-1</code> if there's an error with fetching SLO related problems.</p> |
|
|
13797
14020
|
|relatedTotalProblems|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>Total number of problems related to the SLO.</p> <p>Has the value of <code>-1</code> if there's an error with fetching SLO related problems.</p> |
|
|
13798
|
-
|status<sup>*required</sup>|SLOStatus| |
|
|
14021
|
+
|status<sup>*required</sup>|SLOStatus|The status of the calculated SLO. |
|
|
13799
14022
|
|target<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The target value of the SLO. |
|
|
13800
14023
|
|timeframe<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector. |
|
|
13801
14024
|
|useRateMetric|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The type of the metric to use for SLO calculation:</p> <ul> <li><code>true</code>: An existing percentage-based metric.</li> <li><code>false</code>: A ratio of two metrics.</li> </ul> <p>For a list of available metrics, see <a href="https://dt-url.net/be03kow" target="_blank" rel="noopener noreferrer" >Built-in metric page</a> or try the <a href="https://dt-url.net/8e43kxf" target="_blank" rel="noopener noreferrer" >GET metrics</a> API call.</p> |
|
|
@@ -13827,7 +14050,7 @@ Contains SLOs and paging information.
|
|
|
13827
14050
|
|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |
|
|
13828
14051
|
|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |
|
|
13829
14052
|
|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |
|
|
13830
|
-
|type<sup>*required</sup>|SchemaConstraintRestDtoType| |
|
|
14053
|
+
|type<sup>*required</sup>|SchemaConstraintRestDtoType|The type of the schema constraint. |
|
|
13831
14054
|
|uniqueProperties|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The list of properties for which the combination of values needs to be unique |
|
|
13832
14055
|
|
|
13833
14056
|
### SchemaDefinitionRestDto
|
|
@@ -13846,19 +14069,19 @@ Contains SLOs and paging information.
|
|
|
13846
14069
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the schema. |
|
|
13847
14070
|
|documentation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description of the schema and/or links to documentation. |
|
|
13848
14071
|
|dynatrace<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the data format. |
|
|
13849
|
-
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>| |
|
|
14072
|
+
|enums<sup>*required</sup>|<a href="#schemadefinitionrestdtoenums" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoEnums</a>|A list of definitions of enum properties. |
|
|
13850
14073
|
|keyProperty|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the key property in this schema. |
|
|
13851
14074
|
|maxObjects<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum amount of objects per scope.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13852
|
-
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>| |
|
|
14075
|
+
|metadata|<a href="#schemadefinitionrestdtometadata">SchemaDefinitionRestDtoMetadata</a>|Metadata of the setting. |
|
|
13853
14076
|
|multiObject<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Multiple (<code>true</code>) objects per scope are permitted or a single (<code>false</code>) object per scope is permitted. |
|
|
13854
14077
|
|ordered|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code> the order of objects has semantic significance.</p> <p>Only applicable when <strong>multiObject</strong> is set to <code>true</code>.</p> |
|
|
13855
|
-
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>| |
|
|
14078
|
+
|properties<sup>*required</sup>|<a href="#schemadefinitionrestdtoproperties" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoProperties</a>|A list of schema's properties. |
|
|
13856
14079
|
|schemaConstraints|Array<<a href="#schemaconstraintrestdto">SchemaConstraintRestDto</a>>|Constraints limiting the values as a whole to be accepted in this configuration element. |
|
|
13857
14080
|
|schemaGroups|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Names of the groups, which the schema belongs to. |
|
|
13858
14081
|
|schemaId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the schema. |
|
|
13859
|
-
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>| |
|
|
13860
|
-
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a
|
|
13861
|
-
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>| |
|
|
14082
|
+
|tableColumns|<a href="#schemadefinitionrestdtotablecolumns" target="_blank" rel="noopener noreferrer">SchemaDefinitionRestDtoTableColumns</a>|Table column definitions for use in the ui. |
|
|
14083
|
+
|types<sup>*required</sup>|<a href="#schemadefinitionrestdtotypes">SchemaDefinitionRestDtoTypes</a>|<p>A list of definitions of types.</p> <p>A type is a complex property that contains its own set of subproperties.</p> |
|
|
14084
|
+
|uiCustomization|<a href="#uicustomization" target="_blank" rel="noopener noreferrer">UiCustomization</a>|Customization for UI elements |
|
|
13862
14085
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |
|
|
13863
14086
|
|
|
13864
14087
|
### SchemaDefinitionRestDtoEnums
|
|
@@ -13951,10 +14174,10 @@ A list of definitions of types.
|
|
|
13951
14174
|
|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |
|
|
13952
14175
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |
|
|
13953
14176
|
|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |
|
|
13954
|
-
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>| |
|
|
14177
|
+
|properties<sup>*required</sup>|<a href="#schematypeproperties">SchemaTypeProperties</a>|Definition of properties that can be persisted. |
|
|
13955
14178
|
|searchPattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary search(for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13956
14179
|
|summaryPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The pattern for the summary (for example, "Alert after <em>X</em> minutes.") of the configuration in the UI. |
|
|
13957
|
-
|type<sup>*required</sup>|Object| |
|
|
14180
|
+
|type<sup>*required</sup>|Object|Type of the reference type. |
|
|
13958
14181
|
|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the type. |
|
|
13959
14182
|
|versionInfo|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the version. |
|
|
13960
14183
|
|
|
@@ -14008,25 +14231,25 @@ Parameters of a security problem
|
|
|
14008
14231
|
|
|
14009
14232
|
| Name | Type | Description |
|
|
14010
14233
|
| --- | --- | --- |
|
|
14011
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
14234
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
14012
14235
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
14013
14236
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
14014
14237
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
14015
14238
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
14016
|
-
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>| |
|
|
14239
|
+
|globalCounts|<a href="#globalcountsdto">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
14017
14240
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
14018
14241
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
14019
14242
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
14020
14243
|
|managementZones|Array<<a href="#managementzone" target="_blank" rel="noopener noreferrer">ManagementZone</a>>|A list of management zones which the affected entities belong to. |
|
|
14021
14244
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
14022
14245
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
14023
|
-
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>| |
|
|
14246
|
+
|riskAssessment|<a href="#riskassessment">RiskAssessment</a>|Risk assessment of a security problem. |
|
|
14024
14247
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
14025
|
-
|status|SecurityProblemStatus| |
|
|
14026
|
-
|technology|SecurityProblemTechnology| |
|
|
14248
|
+
|status|SecurityProblemStatus|The status of the security problem. |
|
|
14249
|
+
|technology|SecurityProblemTechnology|The technology of the security problem. |
|
|
14027
14250
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
14028
14251
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
14029
|
-
|vulnerabilityType|SecurityProblemVulnerabilityType| |
|
|
14252
|
+
|vulnerabilityType|SecurityProblemVulnerabilityType|The type of the vulnerability. |
|
|
14030
14253
|
|
|
14031
14254
|
### SecurityProblemBulkMutingSummary
|
|
14032
14255
|
|
|
@@ -14038,7 +14261,7 @@ Summary of (un-)muting a security problem.
|
|
|
14038
14261
|
| Name | Type | Description |
|
|
14039
14262
|
| --- | --- | --- |
|
|
14040
14263
|
|muteStateChangeTriggered<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether a mute state change for the given security problem was triggered by this request. |
|
|
14041
|
-
|reason|SecurityProblemBulkMutingSummaryReason| |
|
|
14264
|
+
|reason|SecurityProblemBulkMutingSummaryReason|Contains a reason, in case the requested operation was not executed. |
|
|
14042
14265
|
|securityProblemId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the security problem that was (un-)muted. |
|
|
14043
14266
|
|
|
14044
14267
|
### SecurityProblemDetails
|
|
@@ -14051,17 +14274,17 @@ Parameters of a security problem
|
|
|
14051
14274
|
| Name | Type | Description |
|
|
14052
14275
|
| --- | --- | --- |
|
|
14053
14276
|
|affectedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of affected entities of the security problem.</p> <p>An affected entity is an entity where a vulnerable component runs.</p> |
|
|
14054
|
-
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>| |
|
|
14277
|
+
|codeLevelVulnerabilityDetails|<a href="#codelevelvulnerabilitydetails" target="_blank" rel="noopener noreferrer">CodeLevelVulnerabilityDetails</a>|The details of a code-level vulnerability. |
|
|
14055
14278
|
|cveIds|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of CVE IDs of the security problem. |
|
|
14056
14279
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the security problem. |
|
|
14057
14280
|
|displayId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display ID of the security problem. |
|
|
14058
|
-
|entryPoints|<a href="#entrypoints">EntryPoints</a>| |
|
|
14281
|
+
|entryPoints|<a href="#entrypoints">EntryPoints</a>|A list of entry points and a flag which indicates whether this list was truncated or not. |
|
|
14059
14282
|
|events|Array<<a href="#securityproblemevent" target="_blank" rel="noopener noreferrer">SecurityProblemEvent</a>>|An ordered (newest first) list of events of the security problem. |
|
|
14060
14283
|
|exposedEntities|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of exposed entities of the security problem.</p> <p>An exposed entity is an affected entity that is exposed to the internet.</p> |
|
|
14061
14284
|
|externalVulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external vulnerability ID of the security problem. |
|
|
14062
|
-
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>| |
|
|
14285
|
+
|filteredCounts|<a href="#filteredcountsdto">FilteredCountsDto</a>|Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters. |
|
|
14063
14286
|
|firstSeenTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the first occurrence of the security problem. |
|
|
14064
|
-
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>| |
|
|
14287
|
+
|globalCounts|<a href="#globalcountsdto" target="_blank" rel="noopener noreferrer">GlobalCountsDto</a>|Globally calculated statistics about the security problem. No management zone information is taken into account. |
|
|
14065
14288
|
|lastOpenedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last opened. |
|
|
14066
14289
|
|lastResolvedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the security problem was last resolved. |
|
|
14067
14290
|
|lastUpdatedTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the most recent security problem change. |
|
|
@@ -14070,17 +14293,17 @@ Parameters of a security problem
|
|
|
14070
14293
|
|muted|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The security problem is (<code>true</code>) or is not (<code>false</code>) muted. |
|
|
14071
14294
|
|packageName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The package name of the security problem. |
|
|
14072
14295
|
|reachableDataAssets|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of data assets reachable by affected entities of the security problem.</p> <p>A data asset is a service that has database access.</p> |
|
|
14073
|
-
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a
|
|
14074
|
-
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>| |
|
|
14075
|
-
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a
|
|
14296
|
+
|relatedAttacks|<a href="#relatedattackslist" target="_blank" rel="noopener noreferrer">RelatedAttacksList</a>|<p>A list of related attacks of the security problem.</p> <p>Related attacks are attacks on the exposed security problem.</p> |
|
|
14297
|
+
|relatedContainerImages|<a href="#relatedcontainerlist">RelatedContainerList</a>|A list of related container images. |
|
|
14298
|
+
|relatedEntities|<a href="#relatedentitieslist" target="_blank" rel="noopener noreferrer">RelatedEntitiesList</a>|<p>A list of related entities of the security problem.</p> <p>A related entity is a monitored entity that is directly or indirectly related to an <em>affected entity</em> (for example, it could be a host where an affected process runs).</p> <p>Each related entity contains a list of corresponding affected entities (for example, an affected process running on this host).</p> |
|
|
14076
14299
|
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
14077
|
-
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>| |
|
|
14300
|
+
|riskAssessment|<a href="#riskassessmentdetails">RiskAssessmentDetails</a>|Risk assessment of a security problem. |
|
|
14078
14301
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
14079
|
-
|status|SecurityProblemDetailsStatus| |
|
|
14080
|
-
|technology|SecurityProblemDetailsTechnology| |
|
|
14302
|
+
|status|SecurityProblemDetailsStatus|The status of the security problem. |
|
|
14303
|
+
|technology|SecurityProblemDetailsTechnology|The technology of the security problem. |
|
|
14081
14304
|
|title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The title of the security problem. |
|
|
14082
14305
|
|url|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL to the security problem details page. |
|
|
14083
|
-
|vulnerabilityType|SecurityProblemDetailsVulnerabilityType| |
|
|
14306
|
+
|vulnerabilityType|SecurityProblemDetailsVulnerabilityType|The type of the vulnerability. |
|
|
14084
14307
|
|vulnerableComponents|Array<<a href="#vulnerablecomponent" target="_blank" rel="noopener noreferrer">VulnerableComponent</a>>|<p>A list of vulnerable components of the security problem.</p> <p>A vulnerable component is what causes the security problem.</p> |
|
|
14085
14308
|
|
|
14086
14309
|
### SecurityProblemEvent
|
|
@@ -14092,9 +14315,9 @@ The event of a security problem.
|
|
|
14092
14315
|
|
|
14093
14316
|
| Name | Type | Description |
|
|
14094
14317
|
| --- | --- | --- |
|
|
14095
|
-
|muteState|<a href="#mutestate">MuteState</a>| |
|
|
14096
|
-
|reason|SecurityProblemEventReason| |
|
|
14097
|
-
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>| |
|
|
14318
|
+
|muteState|<a href="#mutestate">MuteState</a>|Metadata of the muted state of a security problem in relation to an event. |
|
|
14319
|
+
|reason|SecurityProblemEventReason|The reason of the event creation. |
|
|
14320
|
+
|riskAssessmentSnapshot|<a href="#riskassessmentsnapshot" target="_blank" rel="noopener noreferrer">RiskAssessmentSnapshot</a>|A snapshot of the risk assessment of a security problem. |
|
|
14098
14321
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when the event occurred. |
|
|
14099
14322
|
|
|
14100
14323
|
### SecurityProblemEventsList
|
|
@@ -14135,7 +14358,7 @@ Information on muting a security problem.
|
|
|
14135
14358
|
| Name | Type | Description |
|
|
14136
14359
|
| --- | --- | --- |
|
|
14137
14360
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the muting reason. |
|
|
14138
|
-
|reason<sup>*required</sup>|SecurityProblemMuteReason| |
|
|
14361
|
+
|reason<sup>*required</sup>|SecurityProblemMuteReason|The reason for muting a security problem. |
|
|
14139
14362
|
|
|
14140
14363
|
### SecurityProblemUnmute
|
|
14141
14364
|
|
|
@@ -14147,7 +14370,7 @@ Information on un-muting a security problem.
|
|
|
14147
14370
|
| Name | Type | Description |
|
|
14148
14371
|
| --- | --- | --- |
|
|
14149
14372
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the un-muting reason. |
|
|
14150
|
-
|reason<sup>*required</sup>|Affected| |
|
|
14373
|
+
|reason<sup>*required</sup>|Affected|The reason for un-muting a security problem. |
|
|
14151
14374
|
|
|
14152
14375
|
### SecurityProblemsBulkMute
|
|
14153
14376
|
|
|
@@ -14159,7 +14382,7 @@ Information on muting several security problems.
|
|
|
14159
14382
|
| Name | Type | Description |
|
|
14160
14383
|
| --- | --- | --- |
|
|
14161
14384
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the muting reason. |
|
|
14162
|
-
|reason<sup>*required</sup>|SecurityProblemsBulkMuteReason| |
|
|
14385
|
+
|reason<sup>*required</sup>|SecurityProblemsBulkMuteReason|The reason for muting the security problems. |
|
|
14163
14386
|
|securityProblemIds<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The ids of the security problems to be muted. |
|
|
14164
14387
|
|
|
14165
14388
|
### SecurityProblemsBulkMuteResponse
|
|
@@ -14183,7 +14406,7 @@ Information on un-muting several security problems.
|
|
|
14183
14406
|
| Name | Type | Description |
|
|
14184
14407
|
| --- | --- | --- |
|
|
14185
14408
|
|comment|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A comment about the un-muting reason. |
|
|
14186
|
-
|reason<sup>*required</sup>|Affected| |
|
|
14409
|
+
|reason<sup>*required</sup>|Affected|The reason for un-muting the security problems. |
|
|
14187
14410
|
|securityProblemIds<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The ids of the security problems to be un-muted. |
|
|
14188
14411
|
|
|
14189
14412
|
### SecurityProblemsBulkUnmuteResponse
|
|
@@ -14207,8 +14430,8 @@ Analysis of problem impact to a service.
|
|
|
14207
14430
|
| Name | Type | Description |
|
|
14208
14431
|
| --- | --- | --- |
|
|
14209
14432
|
|estimatedAffectedUsers<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated number of affected users. |
|
|
14210
|
-
|impactType<sup>*required</sup>|ImpactImpactType
|
|
14211
|
-
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
14433
|
+
|impactType<sup>*required</sup>|ImpactImpactType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SERVICE</code> -> ServiceImpact</li> <li><code>APPLICATION</code> -> ApplicationImpact</li> <li><code>MOBILE</code> -> MobileImpact</li> <li><code>CUSTOM_APPLICATION</code> -> CustomApplicationImpact</li> </ul> |
|
|
14434
|
+
|impactedEntity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
14212
14435
|
|numberOfPotentiallyAffectedServiceCalls|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of potentially impacted services. |
|
|
14213
14436
|
|
|
14214
14437
|
### SettingsObject
|
|
@@ -14224,11 +14447,12 @@ A settings object.
|
|
|
14224
14447
|
|created|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the creation. |
|
|
14225
14448
|
|createdBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who created the settings object. |
|
|
14226
14449
|
|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The external identifier of the settings object. |
|
|
14227
|
-
|modificationInfo|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>| |
|
|
14450
|
+
|modificationInfo|<a href="#modificationinfo" target="_blank" rel="noopener noreferrer">ModificationInfo</a>|The modification info for a single updatable setting. Replaced by <code>resourceContext</code>. |
|
|
14228
14451
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14229
14452
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14230
14453
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14231
|
-
|
|
|
14454
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
14455
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
14232
14456
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14233
14457
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14234
14458
|
|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>. |
|
|
@@ -14253,7 +14477,8 @@ The response to a get by objectId request.
|
|
|
14253
14477
|
|modified|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification. |
|
|
14254
14478
|
|modifiedBy|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier of the user who performed the most recent modification. |
|
|
14255
14479
|
|objectId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
|
|
14256
|
-
|
|
|
14480
|
+
|owner|<a href="#identity">Identity</a>|An Identity describing either a user, a group, or the all-users group (applying to all users). |
|
|
14481
|
+
|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
|
|
14257
14482
|
|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
|
|
14258
14483
|
|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
|
|
14259
14484
|
|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>. |
|
|
@@ -14317,7 +14542,7 @@ A list of permissions.
|
|
|
14317
14542
|
|
|
14318
14543
|
| Name | Type | Description |
|
|
14319
14544
|
| --- | --- | --- |
|
|
14320
|
-
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>| |
|
|
14545
|
+
|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>|Optional context data |
|
|
14321
14546
|
|permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Permission to be probed |
|
|
14322
14547
|
|
|
14323
14548
|
### SloBurnRate
|
|
@@ -14329,7 +14554,7 @@ Error budget burn rate evaluation of a service-level objective (SLO).
|
|
|
14329
14554
|
|
|
14330
14555
|
| Name | Type | Description |
|
|
14331
14556
|
| --- | --- | --- |
|
|
14332
|
-
|burnRateType|SloBurnRateBurnRateType
|
|
14557
|
+
|burnRateType|SloBurnRateBurnRateType|<p>The calculated burn rate type.</p> <p>Has a value of 'FAST', 'SLOW' or 'NONE'.</p> |
|
|
14333
14558
|
|burnRateValue|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The burn rate of the SLO, calculated for the last hour. |
|
|
14334
14559
|
|burnRateVisualizationEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>The error budget burn rate calculation is enabled (<code>true</code>) or disabled (<code>false</code>).</p> <p>In case of <code>false</code>, no calculated values will be present here.</p> |
|
|
14335
14560
|
|estimatedTimeToConsumeErrorBudget|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The estimated time left to consume the error budget in hours. |
|
|
@@ -14359,8 +14584,8 @@ Error budget burn rate configuration of a service-level objective (SLO).
|
|
|
14359
14584
|
| --- | --- | --- |
|
|
14360
14585
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the SLO. |
|
|
14361
14586
|
|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> |
|
|
14362
|
-
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>| |
|
|
14363
|
-
|evaluationType<sup>*required</sup>|Aggregate| |
|
|
14587
|
+
|errorBudgetBurnRate|<a href="#sloburnrateconfig">SloBurnRateConfig</a>|Error budget burn rate configuration of a service-level objective (SLO). |
|
|
14588
|
+
|evaluationType<sup>*required</sup>|Aggregate|The evaluation type of the SLO. |
|
|
14364
14589
|
|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>. |
|
|
14365
14590
|
|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> |
|
|
14366
14591
|
|metricExpression|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The percentage-based metric expression for the calculation of the SLO. |
|
|
@@ -14398,7 +14623,7 @@ Parameters of a status alert.
|
|
|
14398
14623
|
| --- | --- | --- |
|
|
14399
14624
|
|alertName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Name of the alert. |
|
|
14400
14625
|
|alertThreshold<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value. |
|
|
14401
|
-
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType
|
|
14626
|
+
|alertType<sup>*required</sup>|AbstractSloAlertDtoAlertType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>BURN_RATE</code> -> BurnRateAlert</li> <li><code>STATUS</code> -> StatusAlert</li> </ul> |
|
|
14402
14627
|
|
|
14403
14628
|
### Success
|
|
14404
14629
|
|
|
@@ -14456,8 +14681,8 @@ Configuration of a synthetic location.
|
|
|
14456
14681
|
|longitude<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The longitude of the location in <code>DDD.dddd</code> format. |
|
|
14457
14682
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the location. |
|
|
14458
14683
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
14459
|
-
|status|SyntheticLocationStatus
|
|
14460
|
-
|type<sup>*required</sup>|SyntheticLocationType
|
|
14684
|
+
|status|SyntheticLocationStatus|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
14685
|
+
|type<sup>*required</sup>|SyntheticLocationType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> PublicSyntheticLocation</li> <li><code>PRIVATE</code> -> PrivateSyntheticLocation</li> <li><code>CLUSTER</code> -> PrivateSyntheticLocation</li> </ul> |
|
|
14461
14686
|
|
|
14462
14687
|
### SyntheticLocationIdsDto
|
|
14463
14688
|
|
|
@@ -14478,9 +14703,9 @@ A DTO for synthetic Location IDs.
|
|
|
14478
14703
|
|
|
14479
14704
|
The synthetic location update. This is a base object, the exact type depends on the value of the `type` field.
|
|
14480
14705
|
|
|
14481
|
-
| Name | Type |
|
|
14482
|
-
| --- | --- |
|
|
14483
|
-
|type<sup>*required</sup>|SyntheticLocationUpdateType|
|
|
14706
|
+
| Name | Type | Description |
|
|
14707
|
+
| --- | --- | --- |
|
|
14708
|
+
|type<sup>*required</sup>|SyntheticLocationUpdateType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> SyntheticPublicLocationUpdate</li> <li><code>PRIVATE</code> -> SyntheticPrivateLocationUpdate</li> </ul> |
|
|
14484
14709
|
|
|
14485
14710
|
### SyntheticLocations
|
|
14486
14711
|
|
|
@@ -14528,7 +14753,7 @@ The performance threshold rule.
|
|
|
14528
14753
|
|
|
14529
14754
|
| Name | Type | Description |
|
|
14530
14755
|
| --- | --- | --- |
|
|
14531
|
-
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation| <i>default:</i> <code>"AVG"</code>|
|
|
14756
|
+
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation|Aggregation type <i>default:</i> <code>"AVG"</code>|
|
|
14532
14757
|
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
|
|
14533
14758
|
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
|
|
14534
14759
|
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
|
|
@@ -14570,7 +14795,7 @@ The network availability monitor constraint.
|
|
|
14570
14795
|
|
|
14571
14796
|
| Name | Type | Description |
|
|
14572
14797
|
| --- | --- | --- |
|
|
14573
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>| |
|
|
14798
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorconstraintdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorConstraintDtoProperties</a>|The properties of the constraint. |
|
|
14574
14799
|
|type<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Constraint type. |
|
|
14575
14800
|
|
|
14576
14801
|
### SyntheticMultiProtocolMonitorConstraintDtoProperties
|
|
@@ -14596,9 +14821,9 @@ Network Availability monitor.
|
|
|
14596
14821
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14597
14822
|
|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification |
|
|
14598
14823
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14599
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14824
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
14600
14825
|
|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>| |
|
|
14826
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
14602
14827
|
|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> |
|
|
14603
14828
|
|type<sup>*required</sup>|SyntheticMultiProtocolMonitorDtoType| |
|
|
14604
14829
|
|
|
@@ -14613,9 +14838,9 @@ The step of a network availability monitor.
|
|
|
14613
14838
|
| --- | --- | --- |
|
|
14614
14839
|
|constraints<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolmonitorconstraintdto">SyntheticMultiProtocolMonitorConstraintDto</a>>|The list of constraints which apply to all requests in the step. |
|
|
14615
14840
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name. |
|
|
14616
|
-
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>| |
|
|
14841
|
+
|properties<sup>*required</sup>|<a href="#syntheticmultiprotocolmonitorstepdtoproperties" target="_blank" rel="noopener noreferrer">SyntheticMultiProtocolMonitorStepDtoProperties</a>|The properties which apply to all requests in the step. |
|
|
14617
14842
|
|requestConfigurations<sup>*required</sup>|Array<<a href="#syntheticmultiprotocolrequestconfigurationdto">SyntheticMultiProtocolRequestConfigurationDto</a>>|Request configurations. |
|
|
14618
|
-
|requestType<sup>*required</sup>|SyntheticMultiProtocolMonitorStepDtoRequestType| |
|
|
14843
|
+
|requestType<sup>*required</sup>|SyntheticMultiProtocolMonitorStepDtoRequestType|Request type. |
|
|
14619
14844
|
|targetFilter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Target filter. |
|
|
14620
14845
|
|targetList<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Target list. |
|
|
14621
14846
|
|
|
@@ -14640,11 +14865,11 @@ Network availability monitor.
|
|
|
14640
14865
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14641
14866
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14642
14867
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14643
|
-
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>| |
|
|
14868
|
+
|performanceThresholds|<a href="#syntheticmonitorperformancethresholdsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorPerformanceThresholdsDto</a>|Performance thresholds configuration. |
|
|
14644
14869
|
|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>| |
|
|
14870
|
+
|syntheticMonitorOutageHandlingSettings|<a href="#syntheticmonitoroutagehandlingsettingsdto" target="_blank" rel="noopener noreferrer">SyntheticMonitorOutageHandlingSettingsDto</a>|Outage handling configuration. |
|
|
14646
14871
|
|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> |
|
|
14647
|
-
|type<sup>*required</sup>|MultiProtocol| |
|
|
14872
|
+
|type<sup>*required</sup>|MultiProtocol|Monitor type. |
|
|
14648
14873
|
|
|
14649
14874
|
### SyntheticMultiProtocolRequestConfigurationDto
|
|
14650
14875
|
|
|
@@ -14667,13 +14892,13 @@ Contains information about on-demand executions triggered within the batch.
|
|
|
14667
14892
|
| Name | Type | Description |
|
|
14668
14893
|
| --- | --- | --- |
|
|
14669
14894
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the batch. |
|
|
14670
|
-
|batchStatus<sup>*required</sup>|SyntheticOnDemandBatchStatusBatchStatus| |
|
|
14895
|
+
|batchStatus<sup>*required</sup>|SyntheticOnDemandBatchStatusBatchStatus|The status of the batch. |
|
|
14671
14896
|
|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. |
|
|
14672
14897
|
|failedCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions with the result FAILED. |
|
|
14673
14898
|
|failedExecutions|Array<<a href="#syntheticondemandfailedexecutionstatus">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14674
14899
|
|failedToExecute|Array<<a href="#syntheticondemandfailedexecutionstatus" target="_blank" rel="noopener noreferrer">SyntheticOnDemandFailedExecutionStatus</a>>| |
|
|
14675
14900
|
|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. |
|
|
14676
|
-
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>| |
|
|
14901
|
+
|metadata|<a href="#syntheticondemandbatchstatusmetadata">SyntheticOnDemandBatchStatusMetadata</a>|String to string map of metadata properties for batch |
|
|
14677
14902
|
|triggeredCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of triggered executions within the batch. |
|
|
14678
14903
|
|triggeringProblems|Array<<a href="#syntheticondemandtriggeringproblemdetails" target="_blank" rel="noopener noreferrer">SyntheticOnDemandTriggeringProblemDetails</a>>| |
|
|
14679
14904
|
|triggeringProblemsCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of executions that were not triggered due to some problems. |
|
|
@@ -14696,20 +14921,20 @@ Describes the status of an on-demand execution.
|
|
|
14696
14921
|
| Name | Type | Description |
|
|
14697
14922
|
| --- | --- | --- |
|
|
14698
14923
|
|batchId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the batch. |
|
|
14699
|
-
|customizedScript|ObjectNode| |
|
|
14924
|
+
|customizedScript|ObjectNode|Customized script properties for this on-demand batch execution. |
|
|
14700
14925
|
|dataDeliveryTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when whole data set has been collected on server, in UTC milliseconds. |
|
|
14701
14926
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
14702
|
-
|executionStage<sup>*required</sup>|SyntheticOnDemandExecutionExecutionStage| |
|
|
14927
|
+
|executionStage<sup>*required</sup>|SyntheticOnDemandExecutionExecutionStage|Execution stage. |
|
|
14703
14928
|
|executionTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
14704
|
-
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>| |
|
|
14929
|
+
|fullResults|<a href="#executionfullresults">ExecutionFullResults</a>|Contains extended monitor's execution details. |
|
|
14705
14930
|
|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. |
|
|
14706
|
-
|metadata|<a href="#syntheticondemandexecutionmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionMetadata</a>| |
|
|
14931
|
+
|metadata|<a href="#syntheticondemandexecutionmetadata" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionMetadata</a>|Metadata map for the execution batch. |
|
|
14707
14932
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the monitor. |
|
|
14708
14933
|
|nextExecutionId|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Next execution id for sequential mode. |
|
|
14709
|
-
|processingMode<sup>*required</sup>|SyntheticOnDemandExecutionProcessingMode| |
|
|
14934
|
+
|processingMode<sup>*required</sup>|SyntheticOnDemandExecutionProcessingMode|The processing mode of the execution. |
|
|
14710
14935
|
|schedulingTimestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The scheduling timestamp, in UTC milliseconds. |
|
|
14711
|
-
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>| |
|
|
14712
|
-
|source<sup>*required</sup>|SyntheticOnDemandExecutionSource| |
|
|
14936
|
+
|simpleResults|<a href="#executionsimpleresults">ExecutionSimpleResults</a>|Contains basic results of the monitor's on-demand execution. |
|
|
14937
|
+
|source<sup>*required</sup>|SyntheticOnDemandExecutionSource|The source of the triggering request. |
|
|
14713
14938
|
|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. |
|
|
14714
14939
|
|
|
14715
14940
|
### SyntheticOnDemandExecutionMetadata
|
|
@@ -14730,10 +14955,10 @@ Contains parameters for the on-demand execution of monitors identified by tags,
|
|
|
14730
14955
|
| --- | --- | --- |
|
|
14731
14956
|
|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>|
|
|
14732
14957
|
|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>|
|
|
14733
|
-
|group|<a href="#syntheticondemandexecutionrequestgroup" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestGroup</a>| |
|
|
14734
|
-
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>| |
|
|
14958
|
+
|group|<a href="#syntheticondemandexecutionrequestgroup" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestGroup</a>|Contains parameters for the on-demand execution of monitors identified by tags, applications, or services. |
|
|
14959
|
+
|metadata|<a href="#syntheticondemandexecutionrequestmetadata">SyntheticOnDemandExecutionRequestMetadata</a>|String to string map of metadata properties for execution |
|
|
14735
14960
|
|monitors|Array<<a href="#syntheticondemandexecutionrequestmonitor" target="_blank" rel="noopener noreferrer">SyntheticOnDemandExecutionRequestMonitor</a>>|List of monitors to be triggered. |
|
|
14736
|
-
|processingMode|SyntheticOnDemandExecutionRequestProcessingMode| <i>default:</i> <code>"STANDARD"</code>|
|
|
14961
|
+
|processingMode|SyntheticOnDemandExecutionRequestProcessingMode|The execution's processing mode <i>default:</i> <code>"STANDARD"</code>|
|
|
14737
14962
|
|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>|
|
|
14738
14963
|
|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>|
|
|
14739
14964
|
|
|
@@ -14767,11 +14992,11 @@ Contains monitors to be executed on demand from the locations specified.
|
|
|
14767
14992
|
|
|
14768
14993
|
| Name | Type | Description |
|
|
14769
14994
|
| --- | --- | --- |
|
|
14770
|
-
|customizedScript|SyntheticOnDemandExecutionRequestMonitorCustomizedScript| |
|
|
14995
|
+
|customizedScript|SyntheticOnDemandExecutionRequestMonitorCustomizedScript|Customized script properties for this on-demand batch execution. |
|
|
14771
14996
|
|executionCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of times the monitor is to be executed per location; if not set, the monitor will be executed once. <i>default:</i> <code>1</code>|
|
|
14772
14997
|
|locations|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations from where the monitor is to be executed. |
|
|
14773
14998
|
|monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The monitor identifier. |
|
|
14774
|
-
|repeatMode|SyntheticOnDemandExecutionRequestMonitorRepeatMode| <i>default:</i> <code>"SEQUENTIAL"</code>|
|
|
14999
|
+
|repeatMode|SyntheticOnDemandExecutionRequestMonitorRepeatMode|Execution repeat mode. If not set, the mode is SEQUENTIAL. <i>default:</i> <code>"SEQUENTIAL"</code>|
|
|
14775
15000
|
|
|
14776
15001
|
### SyntheticOnDemandExecutionResult
|
|
14777
15002
|
|
|
@@ -14810,7 +15035,7 @@ Contains information about on-demand executions that failed or failed to be exec
|
|
|
14810
15035
|
| --- | --- | --- |
|
|
14811
15036
|
|errorCode<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Error code. |
|
|
14812
15037
|
|executionId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the execution. |
|
|
14813
|
-
|executionStage|SyntheticOnDemandFailedExecutionStatusExecutionStage| |
|
|
15038
|
+
|executionStage|SyntheticOnDemandFailedExecutionStatusExecutionStage|Execution stage. |
|
|
14814
15039
|
|executionTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp when execution was finished, in UTC milliseconds. |
|
|
14815
15040
|
|failureMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Failure message. |
|
|
14816
15041
|
|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. |
|
|
@@ -14879,7 +15104,7 @@ Configuration of a private synthetic location
|
|
|
14879
15104
|
|nodes|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>A list of synthetic nodes belonging to the location.</p> <p>You can retrieve the list of available nodes with the <a href="https://dt-url.net/miy3rpl" target="_blank" rel="noopener noreferrer" >GET all nodes</a> call.</p> |
|
|
14880
15105
|
|regionCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The region code of the location.</p> <p>To fetch the list of available region codes, use the <a href="https://dt-url.net/az230x0" target="_blank" rel="noopener noreferrer" >GET regions of the country</a> request.</p> |
|
|
14881
15106
|
|status|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
14882
|
-
|type<sup>*required</sup>|SyntheticLocationUpdateType
|
|
15107
|
+
|type<sup>*required</sup>|SyntheticLocationUpdateType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> SyntheticPublicLocationUpdate</li> <li><code>PRIVATE</code> -> SyntheticPrivateLocationUpdate</li> </ul> |
|
|
14883
15108
|
|useNewKubernetesVersion|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Boolean value describes which kubernetes version will be used:</p> <ul> <li><code>false</code>: Version 1.23+ that is older than 1.26</li> <li><code>true</code>: Version 1.26+.</li> </ul> |
|
|
14884
15109
|
|
|
14885
15110
|
### SyntheticPublicLocationUpdate
|
|
@@ -14892,7 +15117,7 @@ The update of a public Synthetic location.
|
|
|
14892
15117
|
| Name | Type | Description |
|
|
14893
15118
|
| --- | --- | --- |
|
|
14894
15119
|
|status|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The status of the location:</p> <ul> <li><code>ENABLED</code>: The location is displayed as active in the UI. You can assign monitors to the location.</li> <li><code>DISABLED</code>: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.</li> <li><code>HIDDEN</code>: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as <code>HIDDEN</code> when no monitor is assigned to it.</li> </ul> |
|
|
14895
|
-
|type<sup>*required</sup>|SyntheticLocationUpdateType
|
|
15120
|
+
|type<sup>*required</sup>|SyntheticLocationUpdateType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>PUBLIC</code> -> SyntheticPublicLocationUpdate</li> <li><code>PRIVATE</code> -> SyntheticPrivateLocationUpdate</li> </ul> |
|
|
14896
15121
|
|
|
14897
15122
|
### SyntheticPublicLocationsStatus
|
|
14898
15123
|
|
|
@@ -14916,7 +15141,7 @@ The tag with source of a monitored entity.
|
|
|
14916
15141
|
| --- | --- | --- |
|
|
14917
15142
|
|context|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The origin of the tag, such as AWS or Cloud Foundry.</p> <p>Custom tags use the <code>CONTEXTLESS</code> value.</p> |
|
|
14918
15143
|
|key<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the tag. |
|
|
14919
|
-
|source|SyntheticTagWithSourceDtoSource| |
|
|
15144
|
+
|source|SyntheticTagWithSourceDtoSource|The source of the tag, such as USER, RULE_BASED or AUTO. |
|
|
14920
15145
|
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the tag. |
|
|
14921
15146
|
|
|
14922
15147
|
### TableColumn
|
|
@@ -14948,10 +15173,10 @@ Tenant token
|
|
|
14948
15173
|
|
|
14949
15174
|
Configuration of a [tenant token](https://dt-url.net/b403ss9).
|
|
14950
15175
|
|
|
14951
|
-
| Name | Type |
|
|
14952
|
-
| --- | --- |
|
|
14953
|
-
|active|<a href="#tenanttoken">TenantToken</a>|
|
|
14954
|
-
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|
|
|
15176
|
+
| Name | Type | Description |
|
|
15177
|
+
| --- | --- | --- |
|
|
15178
|
+
|active|<a href="#tenanttoken">TenantToken</a>|Tenant token |
|
|
15179
|
+
|old|<a href="#tenanttoken" target="_blank" rel="noopener noreferrer">TenantToken</a>|Tenant token |
|
|
14955
15180
|
|
|
14956
15181
|
### ToPosition
|
|
14957
15182
|
|
|
@@ -14977,14 +15202,14 @@ A credentials set of the `TOKEN` type.
|
|
|
14977
15202
|
|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). |
|
|
14978
15203
|
|allowedEntities|Array<<a href="#credentialaccessdata">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
14979
15204
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
14980
|
-
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>| |
|
|
15205
|
+
|externalVault|<a href="#externalvault" target="_blank" rel="noopener noreferrer">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
14981
15206
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
14982
15207
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
14983
15208
|
|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>). |
|
|
14984
|
-
|scope|CredentialsScope| |
|
|
15209
|
+
|scope|CredentialsScope|The scope of the credentials set. |
|
|
14985
15210
|
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
14986
15211
|
|token|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Token in the string format. |
|
|
14987
|
-
|type|CredentialsType
|
|
15212
|
+
|type|CredentialsType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> </ul> |
|
|
14988
15213
|
|
|
14989
15214
|
### TrackingLink
|
|
14990
15215
|
|
|
@@ -15025,9 +15250,9 @@ A behavior of a metric in an transaction that indicates the problem and/or is it
|
|
|
15025
15250
|
| --- | --- | --- |
|
|
15026
15251
|
|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the evidence. |
|
|
15027
15252
|
|endTime|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The end time of the evidence, in UTC milliseconds |
|
|
15028
|
-
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>| |
|
|
15029
|
-
|evidenceType<sup>*required</sup>|EvidenceEvidenceType
|
|
15030
|
-
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>| |
|
|
15253
|
+
|entity<sup>*required</sup>|<a href="#entitystub">EntityStub</a>|A short representation of a monitored entity. |
|
|
15254
|
+
|evidenceType<sup>*required</sup>|EvidenceEvidenceType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>EVENT</code> -> EventEvidence</li> <li><code>METRIC</code> -> MetricEvidence</li> <li><code>TRANSACTIONAL</code> -> TransactionalEvidence</li> <li><code>MAINTENANCE_WINDOW</code> -> MaintenanceWindowEvidence</li> <li><code>AVAILABILITY_EVIDENCE</code> -> AvailabilityEvidence</li> </ul> |
|
|
15255
|
+
|groupingEntity|<a href="#entitystub" target="_blank" rel="noopener noreferrer">EntityStub</a>|A short representation of a monitored entity. |
|
|
15031
15256
|
|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. |
|
|
15032
15257
|
|startTime<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The start time of the evidence, in UTC milliseconds. |
|
|
15033
15258
|
|unit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unit of the metric. |
|
|
@@ -15043,7 +15268,7 @@ A list of values that has possibly been truncated.
|
|
|
15043
15268
|
|
|
15044
15269
|
| Name | Type | Description |
|
|
15045
15270
|
| --- | --- | --- |
|
|
15046
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
15271
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
15047
15272
|
|values|Array<<a href="#attackrequestheader" target="_blank" rel="noopener noreferrer">AttackRequestHeader</a>>|Values of the list. |
|
|
15048
15273
|
|
|
15049
15274
|
### TruncatableListHttpRequestParameter
|
|
@@ -15055,7 +15280,7 @@ A list of values that has possibly been truncated.
|
|
|
15055
15280
|
|
|
15056
15281
|
| Name | Type | Description |
|
|
15057
15282
|
| --- | --- | --- |
|
|
15058
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
15283
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
15059
15284
|
|values|Array<<a href="#httprequestparameter" target="_blank" rel="noopener noreferrer">HttpRequestParameter</a>>|Values of the list. |
|
|
15060
15285
|
|
|
15061
15286
|
### TruncatableListString
|
|
@@ -15067,7 +15292,7 @@ A list of values that has possibly been truncated.
|
|
|
15067
15292
|
|
|
15068
15293
|
| Name | Type | Description |
|
|
15069
15294
|
| --- | --- | --- |
|
|
15070
|
-
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>| |
|
|
15295
|
+
|truncationInfo|<a href="#truncationinfo">TruncationInfo</a>|Information on a possible truncation. |
|
|
15071
15296
|
|values|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Values of the list. |
|
|
15072
15297
|
|
|
15073
15298
|
### TruncationInfo
|
|
@@ -15113,12 +15338,12 @@ UI customization options for defining custom callbacks
|
|
|
15113
15338
|
|
|
15114
15339
|
Customization for UI elements
|
|
15115
15340
|
|
|
15116
|
-
| Name | Type |
|
|
15117
|
-
| --- | --- |
|
|
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>|
|
|
15341
|
+
| Name | Type | Description |
|
|
15342
|
+
| --- | --- | --- |
|
|
15343
|
+
|callback|<a href="#uicallbackcustomization" target="_blank" rel="noopener noreferrer">UiCallbackCustomization</a>|UI customization options for defining custom callbacks |
|
|
15344
|
+
|expandable|<a href="#uiexpandablecustomization">UiExpandableCustomization</a>|UI customization for expandable section |
|
|
15345
|
+
|table|<a href="#uitablecustomization" target="_blank" rel="noopener noreferrer">UiTableCustomization</a>|Customization for UI tables |
|
|
15346
|
+
|tabs|<a href="#uitabscustomization">UiTabsCustomization</a>|UI customization for tabs |
|
|
15122
15347
|
|
|
15123
15348
|
### UiEmptyStateCustomization
|
|
15124
15349
|
|
|
@@ -15212,7 +15437,7 @@ Customization for UI tables
|
|
|
15212
15437
|
| Name | Type | Description |
|
|
15213
15438
|
| --- | --- | --- |
|
|
15214
15439
|
|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>| |
|
|
15440
|
+
|emptyState|<a href="#uiemptystatecustomization">UiEmptyStateCustomization</a>|UI customization for empty state in a table |
|
|
15216
15441
|
|
|
15217
15442
|
### UiTabsCustomization
|
|
15218
15443
|
|
|
@@ -15273,18 +15498,18 @@ Configuration of the ActiveGate update job.
|
|
|
15273
15498
|
|
|
15274
15499
|
| Name | Type | Description |
|
|
15275
15500
|
| --- | --- | --- |
|
|
15276
|
-
|agType|UpdateJobAgType| |
|
|
15501
|
+
|agType|UpdateJobAgType|The type of the ActiveGate. |
|
|
15277
15502
|
|cancelable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The job can (<code>true</code>) or can't (<code>false</code>) be cancelled at the moment. |
|
|
15278
15503
|
|duration|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The duration of the update, in milliseconds. |
|
|
15279
15504
|
|environments|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|A list of environments (specified by IDs) the ActiveGate can connect to. |
|
|
15280
15505
|
|error|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The information about update error. |
|
|
15281
15506
|
|jobId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the update job. |
|
|
15282
|
-
|jobState|UpdateJobJobState| |
|
|
15507
|
+
|jobState|UpdateJobJobState|The status of the update job. |
|
|
15283
15508
|
|startVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The initial version of the ActiveGate. |
|
|
15284
15509
|
|targetVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The target version of the update.</p> <p>Specify the version in the <code><major>.<minor>.<revision>.<timestamp></code> format.</p> <p>To update to the latest available version, use the <code>latest</code> value.</p> |
|
|
15285
15510
|
|timestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The timestamp of the update job completion.</p> <p>The <code>null</code> value means the job is still running.</p> |
|
|
15286
|
-
|updateMethod|UpdateJobUpdateMethod| |
|
|
15287
|
-
|updateType|UpdateJobUpdateType| |
|
|
15511
|
+
|updateMethod|UpdateJobUpdateMethod|The method of updating the ActiveGate or its component. |
|
|
15512
|
+
|updateType|UpdateJobUpdateType|The component to be updated. |
|
|
15288
15513
|
|
|
15289
15514
|
### UpdateJobList
|
|
15290
15515
|
|
|
@@ -15321,14 +15546,14 @@ A credentials set of the `USERNAME_PASSWORD` type.
|
|
|
15321
15546
|
|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). |
|
|
15322
15547
|
|allowedEntities|Array<<a href="#credentialaccessdata" target="_blank" rel="noopener noreferrer">CredentialAccessData</a>>|The set of entities allowed to use the credential. |
|
|
15323
15548
|
|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the credentials set. |
|
|
15324
|
-
|externalVault|<a href="#externalvault">ExternalVault</a>| |
|
|
15549
|
+
|externalVault|<a href="#externalvault">ExternalVault</a>|Information for synchronization credentials with external vault |
|
|
15325
15550
|
|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the credentials set. |
|
|
15326
15551
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the credentials set. |
|
|
15327
15552
|
|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>). |
|
|
15328
15553
|
|password|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The password of the credential. |
|
|
15329
|
-
|scope|CredentialsScope| |
|
|
15554
|
+
|scope|CredentialsScope|The scope of the credentials set. |
|
|
15330
15555
|
|scopes<sup>*required</sup>|Array<CredentialsScopesItem>|<p>The set of scopes of the credentials set.</p> <p>Limitations: <code>CredentialsScope.APP_ENGINE</code> is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.</p> |
|
|
15331
|
-
|type|CredentialsType
|
|
15556
|
+
|type|CredentialsType|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>CERTIFICATE</code> -> CertificateCredentials</li> <li><code>PUBLIC_CERTIFICATE</code> -> PublicCertificateCredentials</li> <li><code>USERNAME_PASSWORD</code> -> UserPasswordCredentials</li> <li><code>TOKEN</code> -> TokenCredentials</li> </ul> |
|
|
15332
15557
|
|user|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The username of the credentials set. |
|
|
15333
15558
|
|
|
15334
15559
|
### ValidationResponse
|
|
@@ -15354,11 +15579,11 @@ Describes the exploited vulnerability.
|
|
|
15354
15579
|
|
|
15355
15580
|
| Name | Type | Description |
|
|
15356
15581
|
| --- | --- | --- |
|
|
15357
|
-
|codeLocation|<a href="#codelocation" target="_blank" rel="noopener noreferrer">CodeLocation</a>| |
|
|
15582
|
+
|codeLocation|<a href="#codelocation" target="_blank" rel="noopener noreferrer">CodeLocation</a>|Information about a code location. |
|
|
15358
15583
|
|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the vulnerability. |
|
|
15359
15584
|
|vulnerabilityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the vulnerability. |
|
|
15360
|
-
|vulnerableFunction|<a href="#functiondefinition">FunctionDefinition</a>| |
|
|
15361
|
-
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>| |
|
|
15585
|
+
|vulnerableFunction|<a href="#functiondefinition">FunctionDefinition</a>|Information about a function definition. |
|
|
15586
|
+
|vulnerableFunctionInput|<a href="#vulnerablefunctioninput" target="_blank" rel="noopener noreferrer">VulnerableFunctionInput</a>|Describes what got passed into the code level vulnerability. |
|
|
15362
15587
|
|
|
15363
15588
|
### VulnerableComponent
|
|
15364
15589
|
|
|
@@ -15399,7 +15624,7 @@ Describes what got passed into the code level vulnerability.
|
|
|
15399
15624
|
| Name | Type | Description |
|
|
15400
15625
|
| --- | --- | --- |
|
|
15401
15626
|
|inputSegments|Array<<a href="#vulnerablefunctioninputsegment">VulnerableFunctionInputSegment</a>>|A list of input segments. |
|
|
15402
|
-
|type|VulnerableFunctionInputType| |
|
|
15627
|
+
|type|VulnerableFunctionInputType|The type of the input. |
|
|
15403
15628
|
|
|
15404
15629
|
### VulnerableFunctionInputSegment
|
|
15405
15630
|
|
|
@@ -15410,7 +15635,7 @@ Describes one segment that was passed into a vulnerable function.
|
|
|
15410
15635
|
|
|
15411
15636
|
| Name | Type | Description |
|
|
15412
15637
|
| --- | --- | --- |
|
|
15413
|
-
|type|VulnerableFunctionInputSegmentType| |
|
|
15638
|
+
|type|VulnerableFunctionInputSegmentType|The type of the input segment. |
|
|
15414
15639
|
|value|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value of the input segment. |
|
|
15415
15640
|
|
|
15416
15641
|
### VulnerableFunctionProcessGroups
|
|
@@ -15422,11 +15647,11 @@ A vulnerable function including its usage by specific process groups in context
|
|
|
15422
15647
|
|
|
15423
15648
|
| Name | Type | Description |
|
|
15424
15649
|
| --- | --- | --- |
|
|
15425
|
-
|function|<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>| |
|
|
15650
|
+
|function|<a href="#vulnerablefunction" target="_blank" rel="noopener noreferrer">VulnerableFunction</a>|Defines an vulnerable function. |
|
|
15426
15651
|
|processGroupsInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is in use. |
|
|
15427
15652
|
|processGroupsNotAvailable|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where information about the usage of this function not available. |
|
|
15428
15653
|
|processGroupsNotInUse|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The process group identifiers, where this vulnerable function is not in use. |
|
|
15429
|
-
|usage|VulnerableFunctionProcessGroupsUsage
|
|
15654
|
+
|usage|VulnerableFunctionProcessGroupsUsage|<p>The vulnerable function usage based on the given process groups:</p> <ul> <li>IN_USE if at least one process group calls this vulnerable function.</li> <li>NOT_IN_USE if all process groups do not call this vulnerable function.</li> <li>NOT_AVAILABLE if vulnerable function usage could not be calculated for at least one process group and no process group calls this vulnerable function.</li> </ul> |
|
|
15430
15655
|
|
|
15431
15656
|
### VulnerableFunctionsContainer
|
|
15432
15657
|
|
|
@@ -16156,7 +16381,7 @@ The type of the credentials set.
|
|
|
16156
16381
|
|
|
16157
16382
|
<div class="padding-left--md">
|
|
16158
16383
|
|
|
16159
|
-
`Certificate` | `PublicCertificate` | `Token` | `Unknown` | `UsernamePassword`
|
|
16384
|
+
`Certificate` | `PublicCertificate` | `Snmpv3` | `Token` | `Unknown` | `UsernamePassword`
|
|
16160
16385
|
|
|
16161
16386
|
</div>
|
|
16162
16387
|
|
|
@@ -17124,6 +17349,24 @@ Type of this filter, determines which other fields are present.Can be any of:
|
|
|
17124
17349
|
</div>
|
|
17125
17350
|
|
|
17126
17351
|
|
|
17352
|
+
</div>
|
|
17353
|
+
|
|
17354
|
+
<a name="identitytype"></a>
|
|
17355
|
+
### IdentityType
|
|
17356
|
+
|
|
17357
|
+
<div class="padding-left--md">
|
|
17358
|
+
|
|
17359
|
+
The type of the identity.
|
|
17360
|
+
|
|
17361
|
+
#### Enum keys
|
|
17362
|
+
|
|
17363
|
+
<div class="padding-left--md">
|
|
17364
|
+
|
|
17365
|
+
`AllUsers` | `Group` | `User`
|
|
17366
|
+
|
|
17367
|
+
</div>
|
|
17368
|
+
|
|
17369
|
+
|
|
17127
17370
|
</div>
|
|
17128
17371
|
|
|
17129
17372
|
<a name="impactimpacttype"></a>
|
|
@@ -17160,7 +17403,7 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
17160
17403
|
|
|
17161
17404
|
<div class="padding-left--md">
|
|
17162
17405
|
|
|
17163
|
-
`Certificate` | `Token` | `UsernamePassword`
|
|
17406
|
+
`Certificate` | `Snmpv3` | `Token` | `UsernamePassword`
|
|
17164
17407
|
|
|
17165
17408
|
</div>
|
|
17166
17409
|
|