Settings API - Cloud health alerts settings schema table

  • Published Mar 06, 2026

Cloud health alerts settings (builtin:health-experience.cloud-alert)

Cloud health alerts settings for AWS services

Schema IDSchema groupsScope
builtin:health-experience.cloud-alert-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:health-experience.cloud-alert
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:health-experience.cloud-alert
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:health-experience.cloud-alert

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Enabled
enabled
boolean-Required
Alert key
alertKey
enum
The element has these enums
  • AWS_ECS_CLUSTER.CpuUtilizationHigh.alert
  • AWS_ECS_CLUSTER.MemoryUtilizationHigh.alert
  • AWS_ECS_CLUSTER.MemoryReservationHigh.warning
  • AWS_ECS_CLUSTER.CpuReservationHigh.warning
  • AWS_ELASTICACHE_CACHECLUSTER.MemoryUtilizationHigh.alert
  • AWS_RDS_DBINSTANCE.InstanceCpuUtilizationHigh.alert
  • AWS_DYNAMODB_TABLE.ThrottledRequestsHigh.warning
  • AWS_RDS_DBCLUSTER.AuroraCpuUtilizationHigh.alert
  • AWS_LAMBDA_FUNCTION.ThrottlesHigh.warning
  • AWS_LAMBDA_FUNCTION.ErrorRate.alert
  • AWS_CLOUDFRONT_DISTRIBUTION.5xxErrorRateHigh.alert
  • AWS_APIGATEWAYV2_API.5xxErrorRateHigh.alert
  • AWS_EC2_VPCENDPOINT.PacketsDroppedHigh.alert
  • AWS_EC2_NATGATEWAY.PacketsDroppedHigh.alert
  • AWS_ELASTICLOADBALANCINGV2_LOADBALANCER.Alb5xxErrorsHigh.alert
  • AWS_ROUTE53_HEALTHCHECK.HealthCheckStatusFailures.warning
  • AWS_ELASTICLOADBALANCINGV2_LOADBALANCER.NlbRejectedFlowsHigh.warning
  • AWS_ELASTICLOADBALANCINGV2_LOADBALANCER.AlbRejectedConnectionsHigh.warning
  • AWS_EVENTS_EVENTBUS.ThrottlingRateHigh.warning
  • AWS_EVENTS_EVENTBUS.SuccessfulInvocationRateLow.alert
  • AWS_EC2_TRANSITGATEWAY.TransitGatewayPacketDropRateHigh.alert
  • AWS_EKS_CLUSTER.SchedulerErrorRateHigh.alert
  • AWS_EKS_CLUSTER.ApiServer5xxErrorRateHigh.alert
  • AWS_SQS_QUEUE.VisibleMessagesHigh.warning
  • AWS_SNS_TOPIC.FailedNotificationRateHigh.alert
  • AWS_EC2_INSTANCE.StatusCheckFailure.alert
  • AWS_EC2_INSTANCE.CpuUtilizationHigh.alert
Required
Static threshold alert
staticAlert
StaticThresholdAlert-Required
Auto adaptive alert
adaptiveAlert
AutoAdaptiveAlert-Required
Environment
environment
text-Required
Actor
actor
text

The user for which the alert gets executed

Required
Region filters
regionFilters
set-Required
The StaticThresholdAlert object
PropertyTypeDescriptionRequired
Alert threshold
threshold
float-Required
The AutoAdaptiveAlert object
PropertyTypeDescriptionRequired
Number of signal fluctuations
numberOfSignalFluctuations
integer-Required