@dynatrace-sdk/client-classic-environment-v2 1.12.0 → 1.13.1
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 +16 -5
- package/README.md +950 -700
- package/cjs/index.js +3555 -648
- package/docs/DOCS.md +273 -209
- package/esm/index.js +3555 -648
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-scope.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/abstract-slo-alert-dto-alert-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-config-effective-setting.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-config-setting.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-global-auto-update-config-global-setting.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-architecture.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-bitness.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-os-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-active-gate-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create-active-gate-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/any-value.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/any-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-additional-metadata.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-attack-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-data-assets.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/attack-technology.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-event-type.d.ts +11 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-event-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-user-type.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-user-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint-violation-parameter-location.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/create-alert-query-time-frame.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credential-access-data-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scope.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-scopes-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scope.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-scopes-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition-reset-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice-advice-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice-technology.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entry-point-usage-segment-segment-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entry-point-usage-segment-source-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-type-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-event-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-result-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type-severity-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/evidence-evidence-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-step-monitor-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-event-dto-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-status-dto-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-source-auth-method.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-source-auth-method.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/filter-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-auto-update.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-disabled-module-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-enabled-module-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-os-architecture.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-os-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-token-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-update-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-active-gates-query-version-compare-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-update-job-list-query-start-version-compare-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-update-job-list-query-target-version-compare-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-all-update-job-list-query-update-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-environment-configuration-events-query-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-execution-result-path-result-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-executions-query-execution-stage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-executions-query-source.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-extension-monitoring-configuration-events-query-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-host-stats-query-filter.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-cloud-platform.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-slo-by-id-query-time-frame.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-slo-query-enabled-slos.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-slo-query-evaluate.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-slo-query-time-frame.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-update-job-list-by-ag-id-query-start-version-compare-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-update-job-list-by-ag-id-query-target-version-compare-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/get-update-job-list-by-ag-id-query-update-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/impact-impact-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/ingest-body.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/json-node.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/json-node.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element-cloud-platform.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element-stage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +2 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-plain.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record-event-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor-aggregation-types-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor-transformations-item.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor-unit-display-format.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-definition-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-value-type-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-severity.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/mute-state-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone-fallback-mode.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/object-node.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/problem-impact-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/problem-severity-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/problem-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition-modification-policy.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/related-service-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-assessment-accuracy.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-data-assets.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item-vulnerability-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-change-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-vulnerability-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-assessment-accuracy.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-base-risk-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes-previous-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes-previous-public-exploit.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes-previous-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-data-assets.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-assessment-accuracy.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-base-risk-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-data-assets.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-public-exploit.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-risk-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-public-exploit.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-risk-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot-exposure.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot-public-exploit.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot-risk-level.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-vulnerable-function-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/rollup-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-technology.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details-vulnerability-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-technology.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-vulnerability-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-reason.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate-burn-rate-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl-evaluation-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-evaluation-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location-update-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto-aggregation.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto-aggregation.transformation.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.transformation.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-thresholds-dto.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-thresholds-dto.transformation.d.ts +8 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-summary-dto-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto-request-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-batch-status-batch-status.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-execution-stage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-processing-mode.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-customized-script.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor-repeat-mode.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-processing-mode.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-source.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto-source.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job-ag-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job-job-state.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job-update-method.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job-update-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups-usage.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/utils/url-helpers.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/abort-controller.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/abort-signal.d.ts +1 -1
- package/types/packages/http-client/src/lib/platform/decode-form-data.d.ts +48 -0
- package/types/packages/http-client/src/lib/platform/http-client.d.ts +19 -0
- package/types/packages/http-client/src/lib/types/data-types.d.ts +1 -1
- package/types/packages/http-client/src/lib/types/form-data-request-body.d.ts +2 -2
- package/types/packages/http-client/src/lib/types/form-data-response-body.d.ts +2 -2
- package/types/packages/http-client/src/lib/types/request-body-types.d.ts +1 -1
- package/types/packages/http-client/src/lib/types/response-body-types.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts +1 -1
- package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +1 -1
package/docs/DOCS.md
CHANGED
|
@@ -12,7 +12,7 @@ If you miss a resource, consider using the Dynatrace Environment API v1.
|
|
|
12
12
|
|
|
13
13
|
To read about use cases and examples, see [Dynatrace Documentation](https://dt-url.net/2u23k1k).
|
|
14
14
|
|
|
15
|
-
To authorize, use a valid access token or personal access token
|
|
15
|
+
To authorize, use a valid access token or personal access token. For usage in a Dynatrace app, refer to the [Dynatrace Developer documentation](https://dt-url.net/tb23plz).
|
|
16
16
|
|
|
17
17
|
Notes about compatibility:
|
|
18
18
|
* Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
|
|
@@ -25,7 +25,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
|
|
|
25
25
|
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2" target="_blank" rel="noopener noreferrer"> <span class="margin-right--xs">@dynatrace-sdk/client-classic-environment-v2</span> <img className="no-zoom" width="20px" src={NpmLogo} /> </a>
|
|
26
26
|
</div>
|
|
27
27
|
<div class="col" style={{textAlign: 'right'}}>
|
|
28
|
-
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.
|
|
28
|
+
<a href="https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.13.1" target="_blank" rel="noopener noreferrer">v1.13.1</a>
|
|
29
29
|
</div>
|
|
30
30
|
</div>
|
|
31
31
|
|
|
@@ -40,6 +40,7 @@ import { accessTokensActiveGateTokensClient } from '@dynatrace-sdk/client-classi
|
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
|
|
43
|
+
|
|
43
44
|
### createToken
|
|
44
45
|
|
|
45
46
|
<div class="padding-bottom--md">
|
|
@@ -80,7 +81,6 @@ Success. The token has been created. The body of the response contains the token
|
|
|
80
81
|
<details>
|
|
81
82
|
<summary>
|
|
82
83
|
Code example
|
|
83
|
-
|
|
84
84
|
</summary>
|
|
85
85
|
|
|
86
86
|
```ts
|
|
@@ -99,6 +99,7 @@ const data =
|
|
|
99
99
|
</div>
|
|
100
100
|
|
|
101
101
|
|
|
102
|
+
|
|
102
103
|
### getToken
|
|
103
104
|
|
|
104
105
|
<div class="padding-bottom--md">
|
|
@@ -135,7 +136,6 @@ Success. The response contains the metadata of the tokens.
|
|
|
135
136
|
<details>
|
|
136
137
|
<summary>
|
|
137
138
|
Code example
|
|
138
|
-
|
|
139
139
|
</summary>
|
|
140
140
|
|
|
141
141
|
```ts
|
|
@@ -154,6 +154,7 @@ const data =
|
|
|
154
154
|
</div>
|
|
155
155
|
|
|
156
156
|
|
|
157
|
+
|
|
157
158
|
### listTokens
|
|
158
159
|
|
|
159
160
|
<div class="padding-bottom--md">
|
|
@@ -193,7 +194,6 @@ Success. The response contains the list of ActiveGate tokens.
|
|
|
193
194
|
<details>
|
|
194
195
|
<summary>
|
|
195
196
|
Code example
|
|
196
|
-
|
|
197
197
|
</summary>
|
|
198
198
|
|
|
199
199
|
```ts
|
|
@@ -210,6 +210,7 @@ const data =
|
|
|
210
210
|
</div>
|
|
211
211
|
|
|
212
212
|
|
|
213
|
+
|
|
213
214
|
### revokeToken
|
|
214
215
|
|
|
215
216
|
<div class="padding-bottom--md">
|
|
@@ -240,7 +241,6 @@ Deletes an ActiveGate token
|
|
|
240
241
|
<details>
|
|
241
242
|
<summary>
|
|
242
243
|
Code example
|
|
243
|
-
|
|
244
244
|
</summary>
|
|
245
245
|
|
|
246
246
|
```ts
|
|
@@ -265,6 +265,7 @@ import { accessTokensApiTokensClient } from '@dynatrace-sdk/client-classic-envir
|
|
|
265
265
|
```
|
|
266
266
|
|
|
267
267
|
|
|
268
|
+
|
|
268
269
|
### createApiToken
|
|
269
270
|
|
|
270
271
|
<div class="padding-bottom--md">
|
|
@@ -303,7 +304,6 @@ Success. The token has been created. The body of the response contains the token
|
|
|
303
304
|
<details>
|
|
304
305
|
<summary>
|
|
305
306
|
Code example
|
|
306
|
-
|
|
307
307
|
</summary>
|
|
308
308
|
|
|
309
309
|
```ts
|
|
@@ -322,6 +322,7 @@ const data =
|
|
|
322
322
|
</div>
|
|
323
323
|
|
|
324
324
|
|
|
325
|
+
|
|
325
326
|
### deleteApiToken
|
|
326
327
|
|
|
327
328
|
<div class="padding-bottom--md">
|
|
@@ -352,7 +353,6 @@ Deletes an API token
|
|
|
352
353
|
<details>
|
|
353
354
|
<summary>
|
|
354
355
|
Code example
|
|
355
|
-
|
|
356
356
|
</summary>
|
|
357
357
|
|
|
358
358
|
```ts
|
|
@@ -371,6 +371,7 @@ const data =
|
|
|
371
371
|
</div>
|
|
372
372
|
|
|
373
373
|
|
|
374
|
+
|
|
374
375
|
### getApiToken
|
|
375
376
|
|
|
376
377
|
<div class="padding-bottom--md">
|
|
@@ -407,7 +408,6 @@ Success
|
|
|
407
408
|
<details>
|
|
408
409
|
<summary>
|
|
409
410
|
Code example
|
|
410
|
-
|
|
411
411
|
</summary>
|
|
412
412
|
|
|
413
413
|
```ts
|
|
@@ -425,6 +425,7 @@ const data = await accessTokensApiTokensClient.getApiToken({
|
|
|
425
425
|
</div>
|
|
426
426
|
|
|
427
427
|
|
|
428
|
+
|
|
428
429
|
### listApiTokens
|
|
429
430
|
|
|
430
431
|
<div class="padding-bottom--md">
|
|
@@ -455,7 +456,7 @@ You can limit the output by using pagination:
|
|
|
455
456
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters tokens based on the last usage time. The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> |
|
|
456
457
|
|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> |
|
|
457
458
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of API tokens in a single response payload.</p> <p>The maximal allowed page size is 10000 and the minimal allowed page size is 100.</p> <p>If not set, 200 is used.</p> |
|
|
458
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p>
|
|
459
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sort order of the token list.</p> <p>You can sort by the following properties with a sign prefix for the sort order:</p> <ul> <li><code>name</code>: token name (<code>+</code> a...z or <code>-</code> z...a)</li> <li><code>lastUsedDate</code> last used (<code>+</code> never used tokens first <code>-</code> most recently used tokens first)</li> <li><code>creationDate</code> (<code>+</code> oldest tokens first <code>-</code> newest tokens first)</li> <li><code>expirationDate</code> (<code>+</code> tokens that expire soon first <code>-</code> unlimited tokens first)</li> <li><code>modifiedDate</code> last modified (<code>+</code> never modified tokens first <code>-</code> most recently modified tokens first)</li> </ul> <p>If no prefix is set, + is used.</p> <p>If not set, tokens are sorted by creation date with newest first.</p> |
|
|
459
460
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters tokens based on the last usage time. The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
460
461
|
|
|
461
462
|
|
|
@@ -469,7 +470,6 @@ Success
|
|
|
469
470
|
<details>
|
|
470
471
|
<summary>
|
|
471
472
|
Code example
|
|
472
|
-
|
|
473
473
|
</summary>
|
|
474
474
|
|
|
475
475
|
```ts
|
|
@@ -486,6 +486,7 @@ const data =
|
|
|
486
486
|
</div>
|
|
487
487
|
|
|
488
488
|
|
|
489
|
+
|
|
489
490
|
### lookupApiToken
|
|
490
491
|
|
|
491
492
|
<div class="padding-bottom--md">
|
|
@@ -520,7 +521,6 @@ Success
|
|
|
520
521
|
<details>
|
|
521
522
|
<summary>
|
|
522
523
|
Code example
|
|
523
|
-
|
|
524
524
|
</summary>
|
|
525
525
|
|
|
526
526
|
```ts
|
|
@@ -542,6 +542,7 @@ const data =
|
|
|
542
542
|
</div>
|
|
543
543
|
|
|
544
544
|
|
|
545
|
+
|
|
545
546
|
### updateApiToken
|
|
546
547
|
|
|
547
548
|
<div class="padding-bottom--md">
|
|
@@ -573,7 +574,6 @@ Updates an API token
|
|
|
573
574
|
<details>
|
|
574
575
|
<summary>
|
|
575
576
|
Code example
|
|
576
|
-
|
|
577
577
|
</summary>
|
|
578
578
|
|
|
579
579
|
```ts
|
|
@@ -599,6 +599,7 @@ import { accessTokensTenantTokensClient } from '@dynatrace-sdk/client-classic-en
|
|
|
599
599
|
```
|
|
600
600
|
|
|
601
601
|
|
|
602
|
+
|
|
602
603
|
### cancelRotation
|
|
603
604
|
|
|
604
605
|
<div class="padding-bottom--md">
|
|
@@ -627,7 +628,6 @@ Success. Rotation process has been cancelled. The current tenant token remains v
|
|
|
627
628
|
<details>
|
|
628
629
|
<summary>
|
|
629
630
|
Code example
|
|
630
|
-
|
|
631
631
|
</summary>
|
|
632
632
|
|
|
633
633
|
```ts
|
|
@@ -644,6 +644,7 @@ const data =
|
|
|
644
644
|
</div>
|
|
645
645
|
|
|
646
646
|
|
|
647
|
+
|
|
647
648
|
### finishRotation
|
|
648
649
|
|
|
649
650
|
<div class="padding-bottom--md">
|
|
@@ -672,7 +673,6 @@ Success. The rotation process is completed. The **active** field of the response
|
|
|
672
673
|
<details>
|
|
673
674
|
<summary>
|
|
674
675
|
Code example
|
|
675
|
-
|
|
676
676
|
</summary>
|
|
677
677
|
|
|
678
678
|
```ts
|
|
@@ -689,6 +689,7 @@ const data =
|
|
|
689
689
|
</div>
|
|
690
690
|
|
|
691
691
|
|
|
692
|
+
|
|
692
693
|
### startRotation
|
|
693
694
|
|
|
694
695
|
<div class="padding-bottom--md">
|
|
@@ -717,7 +718,6 @@ Success. The new tenant token is created and will replace the old one. The **act
|
|
|
717
718
|
<details>
|
|
718
719
|
<summary>
|
|
719
720
|
Code example
|
|
720
|
-
|
|
721
721
|
</summary>
|
|
722
722
|
|
|
723
723
|
```ts
|
|
@@ -740,6 +740,7 @@ import { activeGatesAutoUpdateConfigurationClient } from '@dynatrace-sdk/client-
|
|
|
740
740
|
```
|
|
741
741
|
|
|
742
742
|
|
|
743
|
+
|
|
743
744
|
### getAutoUpdateConfigById
|
|
744
745
|
|
|
745
746
|
<div class="padding-bottom--md">
|
|
@@ -774,7 +775,6 @@ Success
|
|
|
774
775
|
<details>
|
|
775
776
|
<summary>
|
|
776
777
|
Code example
|
|
777
|
-
|
|
778
778
|
</summary>
|
|
779
779
|
|
|
780
780
|
```ts
|
|
@@ -793,6 +793,7 @@ const data =
|
|
|
793
793
|
</div>
|
|
794
794
|
|
|
795
795
|
|
|
796
|
+
|
|
796
797
|
### getGlobalAutoUpdateConfigForTenant
|
|
797
798
|
|
|
798
799
|
<div class="padding-bottom--md">
|
|
@@ -819,7 +820,6 @@ Success
|
|
|
819
820
|
<details>
|
|
820
821
|
<summary>
|
|
821
822
|
Code example
|
|
822
|
-
|
|
823
823
|
</summary>
|
|
824
824
|
|
|
825
825
|
```ts
|
|
@@ -836,6 +836,7 @@ const data =
|
|
|
836
836
|
</div>
|
|
837
837
|
|
|
838
838
|
|
|
839
|
+
|
|
839
840
|
### putAutoUpdateConfigById
|
|
840
841
|
|
|
841
842
|
<div class="padding-bottom--md">
|
|
@@ -867,7 +868,6 @@ Updates the configuration of auto-update for the specified ActiveGate
|
|
|
867
868
|
<details>
|
|
868
869
|
<summary>
|
|
869
870
|
Code example
|
|
870
|
-
|
|
871
871
|
</summary>
|
|
872
872
|
|
|
873
873
|
```ts
|
|
@@ -886,6 +886,7 @@ const data =
|
|
|
886
886
|
</div>
|
|
887
887
|
|
|
888
888
|
|
|
889
|
+
|
|
889
890
|
### putGlobalAutoUpdateConfigForTenant
|
|
890
891
|
|
|
891
892
|
<div class="padding-bottom--md">
|
|
@@ -916,7 +917,6 @@ Puts the global auto-update configuration of environment ActiveGates.
|
|
|
916
917
|
<details>
|
|
917
918
|
<summary>
|
|
918
919
|
Code example
|
|
919
|
-
|
|
920
920
|
</summary>
|
|
921
921
|
|
|
922
922
|
```ts
|
|
@@ -935,6 +935,7 @@ const data =
|
|
|
935
935
|
</div>
|
|
936
936
|
|
|
937
937
|
|
|
938
|
+
|
|
938
939
|
### validateAutoUpdateConfigById
|
|
939
940
|
|
|
940
941
|
<div class="padding-bottom--md">
|
|
@@ -966,7 +967,6 @@ Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
|
|
|
966
967
|
<details>
|
|
967
968
|
<summary>
|
|
968
969
|
Code example
|
|
969
|
-
|
|
970
970
|
</summary>
|
|
971
971
|
|
|
972
972
|
```ts
|
|
@@ -985,6 +985,7 @@ const data =
|
|
|
985
985
|
</div>
|
|
986
986
|
|
|
987
987
|
|
|
988
|
+
|
|
988
989
|
### validateGlobalAutoUpdateConfigForTenant
|
|
989
990
|
|
|
990
991
|
<div class="padding-bottom--md">
|
|
@@ -1015,7 +1016,6 @@ Validates the payload for the `POST /activeGates/autoUpdate` request.
|
|
|
1015
1016
|
<details>
|
|
1016
1017
|
<summary>
|
|
1017
1018
|
Code example
|
|
1018
|
-
|
|
1019
1019
|
</summary>
|
|
1020
1020
|
|
|
1021
1021
|
```ts
|
|
@@ -1040,6 +1040,7 @@ import { activeGatesAutoUpdateJobsClient } from '@dynatrace-sdk/client-classic-e
|
|
|
1040
1040
|
```
|
|
1041
1041
|
|
|
1042
1042
|
|
|
1043
|
+
|
|
1043
1044
|
### createUpdateJobForAg
|
|
1044
1045
|
|
|
1045
1046
|
<div class="padding-bottom--md">
|
|
@@ -1075,7 +1076,6 @@ Success. The update-job have been created.
|
|
|
1075
1076
|
<details>
|
|
1076
1077
|
<summary>
|
|
1077
1078
|
Code example
|
|
1078
|
-
|
|
1079
1079
|
</summary>
|
|
1080
1080
|
|
|
1081
1081
|
```ts
|
|
@@ -1097,6 +1097,7 @@ const data =
|
|
|
1097
1097
|
</div>
|
|
1098
1098
|
|
|
1099
1099
|
|
|
1100
|
+
|
|
1100
1101
|
### deleteUpdateJobByJobIdForAg
|
|
1101
1102
|
|
|
1102
1103
|
<div class="padding-bottom--md">
|
|
@@ -1128,7 +1129,6 @@ Deletes the specified update job
|
|
|
1128
1129
|
<details>
|
|
1129
1130
|
<summary>
|
|
1130
1131
|
Code example
|
|
1131
|
-
|
|
1132
1132
|
</summary>
|
|
1133
1133
|
|
|
1134
1134
|
```ts
|
|
@@ -1147,6 +1147,7 @@ const data =
|
|
|
1147
1147
|
</div>
|
|
1148
1148
|
|
|
1149
1149
|
|
|
1150
|
+
|
|
1150
1151
|
### getAllUpdateJobList
|
|
1151
1152
|
|
|
1152
1153
|
<div class="padding-bottom--md">
|
|
@@ -1171,11 +1172,11 @@ The response includes ActiveGates that have both completed (successful and faile
|
|
|
1171
1172
|
| Name | Type | Description |
|
|
1172
1173
|
| --- | --- | --- |
|
|
1173
1174
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of one day is used (<code>now-1d</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
1174
|
-
|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
1175
|
+
|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. |
|
|
1175
1176
|
|config.startVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
1176
|
-
|config.startVersionCompareType|GetAllUpdateJobListQueryStartVersionCompareType|<p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
1177
|
+
|config.startVersionCompareType|GetAllUpdateJobListQueryStartVersionCompareType|<p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> |
|
|
1177
1178
|
|config.targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
1178
|
-
|config.targetVersionCompareType|GetAllUpdateJobListQueryTargetVersionCompareType|<p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
1179
|
+
|config.targetVersionCompareType|GetAllUpdateJobListQueryTargetVersionCompareType|<p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> |
|
|
1179
1180
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
1180
1181
|
|config.updateType|GetAllUpdateJobListQueryUpdateType|Filters the resulting set of update-jobs by the update type. |
|
|
1181
1182
|
|
|
@@ -1190,7 +1191,6 @@ Success
|
|
|
1190
1191
|
<details>
|
|
1191
1192
|
<summary>
|
|
1192
1193
|
Code example
|
|
1193
|
-
|
|
1194
1194
|
</summary>
|
|
1195
1195
|
|
|
1196
1196
|
```ts
|
|
@@ -1207,6 +1207,7 @@ const data =
|
|
|
1207
1207
|
</div>
|
|
1208
1208
|
|
|
1209
1209
|
|
|
1210
|
+
|
|
1210
1211
|
### getUpdateJobByJobIdForAg
|
|
1211
1212
|
|
|
1212
1213
|
<div class="padding-bottom--md">
|
|
@@ -1242,7 +1243,6 @@ Success
|
|
|
1242
1243
|
<details>
|
|
1243
1244
|
<summary>
|
|
1244
1245
|
Code example
|
|
1245
|
-
|
|
1246
1246
|
</summary>
|
|
1247
1247
|
|
|
1248
1248
|
```ts
|
|
@@ -1261,6 +1261,7 @@ const data =
|
|
|
1261
1261
|
</div>
|
|
1262
1262
|
|
|
1263
1263
|
|
|
1264
|
+
|
|
1264
1265
|
### getUpdateJobListByAgId
|
|
1265
1266
|
|
|
1266
1267
|
<div class="padding-bottom--md">
|
|
@@ -1286,11 +1287,11 @@ The job can update the ActiveGate to the specified version or the latest availab
|
|
|
1286
1287
|
| --- | --- | --- |
|
|
1287
1288
|
|config.agId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required ActiveGate. |
|
|
1288
1289
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of one week is used (<code>now-1w</code>).</p> <p>Maximum timeframe is 31 days.</p> |
|
|
1289
|
-
|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type.
|
|
1290
|
+
|config.lastUpdates|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, filters the resulting set of update jobs to the most recent update of each type. |
|
|
1290
1291
|
|config.startVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the initial version (required format <code><major>.<minor>.<revision></code>). |
|
|
1291
|
-
|config.startVersionCompareType|GetUpdateJobListByAgIdQueryStartVersionCompareType|<p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p>
|
|
1292
|
+
|config.startVersionCompareType|GetUpdateJobListByAgIdQueryStartVersionCompareType|<p>Filters the resulting set of update jobs by the specified initial version.</p> <p>Specify the comparison operator here.</p> |
|
|
1292
1293
|
|config.targetVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filters the resulting set of update-jobs by the target version (required format <code><major>.<minor>.<revision></code>). |
|
|
1293
|
-
|config.targetVersionCompareType|GetUpdateJobListByAgIdQueryTargetVersionCompareType|<p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p>
|
|
1294
|
+
|config.targetVersionCompareType|GetUpdateJobListByAgIdQueryTargetVersionCompareType|<p>Filters the resulting set of update jobs by the specified target version.</p> <p>Specify the comparison operator here.</p> |
|
|
1294
1295
|
|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe for update jobs.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p> |
|
|
1295
1296
|
|config.updateType|GetUpdateJobListByAgIdQueryUpdateType|Filters the resulting set of update-jobs by the update type. |
|
|
1296
1297
|
|
|
@@ -1305,7 +1306,6 @@ Success
|
|
|
1305
1306
|
<details>
|
|
1306
1307
|
<summary>
|
|
1307
1308
|
Code example
|
|
1308
|
-
|
|
1309
1309
|
</summary>
|
|
1310
1310
|
|
|
1311
1311
|
```ts
|
|
@@ -1324,6 +1324,7 @@ const data =
|
|
|
1324
1324
|
</div>
|
|
1325
1325
|
|
|
1326
1326
|
|
|
1327
|
+
|
|
1327
1328
|
### validateUpdateJobForAg
|
|
1328
1329
|
|
|
1329
1330
|
<div class="padding-bottom--md">
|
|
@@ -1355,7 +1356,6 @@ Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
|
|
|
1355
1356
|
<details>
|
|
1356
1357
|
<summary>
|
|
1357
1358
|
Code example
|
|
1358
|
-
|
|
1359
1359
|
</summary>
|
|
1360
1360
|
|
|
1361
1361
|
```ts
|
|
@@ -1383,6 +1383,7 @@ import { activeGatesClient } from '@dynatrace-sdk/client-classic-environment-v2'
|
|
|
1383
1383
|
```
|
|
1384
1384
|
|
|
1385
1385
|
|
|
1386
|
+
|
|
1386
1387
|
### getAllActiveGates
|
|
1387
1388
|
|
|
1388
1389
|
<div class="padding-bottom--md">
|
|
@@ -1423,7 +1424,7 @@ The response includes all ActiveGates that are currently connected to the enviro
|
|
|
1423
1424
|
|config.type|GetAllActiveGatesQueryType|Filters the resulting set of ActiveGates by the ActiveGate type. |
|
|
1424
1425
|
|config.updateStatus|GetAllActiveGatesQueryUpdateStatus|Filters the resulting set of ActiveGates by the auto-update status. |
|
|
1425
1426
|
|config.version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the version in <code><major>.<minor>.<revision></code> format (for example, <code>1.195.0</code>) here.</p> |
|
|
1426
|
-
|config.versionCompareType|GetAllActiveGatesQueryVersionCompareType|<p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p>
|
|
1427
|
+
|config.versionCompareType|GetAllActiveGatesQueryVersionCompareType|<p>Filters the resulting set of ActiveGates by the specified version.</p> <p>Specify the comparison operator here.</p> |
|
|
1427
1428
|
|
|
1428
1429
|
|
|
1429
1430
|
|
|
@@ -1436,7 +1437,6 @@ Success
|
|
|
1436
1437
|
<details>
|
|
1437
1438
|
<summary>
|
|
1438
1439
|
Code example
|
|
1439
|
-
|
|
1440
1440
|
</summary>
|
|
1441
1441
|
|
|
1442
1442
|
```ts
|
|
@@ -1452,6 +1452,7 @@ const data = await activeGatesClient.getAllActiveGates();
|
|
|
1452
1452
|
</div>
|
|
1453
1453
|
|
|
1454
1454
|
|
|
1455
|
+
|
|
1455
1456
|
### getOneActiveGateById
|
|
1456
1457
|
|
|
1457
1458
|
<div class="padding-bottom--md">
|
|
@@ -1486,7 +1487,6 @@ Success
|
|
|
1486
1487
|
<details>
|
|
1487
1488
|
<summary>
|
|
1488
1489
|
Code example
|
|
1489
|
-
|
|
1490
1490
|
</summary>
|
|
1491
1491
|
|
|
1492
1492
|
```ts
|
|
@@ -1510,6 +1510,7 @@ import { attacksClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
1510
1510
|
```
|
|
1511
1511
|
|
|
1512
1512
|
|
|
1513
|
+
|
|
1513
1514
|
### getAttack
|
|
1514
1515
|
|
|
1515
1516
|
<div class="padding-bottom--md">
|
|
@@ -1547,7 +1548,6 @@ Success
|
|
|
1547
1548
|
<details>
|
|
1548
1549
|
<summary>
|
|
1549
1550
|
Code example
|
|
1550
|
-
|
|
1551
1551
|
</summary>
|
|
1552
1552
|
|
|
1553
1553
|
```ts
|
|
@@ -1563,6 +1563,7 @@ const data = await attacksClient.getAttack({ id: "..." });
|
|
|
1563
1563
|
</div>
|
|
1564
1564
|
|
|
1565
1565
|
|
|
1566
|
+
|
|
1566
1567
|
### getAttacks
|
|
1567
1568
|
|
|
1568
1569
|
<div class="padding-bottom--md">
|
|
@@ -1605,7 +1606,6 @@ Success
|
|
|
1605
1606
|
<details>
|
|
1606
1607
|
<summary>
|
|
1607
1608
|
Code example
|
|
1608
|
-
|
|
1609
1609
|
</summary>
|
|
1610
1610
|
|
|
1611
1611
|
```ts
|
|
@@ -1627,6 +1627,7 @@ import { auditLogsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
1627
1627
|
```
|
|
1628
1628
|
|
|
1629
1629
|
|
|
1630
|
+
|
|
1630
1631
|
### getLog
|
|
1631
1632
|
|
|
1632
1633
|
<div class="padding-bottom--md">
|
|
@@ -1661,7 +1662,6 @@ Success
|
|
|
1661
1662
|
<details>
|
|
1662
1663
|
<summary>
|
|
1663
1664
|
Code example
|
|
1664
|
-
|
|
1665
1665
|
</summary>
|
|
1666
1666
|
|
|
1667
1667
|
```ts
|
|
@@ -1677,6 +1677,7 @@ const data = await auditLogsClient.getLog({ id: "..." });
|
|
|
1677
1677
|
</div>
|
|
1678
1678
|
|
|
1679
1679
|
|
|
1680
|
+
|
|
1680
1681
|
### getLogs
|
|
1681
1682
|
|
|
1682
1683
|
<div class="padding-bottom--md">
|
|
@@ -1706,7 +1707,7 @@ You can limit the output by using pagination:
|
|
|
1706
1707
|
|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> |
|
|
1707
1708
|
|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> |
|
|
1708
1709
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of log entries in a single response payload.</p> <p>The maximal allowed page size is 5000.</p> <p>If not set, 1000 is used.</p> |
|
|
1709
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p>
|
|
1710
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p> |
|
|
1710
1711
|
|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> |
|
|
1711
1712
|
|
|
1712
1713
|
|
|
@@ -1720,7 +1721,6 @@ Success
|
|
|
1720
1721
|
<details>
|
|
1721
1722
|
<summary>
|
|
1722
1723
|
Code example
|
|
1723
|
-
|
|
1724
1724
|
</summary>
|
|
1725
1725
|
|
|
1726
1726
|
```ts
|
|
@@ -1742,6 +1742,7 @@ import { businessEventsClient } from '@dynatrace-sdk/client-classic-environment-
|
|
|
1742
1742
|
```
|
|
1743
1743
|
|
|
1744
1744
|
|
|
1745
|
+
|
|
1745
1746
|
### ingest
|
|
1746
1747
|
|
|
1747
1748
|
<div class="padding-bottom--md">
|
|
@@ -1772,7 +1773,6 @@ The provided business events are all accepted and will be processed.
|
|
|
1772
1773
|
<details>
|
|
1773
1774
|
<summary>
|
|
1774
1775
|
Code example
|
|
1775
|
-
|
|
1776
1776
|
</summary>
|
|
1777
1777
|
|
|
1778
1778
|
```ts
|
|
@@ -1814,6 +1814,7 @@ import { credentialVaultClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
1814
1814
|
```
|
|
1815
1815
|
|
|
1816
1816
|
|
|
1817
|
+
|
|
1817
1818
|
### createCredentials
|
|
1818
1819
|
|
|
1819
1820
|
<div class="padding-bottom--md">
|
|
@@ -1850,7 +1851,6 @@ Success. The new credentials set has been created. The response contains the ID
|
|
|
1850
1851
|
<details>
|
|
1851
1852
|
<summary>
|
|
1852
1853
|
Code example
|
|
1853
|
-
|
|
1854
1854
|
</summary>
|
|
1855
1855
|
|
|
1856
1856
|
```ts
|
|
@@ -1871,6 +1871,7 @@ const data = await credentialVaultClient.createCredentials({
|
|
|
1871
1871
|
</div>
|
|
1872
1872
|
|
|
1873
1873
|
|
|
1874
|
+
|
|
1874
1875
|
### getCredentials
|
|
1875
1876
|
|
|
1876
1877
|
<div class="padding-bottom--md">
|
|
@@ -1907,7 +1908,6 @@ Success. The response contains the metadata of the credentials set.
|
|
|
1907
1908
|
<details>
|
|
1908
1909
|
<summary>
|
|
1909
1910
|
Code example
|
|
1910
|
-
|
|
1911
1911
|
</summary>
|
|
1912
1912
|
|
|
1913
1913
|
```ts
|
|
@@ -1925,6 +1925,7 @@ const data = await credentialVaultClient.getCredentials({
|
|
|
1925
1925
|
</div>
|
|
1926
1926
|
|
|
1927
1927
|
|
|
1928
|
+
|
|
1928
1929
|
### getCredentialsDetails
|
|
1929
1930
|
|
|
1930
1931
|
<div class="padding-bottom--md">
|
|
@@ -1960,7 +1961,6 @@ Success. The response contains the details of the credentials set.
|
|
|
1960
1961
|
<details>
|
|
1961
1962
|
<summary>
|
|
1962
1963
|
Code example
|
|
1963
|
-
|
|
1964
1964
|
</summary>
|
|
1965
1965
|
|
|
1966
1966
|
```ts
|
|
@@ -1979,6 +1979,7 @@ const data =
|
|
|
1979
1979
|
</div>
|
|
1980
1980
|
|
|
1981
1981
|
|
|
1982
|
+
|
|
1982
1983
|
### listCredentials
|
|
1983
1984
|
|
|
1984
1985
|
<div class="padding-bottom--md">
|
|
@@ -2020,7 +2021,6 @@ Success
|
|
|
2020
2021
|
<details>
|
|
2021
2022
|
<summary>
|
|
2022
2023
|
Code example
|
|
2023
|
-
|
|
2024
2024
|
</summary>
|
|
2025
2025
|
|
|
2026
2026
|
```ts
|
|
@@ -2036,6 +2036,7 @@ const data = await credentialVaultClient.listCredentials();
|
|
|
2036
2036
|
</div>
|
|
2037
2037
|
|
|
2038
2038
|
|
|
2039
|
+
|
|
2039
2040
|
### removeCredentials
|
|
2040
2041
|
|
|
2041
2042
|
<div class="padding-bottom--md">
|
|
@@ -2068,7 +2069,6 @@ Provide credential ID in the path.
|
|
|
2068
2069
|
<details>
|
|
2069
2070
|
<summary>
|
|
2070
2071
|
Code example
|
|
2071
|
-
|
|
2072
2072
|
</summary>
|
|
2073
2073
|
|
|
2074
2074
|
```ts
|
|
@@ -2086,6 +2086,7 @@ const data = await credentialVaultClient.removeCredentials({
|
|
|
2086
2086
|
</div>
|
|
2087
2087
|
|
|
2088
2088
|
|
|
2089
|
+
|
|
2089
2090
|
### updateCredentials
|
|
2090
2091
|
|
|
2091
2092
|
<div class="padding-bottom--md">
|
|
@@ -2123,7 +2124,6 @@ Success. The new credentials set has been created. The response contains the ID
|
|
|
2123
2124
|
<details>
|
|
2124
2125
|
<summary>
|
|
2125
2126
|
Code example
|
|
2126
|
-
|
|
2127
2127
|
</summary>
|
|
2128
2128
|
|
|
2129
2129
|
```ts
|
|
@@ -2151,6 +2151,7 @@ import { davisSecurityAdvisorClient } from '@dynatrace-sdk/client-classic-enviro
|
|
|
2151
2151
|
```
|
|
2152
2152
|
|
|
2153
2153
|
|
|
2154
|
+
|
|
2154
2155
|
### getAdviceForSecurityProblems
|
|
2155
2156
|
|
|
2156
2157
|
<div class="padding-bottom--md">
|
|
@@ -2193,7 +2194,6 @@ Success
|
|
|
2193
2194
|
<details>
|
|
2194
2195
|
<summary>
|
|
2195
2196
|
Code example
|
|
2196
|
-
|
|
2197
2197
|
</summary>
|
|
2198
2198
|
|
|
2199
2199
|
```ts
|
|
@@ -2216,6 +2216,7 @@ import { eventsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
2216
2216
|
```
|
|
2217
2217
|
|
|
2218
2218
|
|
|
2219
|
+
|
|
2219
2220
|
### createEvent
|
|
2220
2221
|
|
|
2221
2222
|
<div class="padding-bottom--md">
|
|
@@ -2260,7 +2261,6 @@ The event ingest request was received by the server. The response body indicates
|
|
|
2260
2261
|
<details>
|
|
2261
2262
|
<summary>
|
|
2262
2263
|
Code example
|
|
2263
|
-
|
|
2264
2264
|
</summary>
|
|
2265
2265
|
|
|
2266
2266
|
```ts
|
|
@@ -2278,6 +2278,7 @@ const data = await eventsClient.createEvent({
|
|
|
2278
2278
|
</div>
|
|
2279
2279
|
|
|
2280
2280
|
|
|
2281
|
+
|
|
2281
2282
|
### getEvent
|
|
2282
2283
|
|
|
2283
2284
|
<div class="padding-bottom--md">
|
|
@@ -2312,7 +2313,6 @@ Success. The response contains the configuration of the event.
|
|
|
2312
2313
|
<details>
|
|
2313
2314
|
<summary>
|
|
2314
2315
|
Code example
|
|
2315
|
-
|
|
2316
2316
|
</summary>
|
|
2317
2317
|
|
|
2318
2318
|
```ts
|
|
@@ -2330,6 +2330,7 @@ const data = await eventsClient.getEvent({
|
|
|
2330
2330
|
</div>
|
|
2331
2331
|
|
|
2332
2332
|
|
|
2333
|
+
|
|
2333
2334
|
### getEventProperties
|
|
2334
2335
|
|
|
2335
2336
|
<div class="padding-bottom--md">
|
|
@@ -2365,7 +2366,6 @@ Success
|
|
|
2365
2366
|
<details>
|
|
2366
2367
|
<summary>
|
|
2367
2368
|
Code example
|
|
2368
|
-
|
|
2369
2369
|
</summary>
|
|
2370
2370
|
|
|
2371
2371
|
```ts
|
|
@@ -2381,6 +2381,7 @@ const data = await eventsClient.getEventProperties();
|
|
|
2381
2381
|
</div>
|
|
2382
2382
|
|
|
2383
2383
|
|
|
2384
|
+
|
|
2384
2385
|
### getEventProperty
|
|
2385
2386
|
|
|
2386
2387
|
<div class="padding-bottom--md">
|
|
@@ -2415,7 +2416,6 @@ Success
|
|
|
2415
2416
|
<details>
|
|
2416
2417
|
<summary>
|
|
2417
2418
|
Code example
|
|
2418
|
-
|
|
2419
2419
|
</summary>
|
|
2420
2420
|
|
|
2421
2421
|
```ts
|
|
@@ -2433,6 +2433,7 @@ const data = await eventsClient.getEventProperty({
|
|
|
2433
2433
|
</div>
|
|
2434
2434
|
|
|
2435
2435
|
|
|
2436
|
+
|
|
2436
2437
|
### getEventType
|
|
2437
2438
|
|
|
2438
2439
|
<div class="padding-bottom--md">
|
|
@@ -2467,7 +2468,6 @@ Success
|
|
|
2467
2468
|
<details>
|
|
2468
2469
|
<summary>
|
|
2469
2470
|
Code example
|
|
2470
|
-
|
|
2471
2471
|
</summary>
|
|
2472
2472
|
|
|
2473
2473
|
```ts
|
|
@@ -2485,6 +2485,7 @@ const data = await eventsClient.getEventType({
|
|
|
2485
2485
|
</div>
|
|
2486
2486
|
|
|
2487
2487
|
|
|
2488
|
+
|
|
2488
2489
|
### getEventTypes
|
|
2489
2490
|
|
|
2490
2491
|
<div class="padding-bottom--md">
|
|
@@ -2520,7 +2521,6 @@ Success
|
|
|
2520
2521
|
<details>
|
|
2521
2522
|
<summary>
|
|
2522
2523
|
Code example
|
|
2523
|
-
|
|
2524
2524
|
</summary>
|
|
2525
2525
|
|
|
2526
2526
|
```ts
|
|
@@ -2536,6 +2536,7 @@ const data = await eventsClient.getEventTypes();
|
|
|
2536
2536
|
</div>
|
|
2537
2537
|
|
|
2538
2538
|
|
|
2539
|
+
|
|
2539
2540
|
### getEvents
|
|
2540
2541
|
|
|
2541
2542
|
<div class="padding-bottom--md">
|
|
@@ -2575,7 +2576,6 @@ Success. The response contains the list of events.
|
|
|
2575
2576
|
<details>
|
|
2576
2577
|
<summary>
|
|
2577
2578
|
Code example
|
|
2578
|
-
|
|
2579
2579
|
</summary>
|
|
2580
2580
|
|
|
2581
2581
|
```ts
|
|
@@ -2597,6 +2597,7 @@ import { extensions_2_0Client } from '@dynatrace-sdk/client-classic-environment-
|
|
|
2597
2597
|
```
|
|
2598
2598
|
|
|
2599
2599
|
|
|
2600
|
+
|
|
2600
2601
|
### activateExtensionEnvironmentConfiguration
|
|
2601
2602
|
|
|
2602
2603
|
<div class="padding-bottom--md">
|
|
@@ -2634,7 +2635,6 @@ Success. Environment configuration created.
|
|
|
2634
2635
|
<details>
|
|
2635
2636
|
<summary>
|
|
2636
2637
|
Code example
|
|
2637
|
-
|
|
2638
2638
|
</summary>
|
|
2639
2639
|
|
|
2640
2640
|
```ts
|
|
@@ -2653,6 +2653,7 @@ const data =
|
|
|
2653
2653
|
</div>
|
|
2654
2654
|
|
|
2655
2655
|
|
|
2656
|
+
|
|
2656
2657
|
### createMonitoringConfiguration
|
|
2657
2658
|
|
|
2658
2659
|
<div class="padding-bottom--md">
|
|
@@ -2690,7 +2691,6 @@ Success | Multi-Status, if not all requests resulted in the same status
|
|
|
2690
2691
|
<details>
|
|
2691
2692
|
<summary>
|
|
2692
2693
|
Code example
|
|
2693
|
-
|
|
2694
2694
|
</summary>
|
|
2695
2695
|
|
|
2696
2696
|
```ts
|
|
@@ -2737,6 +2737,7 @@ const data =
|
|
|
2737
2737
|
</div>
|
|
2738
2738
|
|
|
2739
2739
|
|
|
2740
|
+
|
|
2740
2741
|
### deleteEnvironmentConfiguration
|
|
2741
2742
|
|
|
2742
2743
|
<div class="padding-bottom--md">
|
|
@@ -2773,7 +2774,6 @@ Success. Environment configuration deactivated.
|
|
|
2773
2774
|
<details>
|
|
2774
2775
|
<summary>
|
|
2775
2776
|
Code example
|
|
2776
|
-
|
|
2777
2777
|
</summary>
|
|
2778
2778
|
|
|
2779
2779
|
```ts
|
|
@@ -2792,6 +2792,7 @@ const data =
|
|
|
2792
2792
|
</div>
|
|
2793
2793
|
|
|
2794
2794
|
|
|
2795
|
+
|
|
2795
2796
|
### executeExtensionMonitoringConfigurationActions
|
|
2796
2797
|
|
|
2797
2798
|
<div class="padding-bottom--md">
|
|
@@ -2830,7 +2831,6 @@ Accepted. Response doesn&apos;t have a body.
|
|
|
2830
2831
|
<details>
|
|
2831
2832
|
<summary>
|
|
2832
2833
|
Code example
|
|
2833
|
-
|
|
2834
2834
|
</summary>
|
|
2835
2835
|
|
|
2836
2836
|
```ts
|
|
@@ -2853,6 +2853,7 @@ const data =
|
|
|
2853
2853
|
</div>
|
|
2854
2854
|
|
|
2855
2855
|
|
|
2856
|
+
|
|
2856
2857
|
### extensionConfigurationSchema
|
|
2857
2858
|
|
|
2858
2859
|
<div class="padding-bottom--md">
|
|
@@ -2890,7 +2891,6 @@ Success
|
|
|
2890
2891
|
<details>
|
|
2891
2892
|
<summary>
|
|
2892
2893
|
Code example
|
|
2893
|
-
|
|
2894
2894
|
</summary>
|
|
2895
2895
|
|
|
2896
2896
|
```ts
|
|
@@ -2910,6 +2910,7 @@ const data =
|
|
|
2910
2910
|
</div>
|
|
2911
2911
|
|
|
2912
2912
|
|
|
2913
|
+
|
|
2913
2914
|
### extensionDetails
|
|
2914
2915
|
|
|
2915
2916
|
<div class="padding-bottom--md">
|
|
@@ -2948,7 +2949,6 @@ Success
|
|
|
2948
2949
|
<details>
|
|
2949
2950
|
<summary>
|
|
2950
2951
|
Code example
|
|
2951
|
-
|
|
2952
2952
|
</summary>
|
|
2953
2953
|
|
|
2954
2954
|
```ts
|
|
@@ -2996,6 +2996,7 @@ const data = await extensions_2_0Client.extensionDetails({
|
|
|
2996
2996
|
</div>
|
|
2997
2997
|
|
|
2998
2998
|
|
|
2999
|
+
|
|
2999
3000
|
### extensionMonitoringConfigurations
|
|
3000
3001
|
|
|
3001
3002
|
<div class="padding-bottom--md">
|
|
@@ -3036,7 +3037,6 @@ Success
|
|
|
3036
3037
|
<details>
|
|
3037
3038
|
<summary>
|
|
3038
3039
|
Code example
|
|
3039
|
-
|
|
3040
3040
|
</summary>
|
|
3041
3041
|
|
|
3042
3042
|
```ts
|
|
@@ -3055,6 +3055,7 @@ const data =
|
|
|
3055
3055
|
</div>
|
|
3056
3056
|
|
|
3057
3057
|
|
|
3058
|
+
|
|
3058
3059
|
### getActiveEnvironmentConfiguration
|
|
3059
3060
|
|
|
3060
3061
|
<div class="padding-bottom--md">
|
|
@@ -3091,7 +3092,6 @@ Success
|
|
|
3091
3092
|
<details>
|
|
3092
3093
|
<summary>
|
|
3093
3094
|
Code example
|
|
3094
|
-
|
|
3095
3095
|
</summary>
|
|
3096
3096
|
|
|
3097
3097
|
```ts
|
|
@@ -3110,6 +3110,7 @@ const data =
|
|
|
3110
3110
|
</div>
|
|
3111
3111
|
|
|
3112
3112
|
|
|
3113
|
+
|
|
3113
3114
|
### getActiveGateGroupsInfo
|
|
3114
3115
|
|
|
3115
3116
|
<div class="padding-bottom--md">
|
|
@@ -3147,7 +3148,6 @@ Success
|
|
|
3147
3148
|
<details>
|
|
3148
3149
|
<summary>
|
|
3149
3150
|
Code example
|
|
3150
|
-
|
|
3151
3151
|
</summary>
|
|
3152
3152
|
|
|
3153
3153
|
```ts
|
|
@@ -3167,6 +3167,7 @@ const data =
|
|
|
3167
3167
|
</div>
|
|
3168
3168
|
|
|
3169
3169
|
|
|
3170
|
+
|
|
3170
3171
|
### getEnvironmentConfigurationAssetsInfo
|
|
3171
3172
|
|
|
3172
3173
|
<div class="padding-bottom--md">
|
|
@@ -3203,7 +3204,6 @@ Success
|
|
|
3203
3204
|
<details>
|
|
3204
3205
|
<summary>
|
|
3205
3206
|
Code example
|
|
3206
|
-
|
|
3207
3207
|
</summary>
|
|
3208
3208
|
|
|
3209
3209
|
```ts
|
|
@@ -3222,6 +3222,7 @@ const data =
|
|
|
3222
3222
|
</div>
|
|
3223
3223
|
|
|
3224
3224
|
|
|
3225
|
+
|
|
3225
3226
|
### getEnvironmentConfigurationEvents
|
|
3226
3227
|
|
|
3227
3228
|
<div class="padding-bottom--md">
|
|
@@ -3262,7 +3263,6 @@ List of the latest extension environment configuration events
|
|
|
3262
3263
|
<details>
|
|
3263
3264
|
<summary>
|
|
3264
3265
|
Code example
|
|
3265
|
-
|
|
3266
3266
|
</summary>
|
|
3267
3267
|
|
|
3268
3268
|
```ts
|
|
@@ -3281,6 +3281,7 @@ const data =
|
|
|
3281
3281
|
</div>
|
|
3282
3282
|
|
|
3283
3283
|
|
|
3284
|
+
|
|
3284
3285
|
### getExtensionMonitoringConfigurationEvents
|
|
3285
3286
|
|
|
3286
3287
|
<div class="padding-bottom--md">
|
|
@@ -3325,7 +3326,6 @@ Success
|
|
|
3325
3326
|
<details>
|
|
3326
3327
|
<summary>
|
|
3327
3328
|
Code example
|
|
3328
|
-
|
|
3329
3329
|
</summary>
|
|
3330
3330
|
|
|
3331
3331
|
```ts
|
|
@@ -3344,6 +3344,7 @@ const data =
|
|
|
3344
3344
|
</div>
|
|
3345
3345
|
|
|
3346
3346
|
|
|
3347
|
+
|
|
3347
3348
|
### getExtensionMonitoringConfigurationStatus
|
|
3348
3349
|
|
|
3349
3350
|
<div class="padding-bottom--md">
|
|
@@ -3381,7 +3382,6 @@ Success
|
|
|
3381
3382
|
<details>
|
|
3382
3383
|
<summary>
|
|
3383
3384
|
Code example
|
|
3384
|
-
|
|
3385
3385
|
</summary>
|
|
3386
3386
|
|
|
3387
3387
|
```ts
|
|
@@ -3400,6 +3400,7 @@ const data =
|
|
|
3400
3400
|
</div>
|
|
3401
3401
|
|
|
3402
3402
|
|
|
3403
|
+
|
|
3403
3404
|
### getSchemaFile
|
|
3404
3405
|
|
|
3405
3406
|
<div class="padding-bottom--md">
|
|
@@ -3437,7 +3438,6 @@ Success
|
|
|
3437
3438
|
<details>
|
|
3438
3439
|
<summary>
|
|
3439
3440
|
Code example
|
|
3440
|
-
|
|
3441
3441
|
</summary>
|
|
3442
3442
|
|
|
3443
3443
|
```ts
|
|
@@ -3456,6 +3456,7 @@ const data = await extensions_2_0Client.getSchemaFile({
|
|
|
3456
3456
|
</div>
|
|
3457
3457
|
|
|
3458
3458
|
|
|
3459
|
+
|
|
3459
3460
|
### installExtension
|
|
3460
3461
|
|
|
3461
3462
|
<div class="padding-bottom--md">
|
|
@@ -3493,7 +3494,6 @@ Success. The extension 2.0 has been uploaded.
|
|
|
3493
3494
|
<details>
|
|
3494
3495
|
<summary>
|
|
3495
3496
|
Code example
|
|
3496
|
-
|
|
3497
3497
|
</summary>
|
|
3498
3498
|
|
|
3499
3499
|
```ts
|
|
@@ -3511,6 +3511,7 @@ const data = await extensions_2_0Client.installExtension({
|
|
|
3511
3511
|
</div>
|
|
3512
3512
|
|
|
3513
3513
|
|
|
3514
|
+
|
|
3514
3515
|
### listExtensionInfos
|
|
3515
3516
|
|
|
3516
3517
|
<div class="padding-bottom--md">
|
|
@@ -3549,7 +3550,6 @@ Success
|
|
|
3549
3550
|
<details>
|
|
3550
3551
|
<summary>
|
|
3551
3552
|
Code example
|
|
3552
|
-
|
|
3553
3553
|
</summary>
|
|
3554
3554
|
|
|
3555
3555
|
```ts
|
|
@@ -3566,6 +3566,7 @@ const data =
|
|
|
3566
3566
|
</div>
|
|
3567
3567
|
|
|
3568
3568
|
|
|
3569
|
+
|
|
3569
3570
|
### listExtensionVersions
|
|
3570
3571
|
|
|
3571
3572
|
<div class="padding-bottom--md">
|
|
@@ -3604,7 +3605,6 @@ Success
|
|
|
3604
3605
|
<details>
|
|
3605
3606
|
<summary>
|
|
3606
3607
|
Code example
|
|
3607
|
-
|
|
3608
3608
|
</summary>
|
|
3609
3609
|
|
|
3610
3610
|
```ts
|
|
@@ -3623,6 +3623,7 @@ const data =
|
|
|
3623
3623
|
</div>
|
|
3624
3624
|
|
|
3625
3625
|
|
|
3626
|
+
|
|
3626
3627
|
### listExtensions
|
|
3627
3628
|
|
|
3628
3629
|
<div class="padding-bottom--md">
|
|
@@ -3661,7 +3662,6 @@ Success
|
|
|
3661
3662
|
<details>
|
|
3662
3663
|
<summary>
|
|
3663
3664
|
Code example
|
|
3664
|
-
|
|
3665
3665
|
</summary>
|
|
3666
3666
|
|
|
3667
3667
|
```ts
|
|
@@ -3677,6 +3677,7 @@ const data = await extensions_2_0Client.listExtensions();
|
|
|
3677
3677
|
</div>
|
|
3678
3678
|
|
|
3679
3679
|
|
|
3680
|
+
|
|
3680
3681
|
### listSchemaFiles
|
|
3681
3682
|
|
|
3682
3683
|
<div class="padding-bottom--md">
|
|
@@ -3714,7 +3715,6 @@ Success
|
|
|
3714
3715
|
<details>
|
|
3715
3716
|
<summary>
|
|
3716
3717
|
Code example
|
|
3717
|
-
|
|
3718
3718
|
</summary>
|
|
3719
3719
|
|
|
3720
3720
|
```ts
|
|
@@ -3760,6 +3760,7 @@ const data = await extensions_2_0Client.listSchemaFiles({
|
|
|
3760
3760
|
</div>
|
|
3761
3761
|
|
|
3762
3762
|
|
|
3763
|
+
|
|
3763
3764
|
### listSchemas
|
|
3764
3765
|
|
|
3765
3766
|
<div class="padding-bottom--md">
|
|
@@ -3788,7 +3789,6 @@ Success
|
|
|
3788
3789
|
<details>
|
|
3789
3790
|
<summary>
|
|
3790
3791
|
Code example
|
|
3791
|
-
|
|
3792
3792
|
</summary>
|
|
3793
3793
|
|
|
3794
3794
|
```ts
|
|
@@ -3804,6 +3804,7 @@ const data = await extensions_2_0Client.listSchemas();
|
|
|
3804
3804
|
</div>
|
|
3805
3805
|
|
|
3806
3806
|
|
|
3807
|
+
|
|
3807
3808
|
### monitoringConfigurationDetails
|
|
3808
3809
|
|
|
3809
3810
|
<div class="padding-bottom--md">
|
|
@@ -3841,7 +3842,6 @@ Success
|
|
|
3841
3842
|
<details>
|
|
3842
3843
|
<summary>
|
|
3843
3844
|
Code example
|
|
3844
|
-
|
|
3845
3845
|
</summary>
|
|
3846
3846
|
|
|
3847
3847
|
```ts
|
|
@@ -3860,6 +3860,7 @@ const data =
|
|
|
3860
3860
|
</div>
|
|
3861
3861
|
|
|
3862
3862
|
|
|
3863
|
+
|
|
3863
3864
|
### removeExtension
|
|
3864
3865
|
|
|
3865
3866
|
<div class="padding-bottom--md">
|
|
@@ -3897,7 +3898,6 @@ Success. The extension 2.0 version has been deleted.
|
|
|
3897
3898
|
<details>
|
|
3898
3899
|
<summary>
|
|
3899
3900
|
Code example
|
|
3900
|
-
|
|
3901
3901
|
</summary>
|
|
3902
3902
|
|
|
3903
3903
|
```ts
|
|
@@ -3916,6 +3916,7 @@ const data = await extensions_2_0Client.removeExtension({
|
|
|
3916
3916
|
</div>
|
|
3917
3917
|
|
|
3918
3918
|
|
|
3919
|
+
|
|
3919
3920
|
### removeMonitoringConfiguration
|
|
3920
3921
|
|
|
3921
3922
|
<div class="padding-bottom--md">
|
|
@@ -3949,7 +3950,6 @@ Deletes the specified monitoring configuration
|
|
|
3949
3950
|
<details>
|
|
3950
3951
|
<summary>
|
|
3951
3952
|
Code example
|
|
3952
|
-
|
|
3953
3953
|
</summary>
|
|
3954
3954
|
|
|
3955
3955
|
```ts
|
|
@@ -3969,6 +3969,7 @@ const data =
|
|
|
3969
3969
|
</div>
|
|
3970
3970
|
|
|
3971
3971
|
|
|
3972
|
+
|
|
3972
3973
|
### updateExtensionEnvironmentConfiguration
|
|
3973
3974
|
|
|
3974
3975
|
<div class="padding-bottom--md">
|
|
@@ -4006,7 +4007,6 @@ Success. Environment configuration updated.
|
|
|
4006
4007
|
<details>
|
|
4007
4008
|
<summary>
|
|
4008
4009
|
Code example
|
|
4009
|
-
|
|
4010
4010
|
</summary>
|
|
4011
4011
|
|
|
4012
4012
|
```ts
|
|
@@ -4025,6 +4025,7 @@ const data =
|
|
|
4025
4025
|
</div>
|
|
4026
4026
|
|
|
4027
4027
|
|
|
4028
|
+
|
|
4028
4029
|
### updateMonitoringConfiguration
|
|
4029
4030
|
|
|
4030
4031
|
<div class="padding-bottom--md">
|
|
@@ -4063,7 +4064,6 @@ Success
|
|
|
4063
4064
|
<details>
|
|
4064
4065
|
<summary>
|
|
4065
4066
|
Code example
|
|
4066
|
-
|
|
4067
4067
|
</summary>
|
|
4068
4068
|
|
|
4069
4069
|
```ts
|
|
@@ -4084,6 +4084,7 @@ const data =
|
|
|
4084
4084
|
</div>
|
|
4085
4085
|
|
|
4086
4086
|
|
|
4087
|
+
|
|
4087
4088
|
### uploadExtension
|
|
4088
4089
|
|
|
4089
4090
|
<div class="padding-bottom--md">
|
|
@@ -4108,7 +4109,7 @@ Uploads or verifies a new extension 2.0
|
|
|
4108
4109
|
| Name | Type | Description |
|
|
4109
4110
|
| --- | --- | --- |
|
|
4110
4111
|
|config.body<sup>*required</sup>|Blob| |
|
|
4111
|
-
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Only run validation but do not persist the extension even if validation was successful.
|
|
4112
|
+
|config.validateOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Only run validation but do not persist the extension even if validation was successful. |
|
|
4112
4113
|
|
|
4113
4114
|
|
|
4114
4115
|
|
|
@@ -4121,7 +4122,6 @@ The extension is valid | Success. The extension 2.0 has been uploaded.
|
|
|
4121
4122
|
<details>
|
|
4122
4123
|
<summary>
|
|
4123
4124
|
Code example
|
|
4124
|
-
|
|
4125
4125
|
</summary>
|
|
4126
4126
|
|
|
4127
4127
|
```ts
|
|
@@ -4145,6 +4145,7 @@ import { logsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
4145
4145
|
```
|
|
4146
4146
|
|
|
4147
4147
|
|
|
4148
|
+
|
|
4148
4149
|
### exportLogRecords
|
|
4149
4150
|
|
|
4150
4151
|
<div class="padding-bottom--md">
|
|
@@ -4180,9 +4181,9 @@ Disabled on *Log Management and Analytics, powered by Grail*.
|
|
|
4180
4181
|
| --- | --- | --- |
|
|
4181
4182
|
|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> |
|
|
4182
4183
|
|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> |
|
|
4183
|
-
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of results per result page.
|
|
4184
|
-
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p>
|
|
4185
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
4184
|
+
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of results per result page. |
|
|
4185
|
+
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p> |
|
|
4186
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> |
|
|
4186
4187
|
|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> |
|
|
4187
4188
|
|
|
4188
4189
|
|
|
@@ -4196,7 +4197,6 @@ Success
|
|
|
4196
4197
|
<details>
|
|
4197
4198
|
<summary>
|
|
4198
4199
|
Code example
|
|
4199
|
-
|
|
4200
4200
|
</summary>
|
|
4201
4201
|
|
|
4202
4202
|
```ts
|
|
@@ -4212,6 +4212,7 @@ const data = await logsClient.exportLogRecords();
|
|
|
4212
4212
|
</div>
|
|
4213
4213
|
|
|
4214
4214
|
|
|
4215
|
+
|
|
4215
4216
|
### getLogHistogramData
|
|
4216
4217
|
|
|
4217
4218
|
<div class="padding-bottom--md">
|
|
@@ -4247,9 +4248,9 @@ Please note that *Dynatrace API explorer* does not currently support OAuth authe
|
|
|
4247
4248
|
| --- | --- | --- |
|
|
4248
4249
|
|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> |
|
|
4249
4250
|
|config.groupBy|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|<p>The groupings to be included in the response.</p> <p>You can specify several groups in the following format: <code>groupBy=status&groupBy=log.source</code>.</p> <p>If not set, all possible groups are returned. You can use this option to check for possible grouping values.</p> <p>Unique log data attributes (high-cardinality attributes) for example, <code>span_id</code> or <code>trace_id</code> cannot be used for grouping.</p> |
|
|
4250
|
-
|config.maxGroupValues|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p>
|
|
4251
|
-
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p>
|
|
4252
|
-
|config.timeBuckets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p>
|
|
4251
|
+
|config.maxGroupValues|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The maximum number of values in each group.</p> <p>You can get up to 100 values per group.</p> <p>If not set, 10 is used.</p> |
|
|
4252
|
+
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p> |
|
|
4253
|
+
|config.timeBuckets|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The number of time slots in the result.</p> <p>The query timeframe is divided equally into the specified number of slots.</p> <p>The minimum length of a slot is 1 ms.</p> <p>If not set, 1 is used.</p> |
|
|
4253
4254
|
|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> |
|
|
4254
4255
|
|
|
4255
4256
|
|
|
@@ -4263,7 +4264,6 @@ Success
|
|
|
4263
4264
|
<details>
|
|
4264
4265
|
<summary>
|
|
4265
4266
|
Code example
|
|
4266
|
-
|
|
4267
4267
|
</summary>
|
|
4268
4268
|
|
|
4269
4269
|
```ts
|
|
@@ -4279,6 +4279,7 @@ const data = await logsClient.getLogHistogramData();
|
|
|
4279
4279
|
</div>
|
|
4280
4280
|
|
|
4281
4281
|
|
|
4282
|
+
|
|
4282
4283
|
### getLogRecords
|
|
4283
4284
|
|
|
4284
4285
|
<div class="padding-bottom--md">
|
|
@@ -4315,10 +4316,10 @@ Please note that *Dynatrace API explorer* does not currently support OAuth authe
|
|
|
4315
4316
|
| Name | Type | Description |
|
|
4316
4317
|
| --- | --- | --- |
|
|
4317
4318
|
|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> |
|
|
4318
|
-
|config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p>
|
|
4319
|
+
|config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The desired amount of log records.</p> <p>The maximal allowed limit is 1000.</p> <p>If not set, 1000 is used.</p> |
|
|
4319
4320
|
|config.nextSliceKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next slice of results. You can find it in the <strong>nextSliceKey</strong> field of the previous response.</p> <p>The first slice is always returned if you don't specify this parameter.</p> <p>If this parameter is set, all other query parameters are ignored.</p> <p>Unsupported on <em>Log Management and Analytics, powered by Grail</em>.</p> |
|
|
4320
|
-
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p>
|
|
4321
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p>
|
|
4321
|
+
|config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The log search query.</p> <p>The query must use the <a href="https://dt-url.net/pe03s6f" target="_blank" rel="noopener noreferrer" >Dynatrace search query language</a>.</p> |
|
|
4322
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the ordering of the log records.</p> <p>Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the <code>+</code> option will be applied.</p> <p>Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).</p> <p>When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).</p> |
|
|
4322
4323
|
|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> |
|
|
4323
4324
|
|
|
4324
4325
|
|
|
@@ -4332,7 +4333,6 @@ Success
|
|
|
4332
4333
|
<details>
|
|
4333
4334
|
<summary>
|
|
4334
4335
|
Code example
|
|
4335
|
-
|
|
4336
4336
|
</summary>
|
|
4337
4337
|
|
|
4338
4338
|
```ts
|
|
@@ -4348,6 +4348,7 @@ const data = await logsClient.getLogRecords();
|
|
|
4348
4348
|
</div>
|
|
4349
4349
|
|
|
4350
4350
|
|
|
4351
|
+
|
|
4351
4352
|
### storeLog
|
|
4352
4353
|
|
|
4353
4354
|
<div class="padding-bottom--md">
|
|
@@ -4414,7 +4415,6 @@ Only a part of input events were ingested due to event invalidity. For details,
|
|
|
4414
4415
|
<details>
|
|
4415
4416
|
<summary>
|
|
4416
4417
|
Code example
|
|
4417
|
-
|
|
4418
4418
|
</summary>
|
|
4419
4419
|
|
|
4420
4420
|
```ts
|
|
@@ -4463,6 +4463,7 @@ import { metricsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
4463
4463
|
```
|
|
4464
4464
|
|
|
4465
4465
|
|
|
4466
|
+
|
|
4466
4467
|
### allMetrics
|
|
4467
4468
|
|
|
4468
4469
|
<div class="padding-bottom--md">
|
|
@@ -4512,7 +4513,6 @@ Success
|
|
|
4512
4513
|
<details>
|
|
4513
4514
|
<summary>
|
|
4514
4515
|
Code example
|
|
4515
|
-
|
|
4516
4516
|
</summary>
|
|
4517
4517
|
|
|
4518
4518
|
```ts
|
|
@@ -4530,6 +4530,7 @@ const data = await metricsClient.allMetrics({
|
|
|
4530
4530
|
</div>
|
|
4531
4531
|
|
|
4532
4532
|
|
|
4533
|
+
|
|
4533
4534
|
### delete
|
|
4534
4535
|
|
|
4535
4536
|
<div class="padding-bottom--md">
|
|
@@ -4562,7 +4563,6 @@ Deletion cannot be undone! You can't delete a metric if it has data points
|
|
|
4562
4563
|
<details>
|
|
4563
4564
|
<summary>
|
|
4564
4565
|
Code example
|
|
4565
|
-
|
|
4566
4566
|
</summary>
|
|
4567
4567
|
|
|
4568
4568
|
```ts
|
|
@@ -4580,6 +4580,7 @@ const data = await metricsClient.delete({
|
|
|
4580
4580
|
</div>
|
|
4581
4581
|
|
|
4582
4582
|
|
|
4583
|
+
|
|
4583
4584
|
### ingest
|
|
4584
4585
|
|
|
4585
4586
|
<div class="padding-bottom--md">
|
|
@@ -4614,7 +4615,6 @@ The provided metric data points are accepted and will be processed in the backgr
|
|
|
4614
4615
|
<details>
|
|
4615
4616
|
<summary>
|
|
4616
4617
|
Code example
|
|
4617
|
-
|
|
4618
4618
|
</summary>
|
|
4619
4619
|
|
|
4620
4620
|
```ts
|
|
@@ -4632,6 +4632,7 @@ const data = await metricsClient.ingest({
|
|
|
4632
4632
|
</div>
|
|
4633
4633
|
|
|
4634
4634
|
|
|
4635
|
+
|
|
4635
4636
|
### metric
|
|
4636
4637
|
|
|
4637
4638
|
<div class="padding-bottom--md">
|
|
@@ -4667,7 +4668,6 @@ Success
|
|
|
4667
4668
|
<details>
|
|
4668
4669
|
<summary>
|
|
4669
4670
|
Code example
|
|
4670
|
-
|
|
4671
4671
|
</summary>
|
|
4672
4672
|
|
|
4673
4673
|
```ts
|
|
@@ -4686,6 +4686,7 @@ const data = await metricsClient.metric({
|
|
|
4686
4686
|
</div>
|
|
4687
4687
|
|
|
4688
4688
|
|
|
4689
|
+
|
|
4689
4690
|
### query
|
|
4690
4691
|
|
|
4691
4692
|
<div class="padding-bottom--md">
|
|
@@ -4735,7 +4736,6 @@ Success
|
|
|
4735
4736
|
<details>
|
|
4736
4737
|
<summary>
|
|
4737
4738
|
Code example
|
|
4738
|
-
|
|
4739
4739
|
</summary>
|
|
4740
4740
|
|
|
4741
4741
|
```ts
|
|
@@ -4759,6 +4759,7 @@ import { metricsUnitsClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
4759
4759
|
```
|
|
4760
4760
|
|
|
4761
4761
|
|
|
4762
|
+
|
|
4762
4763
|
### allUnits
|
|
4763
4764
|
|
|
4764
4765
|
<div class="padding-bottom--md">
|
|
@@ -4796,7 +4797,6 @@ Success
|
|
|
4796
4797
|
<details>
|
|
4797
4798
|
<summary>
|
|
4798
4799
|
Code example
|
|
4799
|
-
|
|
4800
4800
|
</summary>
|
|
4801
4801
|
|
|
4802
4802
|
```ts
|
|
@@ -4812,6 +4812,7 @@ const data = await metricsUnitsClient.allUnits();
|
|
|
4812
4812
|
</div>
|
|
4813
4813
|
|
|
4814
4814
|
|
|
4815
|
+
|
|
4815
4816
|
### convert
|
|
4816
4817
|
|
|
4817
4818
|
<div class="padding-bottom--md">
|
|
@@ -4851,7 +4852,6 @@ Success
|
|
|
4851
4852
|
<details>
|
|
4852
4853
|
<summary>
|
|
4853
4854
|
Code example
|
|
4854
|
-
|
|
4855
4855
|
</summary>
|
|
4856
4856
|
|
|
4857
4857
|
```ts
|
|
@@ -4870,6 +4870,7 @@ const data = await metricsUnitsClient.convert({
|
|
|
4870
4870
|
</div>
|
|
4871
4871
|
|
|
4872
4872
|
|
|
4873
|
+
|
|
4873
4874
|
### unit
|
|
4874
4875
|
|
|
4875
4876
|
<div class="padding-bottom--md">
|
|
@@ -4904,7 +4905,6 @@ Success
|
|
|
4904
4905
|
<details>
|
|
4905
4906
|
<summary>
|
|
4906
4907
|
Code example
|
|
4907
|
-
|
|
4908
4908
|
</summary>
|
|
4909
4909
|
|
|
4910
4910
|
```ts
|
|
@@ -4928,6 +4928,7 @@ import { monitoredEntitiesClient } from '@dynatrace-sdk/client-classic-environme
|
|
|
4928
4928
|
```
|
|
4929
4929
|
|
|
4930
4930
|
|
|
4931
|
+
|
|
4931
4932
|
### deleteSecurityContext
|
|
4932
4933
|
|
|
4933
4934
|
<div class="padding-bottom--md">
|
|
@@ -4970,7 +4971,6 @@ Success
|
|
|
4970
4971
|
<details>
|
|
4971
4972
|
<summary>
|
|
4972
4973
|
Code example
|
|
4973
|
-
|
|
4974
4974
|
</summary>
|
|
4975
4975
|
|
|
4976
4976
|
```ts
|
|
@@ -4989,6 +4989,7 @@ const data =
|
|
|
4989
4989
|
</div>
|
|
4990
4990
|
|
|
4991
4991
|
|
|
4992
|
+
|
|
4992
4993
|
### getEntities
|
|
4993
4994
|
|
|
4994
4995
|
<div class="padding-bottom--md">
|
|
@@ -5041,7 +5042,6 @@ Success
|
|
|
5041
5042
|
<details>
|
|
5042
5043
|
<summary>
|
|
5043
5044
|
Code example
|
|
5044
|
-
|
|
5045
5045
|
</summary>
|
|
5046
5046
|
|
|
5047
5047
|
```ts
|
|
@@ -5057,6 +5057,7 @@ const data = await monitoredEntitiesClient.getEntities();
|
|
|
5057
5057
|
</div>
|
|
5058
5058
|
|
|
5059
5059
|
|
|
5060
|
+
|
|
5060
5061
|
### getEntity
|
|
5061
5062
|
|
|
5062
5063
|
<div class="padding-bottom--md">
|
|
@@ -5094,7 +5095,6 @@ Success
|
|
|
5094
5095
|
<details>
|
|
5095
5096
|
<summary>
|
|
5096
5097
|
Code example
|
|
5097
|
-
|
|
5098
5098
|
</summary>
|
|
5099
5099
|
|
|
5100
5100
|
```ts
|
|
@@ -5112,6 +5112,7 @@ const data = await monitoredEntitiesClient.getEntity({
|
|
|
5112
5112
|
</div>
|
|
5113
5113
|
|
|
5114
5114
|
|
|
5115
|
+
|
|
5115
5116
|
### getEntityType
|
|
5116
5117
|
|
|
5117
5118
|
<div class="padding-bottom--md">
|
|
@@ -5146,7 +5147,6 @@ Success
|
|
|
5146
5147
|
<details>
|
|
5147
5148
|
<summary>
|
|
5148
5149
|
Code example
|
|
5149
|
-
|
|
5150
5150
|
</summary>
|
|
5151
5151
|
|
|
5152
5152
|
```ts
|
|
@@ -5164,6 +5164,7 @@ const data = await monitoredEntitiesClient.getEntityType({
|
|
|
5164
5164
|
</div>
|
|
5165
5165
|
|
|
5166
5166
|
|
|
5167
|
+
|
|
5167
5168
|
### getEntityTypes
|
|
5168
5169
|
|
|
5169
5170
|
<div class="padding-bottom--md">
|
|
@@ -5203,7 +5204,6 @@ Success
|
|
|
5203
5204
|
<details>
|
|
5204
5205
|
<summary>
|
|
5205
5206
|
Code example
|
|
5206
|
-
|
|
5207
5207
|
</summary>
|
|
5208
5208
|
|
|
5209
5209
|
```ts
|
|
@@ -5219,6 +5219,7 @@ const data = await monitoredEntitiesClient.getEntityTypes();
|
|
|
5219
5219
|
</div>
|
|
5220
5220
|
|
|
5221
5221
|
|
|
5222
|
+
|
|
5222
5223
|
### pushCustomDevice
|
|
5223
5224
|
|
|
5224
5225
|
<div class="padding-bottom--md">
|
|
@@ -5254,7 +5255,6 @@ Success
|
|
|
5254
5255
|
<details>
|
|
5255
5256
|
<summary>
|
|
5256
5257
|
Code example
|
|
5257
|
-
|
|
5258
5258
|
</summary>
|
|
5259
5259
|
|
|
5260
5260
|
```ts
|
|
@@ -5272,6 +5272,7 @@ const data = await monitoredEntitiesClient.pushCustomDevice(
|
|
|
5272
5272
|
</div>
|
|
5273
5273
|
|
|
5274
5274
|
|
|
5275
|
+
|
|
5275
5276
|
### setSecurityContext
|
|
5276
5277
|
|
|
5277
5278
|
<div class="padding-bottom--md">
|
|
@@ -5317,7 +5318,6 @@ Success
|
|
|
5317
5318
|
<details>
|
|
5318
5319
|
<summary>
|
|
5319
5320
|
Code example
|
|
5320
|
-
|
|
5321
5321
|
</summary>
|
|
5322
5322
|
|
|
5323
5323
|
```ts
|
|
@@ -5343,6 +5343,7 @@ import { monitoredEntitiesCustomTagsClient } from '@dynatrace-sdk/client-classic
|
|
|
5343
5343
|
```
|
|
5344
5344
|
|
|
5345
5345
|
|
|
5346
|
+
|
|
5346
5347
|
### deleteTags
|
|
5347
5348
|
|
|
5348
5349
|
<div class="padding-bottom--md">
|
|
@@ -5382,7 +5383,6 @@ Success
|
|
|
5382
5383
|
<details>
|
|
5383
5384
|
<summary>
|
|
5384
5385
|
Code example
|
|
5385
|
-
|
|
5386
5386
|
</summary>
|
|
5387
5387
|
|
|
5388
5388
|
```ts
|
|
@@ -5402,6 +5402,7 @@ const data =
|
|
|
5402
5402
|
</div>
|
|
5403
5403
|
|
|
5404
5404
|
|
|
5405
|
+
|
|
5405
5406
|
### getTags
|
|
5406
5407
|
|
|
5407
5408
|
<div class="padding-bottom--md">
|
|
@@ -5440,7 +5441,6 @@ Success
|
|
|
5440
5441
|
<details>
|
|
5441
5442
|
<summary>
|
|
5442
5443
|
Code example
|
|
5443
|
-
|
|
5444
5444
|
</summary>
|
|
5445
5445
|
|
|
5446
5446
|
```ts
|
|
@@ -5459,6 +5459,7 @@ const data =
|
|
|
5459
5459
|
</div>
|
|
5460
5460
|
|
|
5461
5461
|
|
|
5462
|
+
|
|
5462
5463
|
### postTags
|
|
5463
5464
|
|
|
5464
5465
|
<div class="padding-bottom--md">
|
|
@@ -5498,7 +5499,6 @@ Success
|
|
|
5498
5499
|
<details>
|
|
5499
5500
|
<summary>
|
|
5500
5501
|
Code example
|
|
5501
|
-
|
|
5502
5502
|
</summary>
|
|
5503
5503
|
|
|
5504
5504
|
```ts
|
|
@@ -5524,6 +5524,7 @@ import { monitoredEntitiesMonitoringStateClient } from '@dynatrace-sdk/client-cl
|
|
|
5524
5524
|
```
|
|
5525
5525
|
|
|
5526
5526
|
|
|
5527
|
+
|
|
5527
5528
|
### getStates
|
|
5528
5529
|
|
|
5529
5530
|
<div class="padding-bottom--md">
|
|
@@ -5562,7 +5563,6 @@ Success
|
|
|
5562
5563
|
<details>
|
|
5563
5564
|
<summary>
|
|
5564
5565
|
Code example
|
|
5565
|
-
|
|
5566
5566
|
</summary>
|
|
5567
5567
|
|
|
5568
5568
|
```ts
|
|
@@ -5585,6 +5585,7 @@ import { networkZonesClient } from '@dynatrace-sdk/client-classic-environment-v2
|
|
|
5585
5585
|
```
|
|
5586
5586
|
|
|
5587
5587
|
|
|
5588
|
+
|
|
5588
5589
|
### createOrUpdateNetworkZone
|
|
5589
5590
|
|
|
5590
5591
|
<div class="padding-bottom--md">
|
|
@@ -5624,7 +5625,6 @@ Success. The new network zone has been created. The response body contains the I
|
|
|
5624
5625
|
<details>
|
|
5625
5626
|
<summary>
|
|
5626
5627
|
Code example
|
|
5627
|
-
|
|
5628
5628
|
</summary>
|
|
5629
5629
|
|
|
5630
5630
|
```ts
|
|
@@ -5644,6 +5644,7 @@ const data =
|
|
|
5644
5644
|
</div>
|
|
5645
5645
|
|
|
5646
5646
|
|
|
5647
|
+
|
|
5647
5648
|
### deleteNetworkZone
|
|
5648
5649
|
|
|
5649
5650
|
<div class="padding-bottom--md">
|
|
@@ -5678,7 +5679,6 @@ You can only delete an empty network zone (a zone that no ActiveGate or OneAgent
|
|
|
5678
5679
|
<details>
|
|
5679
5680
|
<summary>
|
|
5680
5681
|
Code example
|
|
5681
|
-
|
|
5682
5682
|
</summary>
|
|
5683
5683
|
|
|
5684
5684
|
```ts
|
|
@@ -5696,6 +5696,7 @@ const data = await networkZonesClient.deleteNetworkZone({
|
|
|
5696
5696
|
</div>
|
|
5697
5697
|
|
|
5698
5698
|
|
|
5699
|
+
|
|
5699
5700
|
### getAllNetworkZones
|
|
5700
5701
|
|
|
5701
5702
|
<div class="padding-bottom--md">
|
|
@@ -5722,7 +5723,6 @@ Success
|
|
|
5722
5723
|
<details>
|
|
5723
5724
|
<summary>
|
|
5724
5725
|
Code example
|
|
5725
|
-
|
|
5726
5726
|
</summary>
|
|
5727
5727
|
|
|
5728
5728
|
```ts
|
|
@@ -5738,6 +5738,7 @@ const data = await networkZonesClient.getAllNetworkZones();
|
|
|
5738
5738
|
</div>
|
|
5739
5739
|
|
|
5740
5740
|
|
|
5741
|
+
|
|
5741
5742
|
### getHostStats
|
|
5742
5743
|
|
|
5743
5744
|
<div class="padding-bottom--md">
|
|
@@ -5759,7 +5760,7 @@ Gets the statistics about hosts using the network zone
|
|
|
5759
5760
|
|
|
5760
5761
|
| Name | Type | Description |
|
|
5761
5762
|
| --- | --- | --- |
|
|
5762
|
-
|config.filter|GetHostStatsQueryFilter|<p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p>
|
|
5763
|
+
|config.filter|GetHostStatsQueryFilter|<p>Filters the resulting set of hosts:</p> <ul> <li><code>all</code>: All hosts using the zone.</li> <li><code>configuredButNotConnectedOnly</code>: Hosts from the network zone that use other zones.</li> <li><code>connectedAsAlternativeOnly</code>: Hosts that use the network zone as an alternative.</li> <li><code>connectedAsFailoverOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.</li> <li><code>connectedAsFailoverWithoutOwnActiveGatesOnly</code>: Hosts from other zones that use the zone (not configured as an alternative) and <strong>no</strong> ActiveGates of higher priority are available.</li> </ul> <p>If not set, <code>all</code> is used.</p> |
|
|
5763
5764
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required network zone. |
|
|
5764
5765
|
|
|
5765
5766
|
|
|
@@ -5773,7 +5774,6 @@ Success
|
|
|
5773
5774
|
<details>
|
|
5774
5775
|
<summary>
|
|
5775
5776
|
Code example
|
|
5776
|
-
|
|
5777
5777
|
</summary>
|
|
5778
5778
|
|
|
5779
5779
|
```ts
|
|
@@ -5791,6 +5791,7 @@ const data = await networkZonesClient.getHostStats({
|
|
|
5791
5791
|
</div>
|
|
5792
5792
|
|
|
5793
5793
|
|
|
5794
|
+
|
|
5794
5795
|
### getNetworkZoneSettings
|
|
5795
5796
|
|
|
5796
5797
|
<div class="padding-bottom--md">
|
|
@@ -5817,7 +5818,6 @@ Success
|
|
|
5817
5818
|
<details>
|
|
5818
5819
|
<summary>
|
|
5819
5820
|
Code example
|
|
5820
|
-
|
|
5821
5821
|
</summary>
|
|
5822
5822
|
|
|
5823
5823
|
```ts
|
|
@@ -5834,6 +5834,7 @@ const data =
|
|
|
5834
5834
|
</div>
|
|
5835
5835
|
|
|
5836
5836
|
|
|
5837
|
+
|
|
5837
5838
|
### getSingleNetworkZone
|
|
5838
5839
|
|
|
5839
5840
|
<div class="padding-bottom--md">
|
|
@@ -5868,7 +5869,6 @@ Success
|
|
|
5868
5869
|
<details>
|
|
5869
5870
|
<summary>
|
|
5870
5871
|
Code example
|
|
5871
|
-
|
|
5872
5872
|
</summary>
|
|
5873
5873
|
|
|
5874
5874
|
```ts
|
|
@@ -5886,6 +5886,7 @@ const data = await networkZonesClient.getSingleNetworkZone({
|
|
|
5886
5886
|
</div>
|
|
5887
5887
|
|
|
5888
5888
|
|
|
5889
|
+
|
|
5889
5890
|
### updateNetworkZoneSettings
|
|
5890
5891
|
|
|
5891
5892
|
<div class="padding-bottom--md">
|
|
@@ -5916,7 +5917,6 @@ Updates the global configuration of network zones
|
|
|
5916
5917
|
<details>
|
|
5917
5918
|
<summary>
|
|
5918
5919
|
Code example
|
|
5919
|
-
|
|
5920
5920
|
</summary>
|
|
5921
5921
|
|
|
5922
5922
|
```ts
|
|
@@ -5941,6 +5941,7 @@ import { problemsClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
5941
5941
|
```
|
|
5942
5942
|
|
|
5943
5943
|
|
|
5944
|
+
|
|
5944
5945
|
### closeProblem
|
|
5945
5946
|
|
|
5946
5947
|
<div class="padding-bottom--md">
|
|
@@ -5976,7 +5977,6 @@ Success
|
|
|
5976
5977
|
<details>
|
|
5977
5978
|
<summary>
|
|
5978
5979
|
Code example
|
|
5979
|
-
|
|
5980
5980
|
</summary>
|
|
5981
5981
|
|
|
5982
5982
|
```ts
|
|
@@ -5995,6 +5995,7 @@ const data = await problemsClient.closeProblem({
|
|
|
5995
5995
|
</div>
|
|
5996
5996
|
|
|
5997
5997
|
|
|
5998
|
+
|
|
5998
5999
|
### createComment
|
|
5999
6000
|
|
|
6000
6001
|
<div class="padding-bottom--md">
|
|
@@ -6026,7 +6027,6 @@ Adds a new comment on the specified problem
|
|
|
6026
6027
|
<details>
|
|
6027
6028
|
<summary>
|
|
6028
6029
|
Code example
|
|
6029
|
-
|
|
6030
6030
|
</summary>
|
|
6031
6031
|
|
|
6032
6032
|
```ts
|
|
@@ -6045,6 +6045,7 @@ const data = await problemsClient.createComment({
|
|
|
6045
6045
|
</div>
|
|
6046
6046
|
|
|
6047
6047
|
|
|
6048
|
+
|
|
6048
6049
|
### deleteComment
|
|
6049
6050
|
|
|
6050
6051
|
<div class="padding-bottom--md">
|
|
@@ -6076,7 +6077,6 @@ Deletes the specified comment from a problem
|
|
|
6076
6077
|
<details>
|
|
6077
6078
|
<summary>
|
|
6078
6079
|
Code example
|
|
6079
|
-
|
|
6080
6080
|
</summary>
|
|
6081
6081
|
|
|
6082
6082
|
```ts
|
|
@@ -6095,6 +6095,7 @@ const data = await problemsClient.deleteComment({
|
|
|
6095
6095
|
</div>
|
|
6096
6096
|
|
|
6097
6097
|
|
|
6098
|
+
|
|
6098
6099
|
### getComment
|
|
6099
6100
|
|
|
6100
6101
|
<div class="padding-bottom--md">
|
|
@@ -6130,7 +6131,6 @@ Success
|
|
|
6130
6131
|
<details>
|
|
6131
6132
|
<summary>
|
|
6132
6133
|
Code example
|
|
6133
|
-
|
|
6134
6134
|
</summary>
|
|
6135
6135
|
|
|
6136
6136
|
```ts
|
|
@@ -6149,6 +6149,7 @@ const data = await problemsClient.getComment({
|
|
|
6149
6149
|
</div>
|
|
6150
6150
|
|
|
6151
6151
|
|
|
6152
|
+
|
|
6152
6153
|
### getComments
|
|
6153
6154
|
|
|
6154
6155
|
<div class="padding-bottom--md">
|
|
@@ -6185,7 +6186,6 @@ Success
|
|
|
6185
6186
|
<details>
|
|
6186
6187
|
<summary>
|
|
6187
6188
|
Code example
|
|
6188
|
-
|
|
6189
6189
|
</summary>
|
|
6190
6190
|
|
|
6191
6191
|
```ts
|
|
@@ -6203,6 +6203,7 @@ const data = await problemsClient.getComments({
|
|
|
6203
6203
|
</div>
|
|
6204
6204
|
|
|
6205
6205
|
|
|
6206
|
+
|
|
6206
6207
|
### getProblem
|
|
6207
6208
|
|
|
6208
6209
|
<div class="padding-bottom--md">
|
|
@@ -6238,7 +6239,6 @@ Success
|
|
|
6238
6239
|
<details>
|
|
6239
6240
|
<summary>
|
|
6240
6241
|
Code example
|
|
6241
|
-
|
|
6242
6242
|
</summary>
|
|
6243
6243
|
|
|
6244
6244
|
```ts
|
|
@@ -6256,6 +6256,7 @@ const data = await problemsClient.getProblem({
|
|
|
6256
6256
|
</div>
|
|
6257
6257
|
|
|
6258
6258
|
|
|
6259
|
+
|
|
6259
6260
|
### getProblems
|
|
6260
6261
|
|
|
6261
6262
|
<div class="padding-bottom--md">
|
|
@@ -6297,7 +6298,6 @@ Success
|
|
|
6297
6298
|
<details>
|
|
6298
6299
|
<summary>
|
|
6299
6300
|
Code example
|
|
6300
|
-
|
|
6301
6301
|
</summary>
|
|
6302
6302
|
|
|
6303
6303
|
```ts
|
|
@@ -6313,6 +6313,7 @@ const data = await problemsClient.getProblems();
|
|
|
6313
6313
|
</div>
|
|
6314
6314
|
|
|
6315
6315
|
|
|
6316
|
+
|
|
6316
6317
|
### updateComment
|
|
6317
6318
|
|
|
6318
6319
|
<div class="padding-bottom--md">
|
|
@@ -6345,7 +6346,6 @@ Updates the specified comment on a problem
|
|
|
6345
6346
|
<details>
|
|
6346
6347
|
<summary>
|
|
6347
6348
|
Code example
|
|
6348
|
-
|
|
6349
6349
|
</summary>
|
|
6350
6350
|
|
|
6351
6351
|
```ts
|
|
@@ -6371,6 +6371,7 @@ import { releasesClient } from '@dynatrace-sdk/client-classic-environment-v2';
|
|
|
6371
6371
|
```
|
|
6372
6372
|
|
|
6373
6373
|
|
|
6374
|
+
|
|
6374
6375
|
### getReleases
|
|
6375
6376
|
|
|
6376
6377
|
<div class="padding-bottom--md">
|
|
@@ -6392,12 +6393,12 @@ Returns all releases
|
|
|
6392
6393
|
|
|
6393
6394
|
| Name | Type | Description |
|
|
6394
6395
|
| --- | --- | --- |
|
|
6395
|
-
|config.demo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>).
|
|
6396
|
+
|config.demo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your Releases (<code>false</code>) or a set of demo Releases (<code>true</code>). |
|
|
6396
6397
|
|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> |
|
|
6397
6398
|
|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> |
|
|
6398
6399
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of Releases in a single response payload.</p> <p>The maximal allowed page size is 1000.</p> <p>If not set, 100 is used.</p> |
|
|
6399
|
-
|config.releasesSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").</p>
|
|
6400
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p>
|
|
6400
|
+
|config.releasesSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only Releases matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.</li> <li>Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.</li> <li>Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.</li> <li>Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.</li> <li>Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.</li> <li>Entity ID: entityId("id").</li> <li>Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.</li> <li>Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.</li> <li>Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive.</li> </ul> <p>To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response. e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").</p> <p>The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").</p> |
|
|
6401
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Specifies the field that is used for sorting the releases list. The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:</p> <ul> <li>'product': Product name</li> <li>'name': Release name</li> <li>'stage': Stage name</li> <li>'version': Version</li> <li>'instances': Instances</li> <li>'traffic': Traffic</li> </ul> <p>If not set, the ascending order sorting for name is applied.</p> |
|
|
6401
6402
|
|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> |
|
|
6402
6403
|
|
|
6403
6404
|
|
|
@@ -6411,7 +6412,6 @@ Success
|
|
|
6411
6412
|
<details>
|
|
6412
6413
|
<summary>
|
|
6413
6414
|
Code example
|
|
6414
|
-
|
|
6415
6415
|
</summary>
|
|
6416
6416
|
|
|
6417
6417
|
```ts
|
|
@@ -6433,6 +6433,7 @@ import { securityProblemsClient } from '@dynatrace-sdk/client-classic-environmen
|
|
|
6433
6433
|
```
|
|
6434
6434
|
|
|
6435
6435
|
|
|
6436
|
+
|
|
6436
6437
|
### bulkMuteRemediationItems
|
|
6437
6438
|
|
|
6438
6439
|
<div class="padding-bottom--md">
|
|
@@ -6468,7 +6469,6 @@ Success. The remediation item(s) have been muted.
|
|
|
6468
6469
|
<details>
|
|
6469
6470
|
<summary>
|
|
6470
6471
|
Code example
|
|
6471
|
-
|
|
6472
6472
|
</summary>
|
|
6473
6473
|
|
|
6474
6474
|
```ts
|
|
@@ -6488,6 +6488,7 @@ const data =
|
|
|
6488
6488
|
</div>
|
|
6489
6489
|
|
|
6490
6490
|
|
|
6491
|
+
|
|
6491
6492
|
### bulkMuteSecurityProblems
|
|
6492
6493
|
|
|
6493
6494
|
<div class="padding-bottom--md">
|
|
@@ -6522,7 +6523,6 @@ Success. The security problem(s) have been muted.
|
|
|
6522
6523
|
<details>
|
|
6523
6524
|
<summary>
|
|
6524
6525
|
Code example
|
|
6525
|
-
|
|
6526
6526
|
</summary>
|
|
6527
6527
|
|
|
6528
6528
|
```ts
|
|
@@ -6541,6 +6541,7 @@ const data =
|
|
|
6541
6541
|
</div>
|
|
6542
6542
|
|
|
6543
6543
|
|
|
6544
|
+
|
|
6544
6545
|
### bulkUnmuteRemediationItems
|
|
6545
6546
|
|
|
6546
6547
|
<div class="padding-bottom--md">
|
|
@@ -6576,7 +6577,6 @@ Success. The remediation item(s) have been un-muted.
|
|
|
6576
6577
|
<details>
|
|
6577
6578
|
<summary>
|
|
6578
6579
|
Code example
|
|
6579
|
-
|
|
6580
6580
|
</summary>
|
|
6581
6581
|
|
|
6582
6582
|
```ts
|
|
@@ -6596,6 +6596,7 @@ const data =
|
|
|
6596
6596
|
</div>
|
|
6597
6597
|
|
|
6598
6598
|
|
|
6599
|
+
|
|
6599
6600
|
### bulkUnmuteSecurityProblems
|
|
6600
6601
|
|
|
6601
6602
|
<div class="padding-bottom--md">
|
|
@@ -6630,7 +6631,6 @@ Success. The security problem(s) have been un-muted.
|
|
|
6630
6631
|
<details>
|
|
6631
6632
|
<summary>
|
|
6632
6633
|
Code example
|
|
6633
|
-
|
|
6634
6634
|
</summary>
|
|
6635
6635
|
|
|
6636
6636
|
```ts
|
|
@@ -6649,6 +6649,7 @@ const data =
|
|
|
6649
6649
|
</div>
|
|
6650
6650
|
|
|
6651
6651
|
|
|
6652
|
+
|
|
6652
6653
|
### getEventsForSecurityProblem
|
|
6653
6654
|
|
|
6654
6655
|
<div class="padding-bottom--md">
|
|
@@ -6687,7 +6688,6 @@ Success. The response contains the list of security problem events.
|
|
|
6687
6688
|
<details>
|
|
6688
6689
|
<summary>
|
|
6689
6690
|
Code example
|
|
6690
|
-
|
|
6691
6691
|
</summary>
|
|
6692
6692
|
|
|
6693
6693
|
```ts
|
|
@@ -6706,6 +6706,7 @@ const data =
|
|
|
6706
6706
|
</div>
|
|
6707
6707
|
|
|
6708
6708
|
|
|
6709
|
+
|
|
6709
6710
|
### getRemediationItem
|
|
6710
6711
|
|
|
6711
6712
|
<div class="padding-bottom--md">
|
|
@@ -6743,7 +6744,6 @@ Success. The response contains details of a single remediation item of a securit
|
|
|
6743
6744
|
<details>
|
|
6744
6745
|
<summary>
|
|
6745
6746
|
Code example
|
|
6746
|
-
|
|
6747
6747
|
</summary>
|
|
6748
6748
|
|
|
6749
6749
|
```ts
|
|
@@ -6763,6 +6763,7 @@ const data =
|
|
|
6763
6763
|
</div>
|
|
6764
6764
|
|
|
6765
6765
|
|
|
6766
|
+
|
|
6766
6767
|
### getRemediationItems
|
|
6767
6768
|
|
|
6768
6769
|
<div class="padding-bottom--md">
|
|
@@ -6800,7 +6801,6 @@ Success. The response contains the list of remediation items of a problem.
|
|
|
6800
6801
|
<details>
|
|
6801
6802
|
<summary>
|
|
6802
6803
|
Code example
|
|
6803
|
-
|
|
6804
6804
|
</summary>
|
|
6805
6805
|
|
|
6806
6806
|
```ts
|
|
@@ -6819,6 +6819,7 @@ const data =
|
|
|
6819
6819
|
</div>
|
|
6820
6820
|
|
|
6821
6821
|
|
|
6822
|
+
|
|
6822
6823
|
### getRemediationProgressEntities
|
|
6823
6824
|
|
|
6824
6825
|
<div class="padding-bottom--md">
|
|
@@ -6857,7 +6858,6 @@ Success. The response contains a list of remediation progress entities of a reme
|
|
|
6857
6858
|
<details>
|
|
6858
6859
|
<summary>
|
|
6859
6860
|
Code example
|
|
6860
|
-
|
|
6861
6861
|
</summary>
|
|
6862
6862
|
|
|
6863
6863
|
```ts
|
|
@@ -6876,6 +6876,7 @@ const data =
|
|
|
6876
6876
|
</div>
|
|
6877
6877
|
|
|
6878
6878
|
|
|
6879
|
+
|
|
6879
6880
|
### getSecurityProblem
|
|
6880
6881
|
|
|
6881
6882
|
<div class="padding-bottom--md">
|
|
@@ -6899,7 +6900,7 @@ Gets parameters of a security problem
|
|
|
6899
6900
|
|
|
6900
6901
|
| Name | Type | Description |
|
|
6901
6902
|
| --- | --- | --- |
|
|
6902
|
-
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> <li><code>filteredCounts</code>: Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.</li> <li><code>description</code>: The description of the vulnerability.</li> <li><code>events</code>: The security problem's last 10 events within the last 365 days, sorted from newest to oldest.</li> <li><code>vulnerableComponents</code>: A list of vulnerable components of the security problem within the provided filter range.</li> <li><code>affectedEntities</code>: A list of affected entities of the security problem within the provided filter range.</li> <li><code>exposedEntities</code>: A list of exposed entities of the security problem within the provided filter range.</li> <li><code>reachableDataAssets</code>: A list of data assets reachable by affected entities of the security problem within the provided filter range.</li> <li><code>relatedEntities</code>: A list of related entities of the security problem within the provided filter range.</li> <li><code>relatedContainerImages</code>: A list of related container images of the security problem within the provided filter range.</li> <li><code>relatedAttacks</code>: A list of attacks detected on the exposed security problem.</li> <li><code>entryPoints</code>: A list of entry points and a flag which indicates whether this list was truncated or not.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
|
|
6903
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of additional security problem properties you can add to the response.</p> <p>The following properties are available (all other properties are always included and you can't remove them from the response):</p> <ul> <li><code>riskAssessment</code>: A risk assessment of the security problem.</li> <li><code>managementZones</code>: The management zone where the security problem occurred.</li> <li><code>codeLevelVulnerabilityDetails</code>: Details of the code-level vulnerability.</li> <li><code>globalCounts</code>: Globally calculated statistics about the security problem. No management zone information is taken into account.</li> <li><code>filteredCounts</code>: Statistics about the security problem, filtered by the management zone and timeframe start ('from') query parameters.</li> <li><code>description</code>: The description of the vulnerability.</li> <li><code>remediationDescription</code>: Description of how to remediate the vulnerability.</li> <li><code>events</code>: The security problem's last 10 events within the last 365 days, sorted from newest to oldest.</li> <li><code>vulnerableComponents</code>: A list of vulnerable components of the security problem within the provided filter range.</li> <li><code>affectedEntities</code>: A list of affected entities of the security problem within the provided filter range.</li> <li><code>exposedEntities</code>: A list of exposed entities of the security problem within the provided filter range.</li> <li><code>reachableDataAssets</code>: A list of data assets reachable by affected entities of the security problem within the provided filter range.</li> <li><code>relatedEntities</code>: A list of related entities of the security problem within the provided filter range.</li> <li><code>relatedContainerImages</code>: A list of related container images of the security problem within the provided filter range.</li> <li><code>relatedAttacks</code>: A list of attacks detected on the exposed security problem.</li> <li><code>entryPoints</code>: A list of entry points and a flag which indicates whether this list was truncated or not.</li> </ul> <p>To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, <code>+riskAssessment,+managementZones</code>).</p> |
|
|
6903
6904
|
|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Based on the timeframe start the affected-, related- and vulnerable entities are being calculated. You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the default timeframe start of 24 hours in the past is used (<code>now-24h</code>).</p> <p>The timeframe start must not be older than 365 days.</p> |
|
|
6904
6905
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested security problem. |
|
|
6905
6906
|
|
|
@@ -6914,7 +6915,6 @@ Success. The response contains parameters of the security problem.
|
|
|
6914
6915
|
<details>
|
|
6915
6916
|
<summary>
|
|
6916
6917
|
Code example
|
|
6917
|
-
|
|
6918
6918
|
</summary>
|
|
6919
6919
|
|
|
6920
6920
|
```ts
|
|
@@ -6933,6 +6933,7 @@ const data =
|
|
|
6933
6933
|
</div>
|
|
6934
6934
|
|
|
6935
6935
|
|
|
6936
|
+
|
|
6936
6937
|
### getSecurityProblems
|
|
6937
6938
|
|
|
6938
6939
|
<div class="padding-bottom--md">
|
|
@@ -6975,7 +6976,6 @@ Success. The response contains the list of security problems.
|
|
|
6975
6976
|
<details>
|
|
6976
6977
|
<summary>
|
|
6977
6978
|
Code example
|
|
6978
|
-
|
|
6979
6979
|
</summary>
|
|
6980
6980
|
|
|
6981
6981
|
```ts
|
|
@@ -6992,6 +6992,7 @@ const data =
|
|
|
6992
6992
|
</div>
|
|
6993
6993
|
|
|
6994
6994
|
|
|
6995
|
+
|
|
6995
6996
|
### getVulnerableFunctions
|
|
6996
6997
|
|
|
6997
6998
|
<div class="padding-bottom--md">
|
|
@@ -7030,7 +7031,6 @@ Success. The response contains the list of vulnerable functions.
|
|
|
7030
7031
|
<details>
|
|
7031
7032
|
<summary>
|
|
7032
7033
|
Code example
|
|
7033
|
-
|
|
7034
7034
|
</summary>
|
|
7035
7035
|
|
|
7036
7036
|
```ts
|
|
@@ -7049,6 +7049,7 @@ const data =
|
|
|
7049
7049
|
</div>
|
|
7050
7050
|
|
|
7051
7051
|
|
|
7052
|
+
|
|
7052
7053
|
### muteSecurityProblem
|
|
7053
7054
|
|
|
7054
7055
|
<div class="padding-bottom--md">
|
|
@@ -7080,7 +7081,6 @@ Mutes a security problem
|
|
|
7080
7081
|
<details>
|
|
7081
7082
|
<summary>
|
|
7082
7083
|
Code example
|
|
7083
|
-
|
|
7084
7084
|
</summary>
|
|
7085
7085
|
|
|
7086
7086
|
```ts
|
|
@@ -7100,6 +7100,7 @@ const data =
|
|
|
7100
7100
|
</div>
|
|
7101
7101
|
|
|
7102
7102
|
|
|
7103
|
+
|
|
7103
7104
|
### setRemediationItemMuteState
|
|
7104
7105
|
|
|
7105
7106
|
<div class="padding-bottom--md">
|
|
@@ -7132,7 +7133,6 @@ Sets the mute state of a remediation item
|
|
|
7132
7133
|
<details>
|
|
7133
7134
|
<summary>
|
|
7134
7135
|
Code example
|
|
7135
|
-
|
|
7136
7136
|
</summary>
|
|
7137
7137
|
|
|
7138
7138
|
```ts
|
|
@@ -7153,6 +7153,7 @@ const data =
|
|
|
7153
7153
|
</div>
|
|
7154
7154
|
|
|
7155
7155
|
|
|
7156
|
+
|
|
7156
7157
|
### trackingLinkBulkUpdateAndDelete
|
|
7157
7158
|
|
|
7158
7159
|
<div class="padding-bottom--md">
|
|
@@ -7184,7 +7185,6 @@ Updates the external tracking links of the remediation items. | maturity=EARLY_A
|
|
|
7184
7185
|
<details>
|
|
7185
7186
|
<summary>
|
|
7186
7187
|
Code example
|
|
7187
|
-
|
|
7188
7188
|
</summary>
|
|
7189
7189
|
|
|
7190
7190
|
```ts
|
|
@@ -7203,6 +7203,7 @@ const data =
|
|
|
7203
7203
|
</div>
|
|
7204
7204
|
|
|
7205
7205
|
|
|
7206
|
+
|
|
7206
7207
|
### unmuteSecurityProblem
|
|
7207
7208
|
|
|
7208
7209
|
<div class="padding-bottom--md">
|
|
@@ -7234,7 +7235,6 @@ Un-mutes a security problem
|
|
|
7234
7235
|
<details>
|
|
7235
7236
|
<summary>
|
|
7236
7237
|
Code example
|
|
7237
|
-
|
|
7238
7238
|
</summary>
|
|
7239
7239
|
|
|
7240
7240
|
```ts
|
|
@@ -7260,6 +7260,7 @@ import { serviceLevelObjectivesClient } from '@dynatrace-sdk/client-classic-envi
|
|
|
7260
7260
|
```
|
|
7261
7261
|
|
|
7262
7262
|
|
|
7263
|
+
|
|
7263
7264
|
### createAlert
|
|
7264
7265
|
|
|
7265
7266
|
<div class="padding-bottom--md">
|
|
@@ -7286,7 +7287,7 @@ Creates an alert of the provided alert type for an SLO
|
|
|
7286
7287
|
|config.body<sup>*required</sup>|[AbstractSloAlertDto](#abstractsloalertdto)| |
|
|
7287
7288
|
|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> |
|
|
7288
7289
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
7289
|
-
|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>
|
|
7290
|
+
|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> |
|
|
7290
7291
|
|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> |
|
|
7291
7292
|
|
|
7292
7293
|
|
|
@@ -7300,7 +7301,6 @@ Success. The new alert has been created. The response contains the parameters of
|
|
|
7300
7301
|
<details>
|
|
7301
7302
|
<summary>
|
|
7302
7303
|
Code example
|
|
7303
|
-
|
|
7304
7304
|
</summary>
|
|
7305
7305
|
|
|
7306
7306
|
```ts
|
|
@@ -7321,6 +7321,7 @@ const data = await serviceLevelObjectivesClient.createAlert(
|
|
|
7321
7321
|
</div>
|
|
7322
7322
|
|
|
7323
7323
|
|
|
7324
|
+
|
|
7324
7325
|
### createSlo
|
|
7325
7326
|
|
|
7326
7327
|
<div class="padding-bottom--md">
|
|
@@ -7353,7 +7354,6 @@ Creates a new SLO
|
|
|
7353
7354
|
<details>
|
|
7354
7355
|
<summary>
|
|
7355
7356
|
Code example
|
|
7356
|
-
|
|
7357
7357
|
</summary>
|
|
7358
7358
|
|
|
7359
7359
|
```ts
|
|
@@ -7376,6 +7376,7 @@ const data = await serviceLevelObjectivesClient.createSlo({
|
|
|
7376
7376
|
</div>
|
|
7377
7377
|
|
|
7378
7378
|
|
|
7379
|
+
|
|
7379
7380
|
### deleteSlo
|
|
7380
7381
|
|
|
7381
7382
|
<div class="padding-bottom--md">
|
|
@@ -7408,7 +7409,6 @@ Deletes an SLO
|
|
|
7408
7409
|
<details>
|
|
7409
7410
|
<summary>
|
|
7410
7411
|
Code example
|
|
7411
|
-
|
|
7412
7412
|
</summary>
|
|
7413
7413
|
|
|
7414
7414
|
```ts
|
|
@@ -7426,6 +7426,7 @@ const data = await serviceLevelObjectivesClient.deleteSlo({
|
|
|
7426
7426
|
</div>
|
|
7427
7427
|
|
|
7428
7428
|
|
|
7429
|
+
|
|
7429
7430
|
### getSlo
|
|
7430
7431
|
|
|
7431
7432
|
<div class="padding-bottom--md">
|
|
@@ -7456,16 +7457,16 @@ By default the values are calculated for the SLO's own timeframe. You can u
|
|
|
7456
7457
|
|
|
7457
7458
|
| Name | Type | Description |
|
|
7458
7459
|
| --- | --- | --- |
|
|
7459
|
-
|config.demo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>).
|
|
7460
|
-
|config.enabledSlos|GetSloQueryEnabledSlos|Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>).
|
|
7461
|
-
|config.evaluate|GetSloQueryEvaluate|Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25.
|
|
7460
|
+
|config.demo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your SLOs (<code>false</code>) or a set of demo SLOs (<code>true</code>). |
|
|
7461
|
+
|config.enabledSlos|GetSloQueryEnabledSlos|Get your enabled SLOs (<code>true</code>), disabled ones (<code>false</code>) or both enabled and disabled ones (<code>all</code>). |
|
|
7462
|
+
|config.evaluate|GetSloQueryEvaluate|Get your SLOs without them being evaluated (<code>false</code>) or with evaluations (<code>true</code>) with maximum <code>pageSize</code> of 25. |
|
|
7462
7463
|
|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> |
|
|
7463
7464
|
|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> |
|
|
7464
7465
|
|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of SLOs in a single response payload.</p> <p>The maximal allowed page size is 10000.</p> <p>If not set, 10 is used.</p> |
|
|
7465
|
-
|config.showGlobalSlos|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>).
|
|
7466
|
-
|config.sloSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p>
|
|
7467
|
-
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p>
|
|
7468
|
-
|config.timeFrame|GetSloQueryTimeFrame|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
7466
|
+
|config.showGlobalSlos|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Get your global SLOs (<code>true</code>) regardless of the selected filter or filter them out (<code>false</code>). |
|
|
7467
|
+
|config.sloSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The scope of the query. Only SLOs matching the provided criteria are included in the response.</p> <p>You can add one or several of the criteria listed below.</p> <ul> <li>SLO ID: <code>id("id-1","id-2")</code>.</li> <li>Name: <code>name("name")</code>. Filters for an SLO with the given name. The filter is case-sensitive.</li> <li>Health state: <code>healthState("HEALTHY")</code> or <code>healthState("UNHEALTHY")</code>. Filters for SLOs that have no related open problems (<code>HEALTHY</code>) or SLOs that have related open problems (<code>UNHEALTHY</code>). You can specify only one health state.</li> <li>Text: <code>text("value")</code>. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.</li> <li>Problem: <code>problemDisplayName("value")</code>. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).</li> <li>Management zone name: <code>managementZone("MZ-A")</code>. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.</li> <li>Management zone ID: <code>managementZoneID("123")</code>. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.</li> </ul> <p>To set several criteria, separate them with comma (<code>,</code>). Only SLOs matching all criteria are included in the response. Examples:</p> <ul> <li>.../api/v2/slo?sloSelector=name("Service Availability")</li> <li>.../api/v2/slo?sloSelector=id("id")</li> <li>.../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").</li> </ul> <p>The special characters <code>~</code> and <code>"</code> need to be escaped using a <code>~</code> (e.g. double quote search <code>text("~"")</code>).</p> |
|
|
7468
|
+
|config.sort|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sorting of SLO entries:</p> <ul> <li><code>name</code>: Names in ascending order.</li> <li><code>-name</code>: Names in descending order.</li> </ul> <p>If not set, the ascending order is used.</p> |
|
|
7469
|
+
|config.timeFrame|GetSloQueryTimeFrame|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> |
|
|
7469
7470
|
|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> |
|
|
7470
7471
|
|
|
7471
7472
|
|
|
@@ -7479,7 +7480,6 @@ Success. The response contains the parameters and calculated values of the reque
|
|
|
7479
7480
|
<details>
|
|
7480
7481
|
<summary>
|
|
7481
7482
|
Code example
|
|
7482
|
-
|
|
7483
7483
|
</summary>
|
|
7484
7484
|
|
|
7485
7485
|
```ts
|
|
@@ -7495,6 +7495,7 @@ const data = await serviceLevelObjectivesClient.getSlo();
|
|
|
7495
7495
|
</div>
|
|
7496
7496
|
|
|
7497
7497
|
|
|
7498
|
+
|
|
7498
7499
|
### getSloById
|
|
7499
7500
|
|
|
7500
7501
|
<div class="padding-bottom--md">
|
|
@@ -7524,7 +7525,7 @@ If **from** and **to** parameters are provided, the SLO is calculated for that t
|
|
|
7524
7525
|
| --- | --- | --- |
|
|
7525
7526
|
|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> |
|
|
7526
7527
|
|config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required SLO. |
|
|
7527
|
-
|config.timeFrame|GetSloByIdQueryTimeFrame|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p>
|
|
7528
|
+
|config.timeFrame|GetSloByIdQueryTimeFrame|<p>The timeframe to calculate the SLO values:</p> <ul> <li><code>CURRENT</code>: SLO's own timeframe.</li> <li><code>GTF</code>: timeframe specified by <strong>from</strong> and <strong>to</strong> parameters.</li> </ul> <p>If not set, the <code>CURRENT</code> value is used.</p> |
|
|
7528
7529
|
|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> |
|
|
7529
7530
|
|
|
7530
7531
|
|
|
@@ -7538,7 +7539,6 @@ Success. The response contains the parameters and calculated values of the reque
|
|
|
7538
7539
|
<details>
|
|
7539
7540
|
<summary>
|
|
7540
7541
|
Code example
|
|
7541
|
-
|
|
7542
7542
|
</summary>
|
|
7543
7543
|
|
|
7544
7544
|
```ts
|
|
@@ -7556,6 +7556,7 @@ const data = await serviceLevelObjectivesClient.getSloById({
|
|
|
7556
7556
|
</div>
|
|
7557
7557
|
|
|
7558
7558
|
|
|
7559
|
+
|
|
7559
7560
|
### updateSloById
|
|
7560
7561
|
|
|
7561
7562
|
<div class="padding-bottom--md">
|
|
@@ -7589,7 +7590,6 @@ Updates an existing SLO
|
|
|
7589
7590
|
<details>
|
|
7590
7591
|
<summary>
|
|
7591
7592
|
Code example
|
|
7592
|
-
|
|
7593
7593
|
</summary>
|
|
7594
7594
|
|
|
7595
7595
|
```ts
|
|
@@ -7620,6 +7620,7 @@ import { settingsObjectsClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
7620
7620
|
```
|
|
7621
7621
|
|
|
7622
7622
|
|
|
7623
|
+
|
|
7623
7624
|
### deleteSettingsObjectByObjectId
|
|
7624
7625
|
|
|
7625
7626
|
<div class="padding-bottom--md">
|
|
@@ -7653,7 +7654,6 @@ Deletes the specified settings object
|
|
|
7653
7654
|
<details>
|
|
7654
7655
|
<summary>
|
|
7655
7656
|
Code example
|
|
7656
|
-
|
|
7657
7657
|
</summary>
|
|
7658
7658
|
|
|
7659
7659
|
```ts
|
|
@@ -7672,6 +7672,7 @@ const data =
|
|
|
7672
7672
|
</div>
|
|
7673
7673
|
|
|
7674
7674
|
|
|
7675
|
+
|
|
7675
7676
|
### getEffectiveSettingsValues
|
|
7676
7677
|
|
|
7677
7678
|
<div class="padding-bottom--md">
|
|
@@ -7703,7 +7704,7 @@ If no object along the hierarchy is persisted, the default value as defined in t
|
|
|
7703
7704
|
|
|
7704
7705
|
| Name | Type | Description |
|
|
7705
7706
|
| --- | --- | --- |
|
|
7706
|
-
|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>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p>
|
|
7707
|
+
|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>origin,value</code>).</p> <p>Supported fields: <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>origin</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
7707
7708
|
|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> |
|
|
7708
7709
|
|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> |
|
|
7709
7710
|
|config.schemaIds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of comma-separated schema IDs to which the requested objects belong.</p> <p>Only considered on load of the first page, when the <strong>nextPageKey</strong> is not set.</p> |
|
|
@@ -7720,7 +7721,6 @@ Success
|
|
|
7720
7721
|
<details>
|
|
7721
7722
|
<summary>
|
|
7722
7723
|
Code example
|
|
7723
|
-
|
|
7724
7724
|
</summary>
|
|
7725
7725
|
|
|
7726
7726
|
```ts
|
|
@@ -7737,6 +7737,7 @@ const data =
|
|
|
7737
7737
|
</div>
|
|
7738
7738
|
|
|
7739
7739
|
|
|
7740
|
+
|
|
7740
7741
|
### getSettingsObjectByObjectId
|
|
7741
7742
|
|
|
7742
7743
|
<div class="padding-bottom--md">
|
|
@@ -7773,7 +7774,6 @@ Success
|
|
|
7773
7774
|
<details>
|
|
7774
7775
|
<summary>
|
|
7775
7776
|
Code example
|
|
7776
|
-
|
|
7777
7777
|
</summary>
|
|
7778
7778
|
|
|
7779
7779
|
```ts
|
|
@@ -7792,6 +7792,7 @@ const data =
|
|
|
7792
7792
|
</div>
|
|
7793
7793
|
|
|
7794
7794
|
|
|
7795
|
+
|
|
7795
7796
|
### getSettingsObjects
|
|
7796
7797
|
|
|
7797
7798
|
<div class="padding-bottom--md">
|
|
@@ -7824,7 +7825,7 @@ To query the effective values (including schema defaults) please see /settings/e
|
|
|
7824
7825
|
| Name | Type | Description |
|
|
7825
7826
|
| --- | --- | --- |
|
|
7826
7827
|
|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> |
|
|
7827
|
-
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p>
|
|
7828
|
+
|config.fields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A list of fields to be included to the response. The provided set of fields replaces the default set.</p> <p>Specify the required top-level fields, separated by commas (for example, <code>objectId,value</code>).</p> <p>Supported fields: <code>objectId</code>, <code>summary</code>, <code>searchSummary</code>, <code>created</code>, <code>modified</code>, <code>createdBy</code>, <code>modifiedBy</code>, <code>author</code>, <code>updateToken</code>, <code>scope</code>, <code>modificationInfo</code>, <code>schemaId</code>, <code>schemaVersion</code>, <code>value</code>, <code>externalId</code>.</p> |
|
|
7828
7829
|
|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> |
|
|
7829
7830
|
|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> |
|
|
7830
7831
|
|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> |
|
|
@@ -7843,7 +7844,6 @@ Success. Accessible objects returned.
|
|
|
7843
7844
|
<details>
|
|
7844
7845
|
<summary>
|
|
7845
7846
|
Code example
|
|
7846
|
-
|
|
7847
7847
|
</summary>
|
|
7848
7848
|
|
|
7849
7849
|
```ts
|
|
@@ -7860,6 +7860,7 @@ const data =
|
|
|
7860
7860
|
</div>
|
|
7861
7861
|
|
|
7862
7862
|
|
|
7863
|
+
|
|
7863
7864
|
### postSettingsObjects
|
|
7864
7865
|
|
|
7865
7866
|
<div class="padding-bottom--md">
|
|
@@ -7888,7 +7889,7 @@ You can upload several objects at once. In that case each object returns its own
|
|
|
7888
7889
|
| Name | Type | Description |
|
|
7889
7890
|
| --- | --- | --- |
|
|
7890
7891
|
|config.body<sup>*required</sup>|Array<[SettingsObjectCreate](#settingsobjectcreate)>| |
|
|
7891
|
-
|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.
|
|
7892
|
+
|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. |
|
|
7892
7893
|
|
|
7893
7894
|
|
|
7894
7895
|
|
|
@@ -7901,7 +7902,6 @@ Success | Multi-status: different objects in the payload resulted in different s
|
|
|
7901
7902
|
<details>
|
|
7902
7903
|
<summary>
|
|
7903
7904
|
Code example
|
|
7904
|
-
|
|
7905
7905
|
</summary>
|
|
7906
7906
|
|
|
7907
7907
|
```ts
|
|
@@ -7927,6 +7927,7 @@ const data =
|
|
|
7927
7927
|
</div>
|
|
7928
7928
|
|
|
7929
7929
|
|
|
7930
|
+
|
|
7930
7931
|
### putSettingsObjectByObjectId
|
|
7931
7932
|
|
|
7932
7933
|
<div class="padding-bottom--md">
|
|
@@ -7958,7 +7959,7 @@ Some schemas don't allow passing of the masked secret. In that case you nee
|
|
|
7958
7959
|
| --- | --- | --- |
|
|
7959
7960
|
|config.body<sup>*required</sup>|[SettingsObjectUpdate](#settingsobjectupdate)| |
|
|
7960
7961
|
|config.objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required settings object. |
|
|
7961
|
-
|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.
|
|
7962
|
+
|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. |
|
|
7962
7963
|
|
|
7963
7964
|
|
|
7964
7965
|
|
|
@@ -7971,7 +7972,6 @@ Success
|
|
|
7971
7972
|
<details>
|
|
7972
7973
|
<summary>
|
|
7973
7974
|
Code example
|
|
7974
|
-
|
|
7975
7975
|
</summary>
|
|
7976
7976
|
|
|
7977
7977
|
```ts
|
|
@@ -7997,6 +7997,7 @@ import { settingsSchemasClient } from '@dynatrace-sdk/client-classic-environment
|
|
|
7997
7997
|
```
|
|
7998
7998
|
|
|
7999
7999
|
|
|
8000
|
+
|
|
8000
8001
|
### getAvailableSchemaDefinitions
|
|
8001
8002
|
|
|
8002
8003
|
<div class="padding-bottom--md">
|
|
@@ -8025,7 +8026,6 @@ Success
|
|
|
8025
8026
|
<details>
|
|
8026
8027
|
<summary>
|
|
8027
8028
|
Code example
|
|
8028
|
-
|
|
8029
8029
|
</summary>
|
|
8030
8030
|
|
|
8031
8031
|
```ts
|
|
@@ -8042,6 +8042,7 @@ const data =
|
|
|
8042
8042
|
</div>
|
|
8043
8043
|
|
|
8044
8044
|
|
|
8045
|
+
|
|
8045
8046
|
### getSchemaDefinition
|
|
8046
8047
|
|
|
8047
8048
|
<div class="padding-bottom--md">
|
|
@@ -8079,7 +8080,6 @@ Success
|
|
|
8079
8080
|
<details>
|
|
8080
8081
|
<summary>
|
|
8081
8082
|
Code example
|
|
8082
|
-
|
|
8083
8083
|
</summary>
|
|
8084
8084
|
|
|
8085
8085
|
```ts
|
|
@@ -8104,6 +8104,7 @@ import { syntheticHttpMonitorExecutionsClient } from '@dynatrace-sdk/client-clas
|
|
|
8104
8104
|
```
|
|
8105
8105
|
|
|
8106
8106
|
|
|
8107
|
+
|
|
8107
8108
|
### getExecutionResult
|
|
8108
8109
|
|
|
8109
8110
|
<div class="padding-bottom--md">
|
|
@@ -8140,7 +8141,6 @@ Success. The response contains detailed data.
|
|
|
8140
8141
|
<details>
|
|
8141
8142
|
<summary>
|
|
8142
8143
|
Code example
|
|
8143
|
-
|
|
8144
8144
|
</summary>
|
|
8145
8145
|
|
|
8146
8146
|
```ts
|
|
@@ -8168,6 +8168,7 @@ import { syntheticLocationsNodesAndConfigurationClient } from '@dynatrace-sdk/cl
|
|
|
8168
8168
|
```
|
|
8169
8169
|
|
|
8170
8170
|
|
|
8171
|
+
|
|
8171
8172
|
### addLocation
|
|
8172
8173
|
|
|
8173
8174
|
<div class="padding-bottom--md">
|
|
@@ -8202,7 +8203,6 @@ Success. The private location has been created. The response contains the ID of
|
|
|
8202
8203
|
<details>
|
|
8203
8204
|
<summary>
|
|
8204
8205
|
Code example
|
|
8205
|
-
|
|
8206
8206
|
</summary>
|
|
8207
8207
|
|
|
8208
8208
|
```ts
|
|
@@ -8221,6 +8221,7 @@ const data =
|
|
|
8221
8221
|
</div>
|
|
8222
8222
|
|
|
8223
8223
|
|
|
8224
|
+
|
|
8224
8225
|
### getConfiguration
|
|
8225
8226
|
|
|
8226
8227
|
<div class="padding-bottom--md">
|
|
@@ -8247,7 +8248,6 @@ Success. The response contains synthetic related parameters defined for whole te
|
|
|
8247
8248
|
<details>
|
|
8248
8249
|
<summary>
|
|
8249
8250
|
Code example
|
|
8250
|
-
|
|
8251
8251
|
</summary>
|
|
8252
8252
|
|
|
8253
8253
|
```ts
|
|
@@ -8264,6 +8264,7 @@ const data =
|
|
|
8264
8264
|
</div>
|
|
8265
8265
|
|
|
8266
8266
|
|
|
8267
|
+
|
|
8267
8268
|
### getLocation
|
|
8268
8269
|
|
|
8269
8270
|
<div class="padding-bottom--md">
|
|
@@ -8298,7 +8299,6 @@ Success. The response contains parameters of the synthetic location.
|
|
|
8298
8299
|
<details>
|
|
8299
8300
|
<summary>
|
|
8300
8301
|
Code example
|
|
8301
|
-
|
|
8302
8302
|
</summary>
|
|
8303
8303
|
|
|
8304
8304
|
```ts
|
|
@@ -8317,6 +8317,7 @@ const data =
|
|
|
8317
8317
|
</div>
|
|
8318
8318
|
|
|
8319
8319
|
|
|
8320
|
+
|
|
8320
8321
|
### getLocationDeploymentApplyCommands
|
|
8321
8322
|
|
|
8322
8323
|
<div class="padding-bottom--md">
|
|
@@ -8353,7 +8354,6 @@ Success. The response contains the list of commands that needs to be executed to
|
|
|
8353
8354
|
<details>
|
|
8354
8355
|
<summary>
|
|
8355
8356
|
Code example
|
|
8356
|
-
|
|
8357
8357
|
</summary>
|
|
8358
8358
|
|
|
8359
8359
|
```ts
|
|
@@ -8370,6 +8370,7 @@ const data =
|
|
|
8370
8370
|
</div>
|
|
8371
8371
|
|
|
8372
8372
|
|
|
8373
|
+
|
|
8373
8374
|
### getLocationDeploymentDeleteCommands
|
|
8374
8375
|
|
|
8375
8376
|
<div class="padding-bottom--md">
|
|
@@ -8407,7 +8408,6 @@ Success. The response contains the list of commands that needs to be executed to
|
|
|
8407
8408
|
<details>
|
|
8408
8409
|
<summary>
|
|
8409
8410
|
Code example
|
|
8410
|
-
|
|
8411
8411
|
</summary>
|
|
8412
8412
|
|
|
8413
8413
|
```ts
|
|
@@ -8426,6 +8426,7 @@ const data =
|
|
|
8426
8426
|
</div>
|
|
8427
8427
|
|
|
8428
8428
|
|
|
8429
|
+
|
|
8429
8430
|
### getLocationDeploymentYaml
|
|
8430
8431
|
|
|
8431
8432
|
<div class="padding-bottom--md">
|
|
@@ -8466,7 +8467,6 @@ Success. The response contains the content of deployment yaml file.
|
|
|
8466
8467
|
<details>
|
|
8467
8468
|
<summary>
|
|
8468
8469
|
Code example
|
|
8469
|
-
|
|
8470
8470
|
</summary>
|
|
8471
8471
|
|
|
8472
8472
|
```ts
|
|
@@ -8485,6 +8485,7 @@ const data =
|
|
|
8485
8485
|
</div>
|
|
8486
8486
|
|
|
8487
8487
|
|
|
8488
|
+
|
|
8488
8489
|
### getLocations
|
|
8489
8490
|
|
|
8490
8491
|
<div class="padding-bottom--md">
|
|
@@ -8520,7 +8521,6 @@ Success
|
|
|
8520
8521
|
<details>
|
|
8521
8522
|
<summary>
|
|
8522
8523
|
Code example
|
|
8523
|
-
|
|
8524
8524
|
</summary>
|
|
8525
8525
|
|
|
8526
8526
|
```ts
|
|
@@ -8537,6 +8537,7 @@ const data =
|
|
|
8537
8537
|
</div>
|
|
8538
8538
|
|
|
8539
8539
|
|
|
8540
|
+
|
|
8540
8541
|
### getLocationsStatus
|
|
8541
8542
|
|
|
8542
8543
|
<div class="padding-bottom--md">
|
|
@@ -8563,7 +8564,6 @@ Success. The response contains the public locations status.
|
|
|
8563
8564
|
<details>
|
|
8564
8565
|
<summary>
|
|
8565
8566
|
Code example
|
|
8566
|
-
|
|
8567
8567
|
</summary>
|
|
8568
8568
|
|
|
8569
8569
|
```ts
|
|
@@ -8580,6 +8580,7 @@ const data =
|
|
|
8580
8580
|
</div>
|
|
8581
8581
|
|
|
8582
8582
|
|
|
8583
|
+
|
|
8583
8584
|
### getNode
|
|
8584
8585
|
|
|
8585
8586
|
<div class="padding-bottom--md">
|
|
@@ -8614,7 +8615,6 @@ Success
|
|
|
8614
8615
|
<details>
|
|
8615
8616
|
<summary>
|
|
8616
8617
|
Code example
|
|
8617
|
-
|
|
8618
8618
|
</summary>
|
|
8619
8619
|
|
|
8620
8620
|
```ts
|
|
@@ -8633,6 +8633,7 @@ const data =
|
|
|
8633
8633
|
</div>
|
|
8634
8634
|
|
|
8635
8635
|
|
|
8636
|
+
|
|
8636
8637
|
### getNodes
|
|
8637
8638
|
|
|
8638
8639
|
<div class="padding-bottom--md">
|
|
@@ -8659,7 +8660,6 @@ Success
|
|
|
8659
8660
|
<details>
|
|
8660
8661
|
<summary>
|
|
8661
8662
|
Code example
|
|
8662
|
-
|
|
8663
8663
|
</summary>
|
|
8664
8664
|
|
|
8665
8665
|
```ts
|
|
@@ -8676,6 +8676,7 @@ const data =
|
|
|
8676
8676
|
</div>
|
|
8677
8677
|
|
|
8678
8678
|
|
|
8679
|
+
|
|
8679
8680
|
### removeLocation
|
|
8680
8681
|
|
|
8681
8682
|
<div class="padding-bottom--md">
|
|
@@ -8706,7 +8707,6 @@ Deletes the specified private synthetic location
|
|
|
8706
8707
|
<details>
|
|
8707
8708
|
<summary>
|
|
8708
8709
|
Code example
|
|
8709
|
-
|
|
8710
8710
|
</summary>
|
|
8711
8711
|
|
|
8712
8712
|
```ts
|
|
@@ -8725,6 +8725,7 @@ const data =
|
|
|
8725
8725
|
</div>
|
|
8726
8726
|
|
|
8727
8727
|
|
|
8728
|
+
|
|
8728
8729
|
### updateConfiguration
|
|
8729
8730
|
|
|
8730
8731
|
<div class="padding-bottom--md">
|
|
@@ -8759,7 +8760,6 @@ Success. The set of synthetic related parameters has been updated. Response does
|
|
|
8759
8760
|
<details>
|
|
8760
8761
|
<summary>
|
|
8761
8762
|
Code example
|
|
8762
|
-
|
|
8763
8763
|
</summary>
|
|
8764
8764
|
|
|
8765
8765
|
```ts
|
|
@@ -8778,6 +8778,7 @@ const data =
|
|
|
8778
8778
|
</div>
|
|
8779
8779
|
|
|
8780
8780
|
|
|
8781
|
+
|
|
8781
8782
|
### updateLocation
|
|
8782
8783
|
|
|
8783
8784
|
<div class="padding-bottom--md">
|
|
@@ -8811,7 +8812,6 @@ For public locations you can only change the location status.
|
|
|
8811
8812
|
<details>
|
|
8812
8813
|
<summary>
|
|
8813
8814
|
Code example
|
|
8814
|
-
|
|
8815
8815
|
</summary>
|
|
8816
8816
|
|
|
8817
8817
|
```ts
|
|
@@ -8830,6 +8830,7 @@ const data =
|
|
|
8830
8830
|
</div>
|
|
8831
8831
|
|
|
8832
8832
|
|
|
8833
|
+
|
|
8833
8834
|
### updateLocationsStatus
|
|
8834
8835
|
|
|
8835
8836
|
<div class="padding-bottom--md">
|
|
@@ -8860,7 +8861,6 @@ Changes the status of public synthetic locations
|
|
|
8860
8861
|
<details>
|
|
8861
8862
|
<summary>
|
|
8862
8863
|
Code example
|
|
8863
|
-
|
|
8864
8864
|
</summary>
|
|
8865
8865
|
|
|
8866
8866
|
```ts
|
|
@@ -8885,6 +8885,7 @@ import { syntheticNetworkAvailabilityMonitorsClient } from '@dynatrace-sdk/clien
|
|
|
8885
8885
|
```
|
|
8886
8886
|
|
|
8887
8887
|
|
|
8888
|
+
|
|
8888
8889
|
### createMonitor
|
|
8889
8890
|
|
|
8890
8891
|
<div class="padding-bottom--md">
|
|
@@ -8919,7 +8920,6 @@ Success
|
|
|
8919
8920
|
<details>
|
|
8920
8921
|
<summary>
|
|
8921
8922
|
Code example
|
|
8922
|
-
|
|
8923
8923
|
</summary>
|
|
8924
8924
|
|
|
8925
8925
|
```ts
|
|
@@ -8938,6 +8938,7 @@ const data =
|
|
|
8938
8938
|
</div>
|
|
8939
8939
|
|
|
8940
8940
|
|
|
8941
|
+
|
|
8941
8942
|
### deleteMonitor
|
|
8942
8943
|
|
|
8943
8944
|
<div class="padding-bottom--md">
|
|
@@ -8968,7 +8969,6 @@ Deletes a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
8968
8969
|
<details>
|
|
8969
8970
|
<summary>
|
|
8970
8971
|
Code example
|
|
8971
|
-
|
|
8972
8972
|
</summary>
|
|
8973
8973
|
|
|
8974
8974
|
```ts
|
|
@@ -8987,6 +8987,7 @@ const data =
|
|
|
8987
8987
|
</div>
|
|
8988
8988
|
|
|
8989
8989
|
|
|
8990
|
+
|
|
8990
8991
|
### getMonitor
|
|
8991
8992
|
|
|
8992
8993
|
<div class="padding-bottom--md">
|
|
@@ -9021,7 +9022,6 @@ Success
|
|
|
9021
9022
|
<details>
|
|
9022
9023
|
<summary>
|
|
9023
9024
|
Code example
|
|
9024
|
-
|
|
9025
9025
|
</summary>
|
|
9026
9026
|
|
|
9027
9027
|
```ts
|
|
@@ -9040,6 +9040,7 @@ const data =
|
|
|
9040
9040
|
</div>
|
|
9041
9041
|
|
|
9042
9042
|
|
|
9043
|
+
|
|
9043
9044
|
### getMonitors
|
|
9044
9045
|
|
|
9045
9046
|
<div class="padding-bottom--md">
|
|
@@ -9074,7 +9075,6 @@ Success
|
|
|
9074
9075
|
<details>
|
|
9075
9076
|
<summary>
|
|
9076
9077
|
Code example
|
|
9077
|
-
|
|
9078
9078
|
</summary>
|
|
9079
9079
|
|
|
9080
9080
|
```ts
|
|
@@ -9091,6 +9091,7 @@ const data =
|
|
|
9091
9091
|
</div>
|
|
9092
9092
|
|
|
9093
9093
|
|
|
9094
|
+
|
|
9094
9095
|
### updateMonitor
|
|
9095
9096
|
|
|
9096
9097
|
<div class="padding-bottom--md">
|
|
@@ -9122,7 +9123,6 @@ Updates a synthetic monitor definition for the given monitor ID. Currently netwo
|
|
|
9122
9123
|
<details>
|
|
9123
9124
|
<summary>
|
|
9124
9125
|
Code example
|
|
9125
|
-
|
|
9126
9126
|
</summary>
|
|
9127
9127
|
|
|
9128
9128
|
```ts
|
|
@@ -9147,6 +9147,7 @@ import { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-
|
|
|
9147
9147
|
```
|
|
9148
9148
|
|
|
9149
9149
|
|
|
9150
|
+
|
|
9150
9151
|
### execute
|
|
9151
9152
|
|
|
9152
9153
|
<div class="padding-bottom--md">
|
|
@@ -9181,7 +9182,6 @@ Success. The monitor&apos;s execution response details
|
|
|
9181
9182
|
<details>
|
|
9182
9183
|
<summary>
|
|
9183
9184
|
Code example
|
|
9184
|
-
|
|
9185
9185
|
</summary>
|
|
9186
9186
|
|
|
9187
9187
|
```ts
|
|
@@ -9200,6 +9200,7 @@ const data =
|
|
|
9200
9200
|
</div>
|
|
9201
9201
|
|
|
9202
9202
|
|
|
9203
|
+
|
|
9203
9204
|
### getBatch
|
|
9204
9205
|
|
|
9205
9206
|
<div class="padding-bottom--md">
|
|
@@ -9234,7 +9235,6 @@ Success
|
|
|
9234
9235
|
<details>
|
|
9235
9236
|
<summary>
|
|
9236
9237
|
Code example
|
|
9237
|
-
|
|
9238
9238
|
</summary>
|
|
9239
9239
|
|
|
9240
9240
|
```ts
|
|
@@ -9253,6 +9253,7 @@ const data =
|
|
|
9253
9253
|
</div>
|
|
9254
9254
|
|
|
9255
9255
|
|
|
9256
|
+
|
|
9256
9257
|
### getExecution
|
|
9257
9258
|
|
|
9258
9259
|
<div class="padding-bottom--md">
|
|
@@ -9287,7 +9288,6 @@ Success. The response contains basic information about the on-demand execution.
|
|
|
9287
9288
|
<details>
|
|
9288
9289
|
<summary>
|
|
9289
9290
|
Code example
|
|
9290
|
-
|
|
9291
9291
|
</summary>
|
|
9292
9292
|
|
|
9293
9293
|
```ts
|
|
@@ -9306,6 +9306,7 @@ const data =
|
|
|
9306
9306
|
</div>
|
|
9307
9307
|
|
|
9308
9308
|
|
|
9309
|
+
|
|
9309
9310
|
### getExecutionFullReport
|
|
9310
9311
|
|
|
9311
9312
|
<div class="padding-bottom--md">
|
|
@@ -9340,7 +9341,6 @@ Success. The response contains detailed information about the on-demand executio
|
|
|
9340
9341
|
<details>
|
|
9341
9342
|
<summary>
|
|
9342
9343
|
Code example
|
|
9343
|
-
|
|
9344
9344
|
</summary>
|
|
9345
9345
|
|
|
9346
9346
|
```ts
|
|
@@ -9359,6 +9359,7 @@ const data =
|
|
|
9359
9359
|
</div>
|
|
9360
9360
|
|
|
9361
9361
|
|
|
9362
|
+
|
|
9362
9363
|
### getExecutions
|
|
9363
9364
|
|
|
9364
9365
|
<div class="padding-bottom--md">
|
|
@@ -9404,7 +9405,6 @@ Success
|
|
|
9404
9405
|
<details>
|
|
9405
9406
|
<summary>
|
|
9406
9407
|
Code example
|
|
9407
|
-
|
|
9408
9408
|
</summary>
|
|
9409
9409
|
|
|
9410
9410
|
```ts
|
|
@@ -9783,7 +9783,7 @@ Parameters of a new API token.
|
|
|
9783
9783
|
|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> |
|
|
9784
9784
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9785
9785
|
|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> |
|
|
9786
|
-
|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
|
|
9786
|
+
|scopes<sup>*required</sup>|Array<ApiTokenCreateScopesItem>|<p>A list of the scopes to be assigned to the token.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9787
9787
|
|
|
9788
9788
|
### ApiTokenCreated
|
|
9789
9789
|
|
|
@@ -9834,7 +9834,7 @@ The update of the API token.
|
|
|
9834
9834
|
| --- | --- | --- |
|
|
9835
9835
|
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is enabled (<code>true</code>) or disabled (<code>false</code>) |
|
|
9836
9836
|
|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token. |
|
|
9837
|
-
|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
|
|
9837
|
+
|scopes|Array<ApiTokenUpdateScopesItem>|<p>The list of scopes assigned to the token.</p> <p>Apart from the new scopes, you need to submit the existing scopes you want to keep, too. Any existing scope, missing in the payload, is removed.</p> <ul> <li><code>InstallerDownload</code>: PaaS integration - Installer download.</li> <li><code>DataExport</code>: Access problem and event feed, metrics, and topology.</li> <li><code>PluginUpload</code>: Upload Extension.</li> <li><code>SupportAlert</code>: PaaS integration - Support alert.</li> <li><code>AdvancedSyntheticIntegration</code>: Dynatrace module integration - Synthetic Classic.</li> <li><code>ExternalSyntheticIntegration</code>: Create and read synthetic monitors, locations, and nodes.</li> <li><code>RumBrowserExtension</code>: RUM Browser Extension.</li> <li><code>LogExport</code>: Read logs.</li> <li><code>ReadConfig</code>: Read configuration.</li> <li><code>WriteConfig</code>: Write configuration.</li> <li><code>DTAQLAccess</code>: User sessions.</li> <li><code>UserSessionAnonymization</code>: Anonymize user session data for data privacy reasons.</li> <li><code>DataPrivacy</code>: Change data privacy settings.</li> <li><code>CaptureRequestData</code>: Capture request data.</li> <li><code>Davis</code>: Dynatrace module integration - Davis.</li> <li><code>DssFileManagement</code>: Mobile symbolication file management.</li> <li><code>RumJavaScriptTagManagement</code>: Real user monitoring JavaScript tag management.</li> <li><code>TenantTokenManagement</code>: Token management.</li> <li><code>ActiveGateCertManagement</code>: ActiveGate certificate management.</li> <li><code>RestRequestForwarding</code>: Fetch data from a remote environment.</li> <li><code>ReadSyntheticData</code>: Read synthetic monitors, locations, and nodes.</li> <li><code>DataImport</code>: Data ingest, e.g.: metrics and events.</li> <li><code>syntheticExecutions.write</code>: Write synthetic monitor executions.</li> <li><code>syntheticExecutions.read</code>: Read synthetic monitor execution results.</li> <li><code>auditLogs.read</code>: Read audit logs.</li> <li><code>metrics.read</code>: Read metrics.</li> <li><code>metrics.write</code>: Write metrics.</li> <li><code>entities.read</code>: Read entities.</li> <li><code>entities.write</code>: Write entities.</li> <li><code>problems.read</code>: Read problems.</li> <li><code>problems.write</code>: Write problems.</li> <li><code>events.read</code>: Read events.</li> <li><code>events.ingest</code>: Ingest events.</li> <li><code>openpipeline.events</code>: OpenPipeline - Ingest Events.</li> <li><code>openpipeline.events.custom</code>: OpenPipeline - Ingest Events (Custom).</li> <li><code>openpipeline.events_security</code>: OpenPipeline - Ingest Events, Application Security.</li> <li><code>openpipeline.events_security.custom</code>: OpenPipeline - Ingest Events, Application Security (Custom).</li> <li><code>bizevents.ingest</code>: Ingest bizevents.</li> <li><code>analyzers.read</code>: Read analyzers.</li> <li><code>analyzers.write</code>: Write & execute analyzers.</li> <li><code>networkZones.read</code>: Read network zones.</li> <li><code>networkZones.write</code>: Write network zones.</li> <li><code>activeGates.read</code>: Read ActiveGates.</li> <li><code>activeGates.write</code>: Write ActiveGates.</li> <li><code>activeGateTokenManagement.read</code>: Read ActiveGate tokens.</li> <li><code>activeGateTokenManagement.create</code>: Create ActiveGate tokens.</li> <li><code>activeGateTokenManagement.write</code>: Write ActiveGate tokens.</li> <li><code>credentialVault.read</code>: Read credential vault entries.</li> <li><code>credentialVault.write</code>: Write credential vault entries.</li> <li><code>extensions.read</code>: Read extensions.</li> <li><code>extensions.write</code>: Write extensions.</li> <li><code>extensionConfigurations.read</code>: Read extension monitoring configurations.</li> <li><code>extensionConfigurations.write</code>: Write extension monitoring configurations.</li> <li><code>extensionEnvironment.read</code>: Read extension environment configurations.</li> <li><code>extensionEnvironment.write</code>: Write extension environment configurations.</li> <li><code>metrics.ingest</code>: Ingest metrics.</li> <li><code>attacks.read</code>: Read attacks.</li> <li><code>attacks.write</code>: Write Application Protection settings.</li> <li><code>securityProblems.read</code>: Read security problems.</li> <li><code>securityProblems.write</code>: Write security problems.</li> <li><code>syntheticLocations.read</code>: Read synthetic locations.</li> <li><code>syntheticLocations.write</code>: Write synthetic locations.</li> <li><code>settings.read</code>: Read settings.</li> <li><code>settings.write</code>: Write settings.</li> <li><code>tenantTokenRotation.write</code>: Tenant token rotation.</li> <li><code>slo.read</code>: Read SLO.</li> <li><code>slo.write</code>: Write SLO.</li> <li><code>releases.read</code>: Read releases.</li> <li><code>apiTokens.read</code>: Read API tokens.</li> <li><code>apiTokens.write</code>: Write API tokens.</li> <li><code>openTelemetryTrace.ingest</code>: Ingest OpenTelemetry traces.</li> <li><code>logs.read</code>: Read logs.</li> <li><code>logs.ingest</code>: Ingest logs.</li> <li><code>geographicRegions.read</code>: Read Geographic regions.</li> <li><code>oneAgents.read</code>: Read OneAgents.</li> <li><code>oneAgents.write</code>: Write OneAgents.</li> <li><code>traces.lookup</code>: Look up a single trace.</li> <li><code>unifiedAnalysis.read</code>: Read Unified Analysis page.</li> <li><code>hub.read</code>: Read Hub related data.</li> <li><code>hub.write</code>: Manage metadata of Hub items.</li> <li><code>hub.install</code>: Install and update Hub items.</li> <li><code>javaScriptMappingFiles.read</code>: Read JavaScript mapping files.</li> <li><code>javaScriptMappingFiles.write</code>: Write JavaScript mapping files.</li> <li><code>extensionConfigurationActions.write</code>: Actions for extension monitoring configurations.</li> <li><code>adaptiveTrafficManagement.read</code>: Read sampling configuration for Adaptive Traffic Management.</li> </ul> |
|
|
9838
9838
|
|
|
9839
9839
|
### ApplicationImpact
|
|
9840
9840
|
|
|
@@ -13714,6 +13714,7 @@ Parameters of a security problem
|
|
|
13714
13714
|
|relatedAttacks|[RelatedAttacksList](#relatedattackslist)| |
|
|
13715
13715
|
|relatedContainerImages|[RelatedContainerList](#relatedcontainerlist)| |
|
|
13716
13716
|
|relatedEntities|[RelatedEntitiesList](#relatedentitieslist)| |
|
|
13717
|
+
|remediationDescription|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of how to remediate the vulnerability. |
|
|
13717
13718
|
|riskAssessment|[RiskAssessmentDetails](#riskassessmentdetails)| |
|
|
13718
13719
|
|securityProblemId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the security problem. |
|
|
13719
13720
|
|status|SecurityProblemDetailsStatus| |
|
|
@@ -14121,6 +14122,34 @@ Outage handling configuration.
|
|
|
14121
14122
|
|localLocationOutageCountThreshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of failing locations. |
|
|
14122
14123
|
|localOutages|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Generate a problem and send an alert when the monitor is unavailable for one or more consecutive runs at any location. |
|
|
14123
14124
|
|
|
14125
|
+
### SyntheticMonitorPerformanceThresholdDto
|
|
14126
|
+
|
|
14127
|
+
|
|
14128
|
+
|
|
14129
|
+
|
|
14130
|
+
The performance threshold rule.
|
|
14131
|
+
|
|
14132
|
+
| Name | Type | Description |
|
|
14133
|
+
| --- | --- | --- |
|
|
14134
|
+
|aggregation|SyntheticMonitorPerformanceThresholdDtoAggregation| |
|
|
14135
|
+
|dealertingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of most recent non-violating request executions that closes the problem |
|
|
14136
|
+
|samples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of request executions in analyzed sliding window (sliding window size) |
|
|
14137
|
+
|stepIndex|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specify the step's index to which a threshold applies. |
|
|
14138
|
+
|threshold|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Notify if monitor request takes longer than <em>X</em> milliseconds to execute. |
|
|
14139
|
+
|violatingSamples|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of violating request executions in analyzed sliding window |
|
|
14140
|
+
|
|
14141
|
+
### SyntheticMonitorPerformanceThresholdsDto
|
|
14142
|
+
|
|
14143
|
+
|
|
14144
|
+
|
|
14145
|
+
|
|
14146
|
+
Performance thresholds configuration.
|
|
14147
|
+
|
|
14148
|
+
| Name | Type | Description |
|
|
14149
|
+
| --- | --- | --- |
|
|
14150
|
+
|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Performance threshold is enabled (<code>true</code>) or disabled (<code>false</code>). |
|
|
14151
|
+
|thresholds|Array<[SyntheticMonitorPerformanceThresholdDto](#syntheticmonitorperformancethresholddto)>|The list of performance threshold rules. |
|
|
14152
|
+
|
|
14124
14153
|
### SyntheticMonitorSummaryDto
|
|
14125
14154
|
|
|
14126
14155
|
|
|
@@ -14169,6 +14198,7 @@ Network Availability monitor.
|
|
|
14169
14198
|
|frequencyMin<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14170
14199
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14171
14200
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14201
|
+
|performanceThresholds|[SyntheticMonitorPerformanceThresholdsDto](#syntheticmonitorperformancethresholdsdto)| |
|
|
14172
14202
|
|steps<sup>*required</sup>|Array<[SyntheticMultiProtocolMonitorStepDto](#syntheticmultiprotocolmonitorstepdto)>|The steps of the monitor. |
|
|
14173
14203
|
|syntheticMonitorOutageHandlingSettings|[SyntheticMonitorOutageHandlingSettingsDto](#syntheticmonitoroutagehandlingsettingsdto)| |
|
|
14174
14204
|
|tags|Array<[SyntheticTagWithSourceDto](#synthetictagwithsourcedto)>|<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> |
|
|
@@ -14212,6 +14242,7 @@ Network availability monitor.
|
|
|
14212
14242
|
|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. |
|
|
14213
14243
|
|locations<sup>*required</sup>|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|The locations to which the monitor is assigned. |
|
|
14214
14244
|
|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor. |
|
|
14245
|
+
|performanceThresholds|[SyntheticMonitorPerformanceThresholdsDto](#syntheticmonitorperformancethresholdsdto)| |
|
|
14215
14246
|
|steps<sup>*required</sup>|Array<[SyntheticMultiProtocolMonitorStepDto](#syntheticmultiprotocolmonitorstepdto)>|The steps of the monitor. |
|
|
14216
14247
|
|syntheticMonitorOutageHandlingSettings|[SyntheticMonitorOutageHandlingSettingsDto](#syntheticmonitoroutagehandlingsettingsdto)| |
|
|
14217
14248
|
|tags|Array<[SyntheticTagWithSourceDto](#synthetictagwithsourcedto)>|<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> |
|
|
@@ -15367,7 +15398,7 @@ The type of the asset.
|
|
|
15367
15398
|
|
|
15368
15399
|
<div class="padding-left--md">
|
|
15369
15400
|
|
|
15370
|
-
`Alert` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DqlLogMetric` | `DqlLogProcessingRule` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `LqlLogMetric` | `LqlLogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
15401
|
+
`Alert` | `AwsService` | `CustomCards` | `Dashboard` | `DeclarativeProcesses` | `DqlLogMetric` | `DqlLogProcessingRule` | `GenericRelationship` | `GenericType` | `ListScreenFilters` | `ListScreenInjections` | `ListScreenLayout` | `LogEvent` | `LogMetric` | `LogProcessingRule` | `LqlLogMetric` | `LqlLogProcessingRule` | `MetricMetadata` | `MetricQuery` | `ScreenActions` | `ScreenChartGroups` | `ScreenDqlTable` | `ScreenEntitiesLists` | `ScreenEventsCards` | `ScreenFilters` | `ScreenHealthCards` | `ScreenInjections` | `ScreenLayout` | `ScreenLogsCards` | `ScreenMessageCards` | `ScreenMetricTables` | `ScreenProblems` | `ScreenProperties`
|
|
15371
15402
|
|
|
15372
15403
|
</div>
|
|
15373
15404
|
|
|
@@ -15482,11 +15513,22 @@ The category of the recorded operation.
|
|
|
15482
15513
|
|
|
15483
15514
|
The type of the recorded operation.
|
|
15484
15515
|
|
|
15516
|
+
* `LOGIN` -> A user logged in
|
|
15517
|
+
* `LOGOUT` -> A user logged out
|
|
15518
|
+
* `CREATE` -> An object was created
|
|
15519
|
+
* `UPDATE` -> An object was updated
|
|
15520
|
+
* `DELETE` -> An object was deleted
|
|
15521
|
+
* `REVOKE` -> An Active Gate token was revoked
|
|
15522
|
+
* `TAG_ADD` -> A manual tag was added
|
|
15523
|
+
* `TAG_REMOVE` -> A manual tag was removed
|
|
15524
|
+
* `TAG_UPDATE` -> A manual tag was updated
|
|
15525
|
+
* `REMOTE_CONFIGURATION_MANAGEMENT` -> A Remote Configuration Management related operation occurred
|
|
15526
|
+
|
|
15485
15527
|
#### Enum keys
|
|
15486
15528
|
|
|
15487
15529
|
<div class="padding-left--md">
|
|
15488
15530
|
|
|
15489
|
-
`Create` | `Delete` | `
|
|
15531
|
+
`Create` | `Delete` | `Login` | `Logout` | `RemoteConfigurationManagement` | `Revoke` | `TagAdd` | `TagRemove` | `TagUpdate` | `Update`
|
|
15490
15532
|
|
|
15491
15533
|
</div>
|
|
15492
15534
|
|
|
@@ -15499,11 +15541,16 @@ The type of the recorded operation.
|
|
|
15499
15541
|
|
|
15500
15542
|
The type of the authentication of the **user**.
|
|
15501
15543
|
|
|
15544
|
+
* `USER_NAME` -> User was logged in the UI
|
|
15545
|
+
* `TOKEN_HASH` -> URL Token or DevOps Token, the hash of the token is logged
|
|
15546
|
+
* `SERVICE_NAME` -> No authenticated user at all, this action was performed by a system service automatically
|
|
15547
|
+
* `PUBLIC_TOKEN_IDENTIFIER` -> API Token, the public token id is logged
|
|
15548
|
+
|
|
15502
15549
|
#### Enum keys
|
|
15503
15550
|
|
|
15504
15551
|
<div class="padding-left--md">
|
|
15505
15552
|
|
|
15506
|
-
`PublicTokenIdentifier` | `
|
|
15553
|
+
`PublicTokenIdentifier` | `ServiceName` | `TokenHash` | `UserName`
|
|
15507
15554
|
|
|
15508
15555
|
</div>
|
|
15509
15556
|
|
|
@@ -17948,6 +17995,23 @@ Defines the actual set of fields depending on the value. See one of the followin
|
|
|
17948
17995
|
</div>
|
|
17949
17996
|
|
|
17950
17997
|
|
|
17998
|
+
</div>
|
|
17999
|
+
|
|
18000
|
+
### SyntheticMonitorPerformanceThresholdDtoAggregation
|
|
18001
|
+
|
|
18002
|
+
<div class="padding-left--md">
|
|
18003
|
+
|
|
18004
|
+
Aggregation type
|
|
18005
|
+
|
|
18006
|
+
#### Enum keys
|
|
18007
|
+
|
|
18008
|
+
<div class="padding-left--md">
|
|
18009
|
+
|
|
18010
|
+
`Auto` | `Avg` | `Count` | `Max` | `Median` | `Min` | `Sum` | `Value`
|
|
18011
|
+
|
|
18012
|
+
</div>
|
|
18013
|
+
|
|
18014
|
+
|
|
17951
18015
|
</div>
|
|
17952
18016
|
|
|
17953
18017
|
### SyntheticMonitorSummaryDtoType
|