Alerting profiles API - PUT a profile

Updates the specified alerting profile. If an alerting profile with the specified ID doesn't exist, a new profile is created.

The request consumes and produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/alertingProfiles/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/alertingProfiles/{id}

Parameters

Parameter Type Description In Required
id string

The ID of the alerting profile to be updated.

path required
body AlertingProfile

JSON body of the request, containing updated parameters of the new alerting profile.

body optional

The AlertingProfile object

Config of an alerting profile. Defines the rules and filters. An alerting profile applies only if all conditions are fulfilled.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

The ID of the alerting profile.

optional
displayName string

The name of the alerting profile, which is displayed in the UI.

required
rules AlertingProfileSeverityRule[]

The list of severity rules. Each rule is evaluated independently of all other rules.

optional
managementZoneId integer

The ID of the management zone.

optional
eventTypeFilters AlertingEventTypeFilter[]

The list of event filters. Each rule is evaluated independently of all other rules.

optional

The AlertingEventTypeFilter object

Filters by either using a predefined filter or by creating a custom filter. The two options are mutually exclusive, so only exactly 1 option is valid.

Element Type Description Required
predefinedEventFilter AlertingPredefinedEventFilter

The predefined event filter.

optional
customEventFilter AlertingCustomEventFilter

The custom event filter.

optional

The AlertingCustomEventFilter object

Defines a custom event filter, that allows filtering by the type or description of an event or both.

Element Type Description Required
customTitleFilter AlertingCustomTextFilter

The filter, that checks the title of the event.

optional
customDescriptionFilter AlertingCustomTextFilter

The filter, that checks the description of the event.

optional

The AlertingCustomTextFilter object

Defines a filter, that checks if a piece of texts matches its condition.

Element Type Description Required
enabled boolean

If true, the filter is enabled.

required
value string

The value, that the filter searches for in the text.

required
operator string

The ComparisonOperator, that the filter applies on the value and the text.

The operator element can hold these values.
required
negate boolean

If true, the filter result is inverted.

required
caseInsensitive boolean

If true, the filter ignores the case of the characters.

required

The AlertingPredefinedEventFilter object

Defines a predefined event filter. Events are considered as predefined if they have not been created by customer interaction.

Element Type Description Required
eventType string

The event type, to filter by.

The eventType element can hold these values.
required
negate boolean

If true, events must not have this event type to qualify.

required

The AlertingProfileSeverityRule object

Defines filters on a severity-level base.

Element Type Description Required
severityLevel string

The severity level, to filter by.

The severityLevel element can hold these values.
required
tagFilter AlertingProfileTagFilter

The tag filter, to filter by.

required
delayInMinutes integer

The delay, after which, if the problem is still open, a notification will be generated.

required

The AlertingProfileTagFilter object

Allows filtering of problems by their associated tags.

Element Type Description Required
includeMode string

Defines whether a problem has to contain any or all of the specified tags or if the tag filtering should be turned off.

The includeMode element can hold these values.
required
tagFilters TagFilter[]

The list of tag filters.

optional

The TagFilter object

A common filter for tags on entities.

Element Type Description Required
context string

The tag origin (such as AWS or Cloud Foundry), which is the first part of the unique key of the tag (the second part is key).

The context element can hold these values.
required
key string

The tag key, which is the second part of the unique key of the tag (the first part is context).

required
value string

The value of the tag. Not applicable to custom tags.

optional

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the operator element in the AlertingCustomTextFilter object:

  • BEGINS_WITH
  • CONTAINS
  • CONTAINS_REGEX
  • ENDS_WITH
  • EQUALS

