Skip to content

Latest commit

 

History

History
146 lines (132 loc) · 31.6 KB

api_coverage.md

File metadata and controls

146 lines (132 loc) · 31.6 KB

NOTE: This a working document, mainly focused on Configuration APIs being covered by Settings 2.0 support or not. Information presented in this document does not represent the current coverage of Dynatrace APIs and is likely outdated. Please consult the official documentation for information about supported configuration types.

Configuration API

Endpoint Supported Scope Deprecated by Settings v2 Can be downloaded
/api/config/v1/alertingProfiles ✔️ builtin:alerting.profile
/api/config/v1/anomalyDetection/applications ✔️ builtin:anomaly-detection.rum-web / -mobile
/api/config/v1/anomalyDetection/aws ✔️ builtin:anomaly-detection.infrastructure-aws
/api/config/v1/anomalyDetection/databaseServices ✔️ builtin:anomaly-detection.databases
/api/config/v1/anomalyDetection/diskEvents ✔️ builtin:anomaly-detection.infrastructure-disks
/api/config/v1/anomalyDetection/hosts ✔️ builtin:anomaly-detection.infrastructure-hosts
/api/config/v1/anomalyDetection/metricEvents ✔️ builtin:anomaly-detection.metric-events
/api/config/v1/anomalyDetection/processGroups/{id} via Settings 2.0 PG meId builtin:availability.process-group-alerting (unsupported API)
/api/config/v1/anomalyDetection/services ✔️ builtin:anomaly-detection.services
/api/config/v1/anomalyDetection/vmware ✔️ builtin:anomaly-detection.infrastructure-vmware
/api/config/v1/autoTags ✔️ builtin:tags.auto-tagging
/api/config/v1/aws/credentials ✔️ NO NO
/api/config/v1/aws/credentials/{id}/services NO aws-cred UUID NO (unsupported API)
/api/config/v1/aws/privatelink NO NO (unsupported API)
/api/config/v1/aws/privatelink/allowlistedAccounts/{id} NO privatelink UUID NO (unsupported API)
/api/config/v1/azure/credentials ✔️ NO NO
/api/config/v1/azure/credentials/{id}/services NO azure-cred UUID NO (unsupported API)
/api/config/v1/calculatedMetrics/log ✔️ X
/api/config/v1/calculatedMetrics/mobile ✔️ X
/api/config/v1/calculatedMetrics/service ✔️ X
/api/config/v1/calculatedMetrics/synthetic ✔️ X
/api/config/v1/calculatedMetrics/rum ✔️ X
/api/config/v1/cloudFoundry/credentials via Settings 2.0 builtin:cloud.cloudfoundry (unsupported API)
/api/config/v1/conditionalNaming/host ✔️ NO
/api/config/v1/conditionalNaming/processGroup ✔️ NO
/api/config/v1/conditionalNaming/service ✔️ NO
/api/config/v1/credentials ✔️ X (but by /api/v2/credentials) NO
/api/config/v1/dashboards ✔️ X
/api/config/v1/dashboards/{id}/shareSettings NO dashboard UUID X (unsupported API)
/api/config/v1/dataPrivacy ✔️ builtin:preferences.privacy
/api/config/v1/extensions ✔️ X NO
/api/config/v1/extensions/dynatrace.python.elasticsearch/global ✔️ X NO
/api/config/v1/frequentIssueDetection ✔️ builtin:anomaly-detection.frequent-issues
/api/config/v1/kubernetes/credentials ✔️ builtin:cloud.kubernetes NO
/api/config/v1/maintenanceWindows ✔️ builtin:alerting.maintenance-window
/api/config/v1/managementZones ✔️ builtin:management-zones
/api/config/v1/notifications ✔️ builtin:problem.notifications
/api/config/v1/hosts/autoupdate ✔️ builtin:deployment.oneagent.updates (environment scope)
/api/config/v1/hostgroups/{id} via Settings 2.0 host-group meId builtin:deployment.oneagent.updates (host-group scope) (unsupported API)
/api/config/v1/hosts/{id} via Settings 2.0 host meId builtin:deployment.oneagent.updates (host scope) (unsupported API)
/api/config/v1/plugins NO X (unsupported API)
/api/config/v1/remoteEnvironments via Settings 2.0 builtin:remote.environment (unsupported API)
/api/config/v1/reports ✔️ X
/api/config/v1/allowedBeaconOriginsForCors ✔️ builtin:rum.web.beacon-domain-origins
/api/config/v1/applicationDetectionRules ✔️ builtin:rum.web.app-detection
/api/config/v1/applicationDetectionRules/hostDetection ✔️ builtin:rum.host-headers
/api/config/v1/contentResources ✔️ builtin:rum.provider-breakdown
/api/config/v1/geographicRegions/ipDetectionHeaders ✔️ builtin:rum.ip-mappings
/api/config/v1/geographicRegions/ipAddressMappings ✔️ builtin:rum.ip-determination
/api/config/v1/applications/mobile ✔️ X
/api/config/v1/applications/mobile/{id}/keyUserActions NO app meId X/PARTIAL - creation of keyUserActions here, configuration in scope on an action (APPLICATION_METHOD) via Settings builtin:anomaly-detection.rum-mobile, builtin:rum.mobile.key-performance-metrics (unsupported API)
/api/config/v1/applications/mobile/{id}/userActionAndSessionProperties NO app meId builtin:anomaly-detection.rum-mobile, builtin:rum.mobile.key-performance-metrics (Settings in scope of APPLICATION_METHODs - only written if different to App default) (unsupported API)
/api/config/v1/symfiles NO app meId ? (unsupported API)
/api/config/v1/applications/web ✔️ X
/api/config/v1/applications/web/{id}/dataPrivacy via Settings 2.0 app meId builtin:preferences.privacy (unsupported API)
/api/config/v1/applications/web/{id}/errorRules via Settings 2.0 app meId builtin:rum.web.request-errors (unsupported API)
/api/config/v1/applications/web/{id}/keyUserActions NO app meId X/PARTIAL - creation of keyUserActions here, configuration in scope on an action (APPLICATION_METHOD) via Settings builtin:anomaly-detection.rum-mobile, builtin:rum.mobile.key-performance-metrics (unsupported API)
/api/config/v1/service/customServices/java ✔️ X
/api/config/v1/service/customServices/dotnet ✔️ X
/api/config/v1/service/customServices/go ✔️ X
/api/config/v1/service/customServices/nodejs ✔️ X
/api/config/v1/service/customServices/php ✔️ X
/api/config/v1/service/customServices/{type}/order NO service UUIDs X (unsupported API)
/api/config/v1/service/detectionRules/FULL_WEB_REQUEST ✔️ builtin:service-detection.full-web-request
/api/config/v1/service/detectionRules/FULL_WEB_REQUEST/order NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/detectionRules/FULL_WEB_SERVICE ✔️ builtin:service-detection.full-web-service
/api/config/v1/service/detectionRules/FULL_WEB_SERVICE/order NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_REQUEST ✔️ builtin:service-detection.external-web-request
/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_REQUEST/order NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE ✔️ builtin:service-detection.external-web-service
/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/failureDetection/parameterSelection/parameterSets ✔️ builtin:failure-detection.environment.parameters
/api/config/v1/service/failureDetection/parameterSelection/rules ✔️ builtin:failure-detection.environment.rules
/api/config/v1/service/failureDetection/parameterSelection/rules/reorderRules NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/requestAttributes ✔️ builtin:request-attributes
/api/config/v1/service/requestNaming ✔️ X (in dev? builtin:unified-request-name-ruleset)
/api/config/v1/service/requestNaming/order NO rule UUIDs (settings ordering) (unsupported API)
/api/config/v1/service/resourceNaming ✔️ X (in dev? builtin:unified-request-name-ruleset)

