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.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/notifications/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Parameter
Type
Description
In
Required
id
string

The ID of the required notification configuration.

path
required

Response

Response codes

Code
Type
Description
200

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.

Element
Type
Description
active
boolean

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

alertingProfile
string

The ID of the associated alerting profile.

id
string

The ID of the notification configuration.

name
string

The name of the notification configuration.

type
string

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
  • ANSIBLETOWER
  • EMAIL
  • JIRA
  • OPS_GENIE
  • PAGER_DUTY
  • SERVICE_NOW
  • SLACK
  • TRELLO
  • VICTOROPS
  • WEBHOOK
  • XMATTERS

Response body JSON model

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