Alerting profiles API - GET a profile

Gets the parameters of the specified alerting profile.

The request produces an application/json payload.

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

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/alertingProfiles/{id}
  • SaaS https://{your-environment-id}{id}


Parameter Type Description In Required
id string

The ID of the required alerting profile.

path required

Response format

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
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

The ID of the alerting profile.

displayName string

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

rules AlertingProfileSeverityRule[]

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

managementZoneId integer

The ID of the management zone.

eventTypeFilters AlertingEventTypeFilter[]

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

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
predefinedEventFilter AlertingPredefinedEventFilter

The predefined event filter.

customEventFilter AlertingCustomEventFilter

The custom event filter.

The AlertingCustomEventFilter object

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

Element Type Description
customTitleFilter AlertingCustomTextFilter

The filter, that checks the title of the event.

customDescriptionFilter AlertingCustomTextFilter

The filter, that checks the description of the event.

The AlertingCustomTextFilter object

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

Element Type Description
enabled boolean

If true, the filter is enabled.

value string

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

operator string

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

negate boolean

If true, the filter result is inverted.

caseInsensitive boolean

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

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
eventType string

The event type, to filter by.

negate boolean

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

The AlertingProfileSeverityRule object

Defines filters on a severity-level base.

Element Type Description
severityLevel string

The severity level, to filter by.

tagFilter AlertingProfileTagFilter

The tag filter, to filter by.

delayInMinutes integer

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

The AlertingProfileTagFilter object

Allows filtering of problems by their associated tags.

Element Type Description
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.

tagFilters TagFilter[]

The list of tag filters.

The TagFilter object

A common filter for tags on entities.

Element Type Description
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).

key string

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

value string

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

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.