Environment API v1

Most environment APIs are not 'configuration' - this list only contains APIs that clearly fall into scope of monitoring config as code.

Endpoint Supported Deprecated by Settings v2
/api/v1/synthetic/locations ✔️
/api/v1/synthetic/monitors ✔️

Topology & Smartscape APIs might fall into scope of monaco - however they can ONLY be used to manually set tags on monitored entities, and will need dedicated implementation to work. Assumption: No need to support, auto-tagging as preferred "as code" configuration of tags.

Environment API v2

Endpoint Description Supported Scope
/api/v2/slo SLOs ✔️
/api/v2/activeGates/{id}/autoUpdate Auto-update config for specific env active gate NO AG ID (special)
/api/v2/activeGates/autoUpdate Global auto-update config for env active gates NO
/api/v2/credentials New credential vault API NO
/api/v2/extensions Extension 2.0 upload and configuration NO
/api/v2/networkZones Specific and global networkzone settings NO
/api/v2/settings Settings 2.0 NO
/api/v2/synthetic Global synthetic settings and v2 locations API NO

Summarized List of currently unsupported Config APIs

This list contains Config v1 and Environment v2 APIs that are not currently supported by Dynatrace Configuration as Code. Differing from the main list above, this does not list configuration types that became supported via Settings 2.0 schemas that have replaced their Config API.

Endpoint Default API Pattern
/api/v2/activeGates/{id}/autoUpdate X
/api/v2/activeGates/autoUpdate X
/api/v2/extensions X - but similar to v1 extensions
/api/v2/networkZones ~ (no POST)
/api/v2/synthetic ✔️
/api/config/v1/aws/credentials/{id}/services X
/api/config/v1/aws/privatelink X
/api/config/v1/aws/privatelink/allowlistedAccounts/{id} X
/api/config/v1/azure/credentials/{id}/services X
/api/config/v1/dashboards/{id}/shareSettings X (entity scoped config/v1 pattern)
/api/config/v1/plugins X - but similar to v1 extensions
/api/config/v1/service/customServices/{type}/order X (ordering - payload containing IDs)
/api/config/v1/symfiles X
/api/config/v1/applications/mobile/{id}/keyUserActions X (entity scoped config/v1 pattern)
/api/config/v1/applications/mobile/{id}/userActionAndSessionProperties X (entity scoped config/v1 pattern)
/api/config/v1/applications/web/{id}/keyUserActions X (entity scoped config/v1 pattern)
/api/config/v1/service/requestNaming/order X (ordering - payload containing IDs)

Unsupported Settings 2.0 API features

  • Defining ordering of Settings via the 'insertAfter' API property.