Possible values for the eventType element in the AlertingPredefinedEventFilter object:

  • APPLICATION_ERROR_RATE_INCREASED
  • APPLICATION_SLOWDOWN
  • APPLICATION_UNEXPECTED_HIGH_LOAD
  • APPLICATION_UNEXPECTED_LOW_LOAD
  • AWS_LAMBDA_HIGH_ERROR_RATE
  • CUSTOM_APPLICATION_ERROR_RATE_INCREASED
  • CUSTOM_APPLICATION_SLOWDOWN
  • CUSTOM_APPLICATION_UNEXPECTED_HIGH_LOAD
  • CUSTOM_APPLICATION_UNEXPECTED_LOW_LOAD
  • CUSTOM_APP_CRASH_RATE_INCREASED
  • DATABASE_CONNECTION_FAILURE
  • DATA_CENTER_SERVICE_PERFORMANCE_DEGRADATION
  • DATA_CENTER_SERVICE_UNAVAILABLE
  • EBS_VOLUME_HIGH_LATENCY
  • EC2_HIGH_CPU
  • ELB_HIGH_BACKEND_ERROR_RATE
  • ENTERPRICE_APPLICATION_PERFORMANCE_DEGRADATION
  • ENTERPRISE_APPLICATION_UNAVAILABLE
  • ESXI_GUEST_ACTIVE_SWAP_WAIT
  • ESXI_GUEST_CPU_LIMIT_REACHED
  • ESXI_HOST_CPU_SATURATION
  • ESXI_HOST_DATASTORE_LOW_DISK_SPACE
  • ESXI_HOST_DISK_QUEUE_SLOW
  • ESXI_HOST_DISK_SLOW
  • ESXI_HOST_MEMORY_SATURATION
  • ESXI_HOST_NETWORK_PROBLEMS
  • ESXI_HOST_OVERLOADED_STORAGE
  • ESXI_VM_IMPACT_HOST_CPU_SATURATION
  • ESXI_VM_IMPACT_HOST_MEMORY_SATURATION
  • EXTERNAL_SYNTHETIC_TEST_OUTAGE
  • EXTERNAL_SYNTHETIC_TEST_SLOWDOWN
  • HOST_OF_SERVICE_UNAVAILABLE
  • HTTP_CHECK_GLOBAL_OUTAGE
  • HTTP_CHECK_LOCAL_OUTAGE
  • HTTP_CHECK_TEST_LOCATION_SLOWDOWN
  • MOBILE_APPLICATION_ERROR_RATE_INCREASED
  • MOBILE_APPLICATION_SLOWDOWN
  • MOBILE_APPLICATION_UNEXPECTED_HIGH_LOAD
  • MOBILE_APPLICATION_UNEXPECTED_LOW_LOAD
  • MOBILE_APP_CRASH_RATE_INCREASED
  • MONITORING_UNAVAILABLE
  • OSI_DISK_LOW_INODES
  • OSI_GRACEFULLY_SHUTDOWN
  • OSI_HIGH_CPU
  • OSI_HIGH_MEMORY
  • OSI_LOW_DISK_SPACE
  • OSI_NIC_DROPPED_PACKETS_HIGH
  • OSI_NIC_ERRORS_HIGH
  • OSI_NIC_UTILIZATION_HIGH
  • OSI_SLOW_DISK
  • OSI_UNEXPECTEDLY_UNAVAILABLE
  • PGI_OF_SERVICE_UNAVAILABLE
  • PGI_UNAVAILABLE
  • PG_LOW_INSTANCE_COUNT
  • PROCESS_CRASHED
  • PROCESS_HIGH_GC_ACTIVITY
  • PROCESS_MEMORY_RESOURCE_EXHAUSTED
  • PROCESS_NA_HIGH_CONN_FAIL_RATE
  • PROCESS_NA_HIGH_LOSS_RATE
  • PROCESS_THREADS_RESOURCE_EXHAUSTED
  • RDS_HIGH_CPU
  • RDS_HIGH_LATENCY
  • RDS_LOW_MEMORY
  • RDS_LOW_STORAGE_SPACE
  • RDS_OF_SERVICE_UNAVAILABLE
  • RDS_RESTART_SEQUENCE
  • SERVICE_ERROR_RATE_INCREASED
  • SERVICE_SLOWDOWN
  • SERVICE_UNEXPECTED_HIGH_LOAD
  • SERVICE_UNEXPECTED_LOW_LOAD
  • SYNTHETIC_GLOBAL_OUTAGE
  • SYNTHETIC_LOCAL_OUTAGE
  • SYNTHETIC_TEST_LOCATION_SLOWDOWN

Possible values for the context element in the TagFilter object:

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES

Possible values for the includeMode element in the AlertingProfileTagFilter object:

  • INCLUDE_ALL
  • INCLUDE_ANY
  • NONE

Possible values for the severityLevel element in the AlertingProfileSeverityRule object:

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Response codes

Code Description
201

Success. The new alerting profile has been created. The response contains the ID of the new alerting profile.

204

Success. The alerting profile has been updated. Response doesn't have a body.

400

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

This request is an early adopter release and may be changed in non compatible way.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/alertingProfiles/{id}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/alertingProfiles/{id}/validator

Response codes

Code Description
204 Validated. The submitted alerting profile is valid. Response does not have a body
400 Failed. The input is invalid.