• Home
  • API
  • Configuration
  • Notifications
  • GET a notification

Notifications API - GET a notification configuration

This API is deprecated. Use the Settings API instead. Look for the Problem notifications (builtin:problem.notifications) schema.

Gets parameters of the specified notification configuration.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/notifications/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/notifications/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/notifications/{id}

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required notification configuration.

pathrequired

Response

Response codes

CodeTypeDescription
200NotificationConfig

Success

Response body objects

The NotificationConfig object

Configuration of a notification. The actual set of fields depends on the type of the notification. See Notifications API - JSON models in Dynatrace Documentation for example models of every notification type.

ElementTypeDescription
idstring

The ID of the notification configuration.

namestring

The name of the notification configuration.

alertingProfilestring

The ID of the associated alerting profile.

activeboolean

The configuration is enabled (true) or disabled (false).

typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • EMAIL -> EmailNotificationConfig
  • PAGER_DUTY -> PagerDutyNotificationConfig
  • WEBHOOK -> WebHookNotificationConfig
  • SLACK -> SlackNotificationConfig
  • VICTOROPS -> VictorOpsNotificationConfig
  • SERVICE_NOW -> ServiceNowNotificationConfig
  • XMATTERS -> XMattersNotificationConfig
  • ANSIBLETOWER -> AnsibleTowerNotificationConfig
  • OPS_GENIE -> OpsGenieNotificationConfig
  • JIRA -> JiraNotificationConfig
  • TRELLO -> TrelloNotificationConfig
The element can hold these values
  • ANSIBLETOWER
  • EMAIL
  • JIRA
  • OPS_GENIE
  • PAGER_DUTY
  • SERVICE_NOW
  • SLACK
  • TRELLO
  • VICTOROPS
  • WEBHOOK
  • XMATTERS

Response body JSON model

json
{
  "type": "JIRA",
  "id": "acbed0c4-4ef1-4303-991f-102510a69322",
  "name": "REST example",
  "alertingProfile": "4f5e00f4-39b3-455a-820b-3514843615f3",
  "active": true,
  "username": "john.smith",
  "password": "",
  "url": "https://my-jira.atlassian.net/rest/api/2/",
  "projectKey": "DEV",
  "issueType": "Task",
  "summary": "Problem {ProblemID}: {ProblemTitle}",
  "description": "{ProblemDetailsText}"
}