Notifications API - PUT a notification configuration

Updates the specified notification configuration.

If a notification configuration with the specified ID doesn't exist, a new configuration is created.

The request consumes and produces an application/json payload.

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

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the notification configuration to be updated. If you set the ID in the body as well, it must match this ID.	path	required
body	NotificationConfig	The JSON body of the request. Contains updated parameters of the notification configuration.	body	optional

Parameter

Type

Description

Required

string

The ID of the notification configuration to be updated.

If you set the ID in the body as well, it must match this ID.

path

required

body

NotificationConfig

The JSON body of the request. Contains updated parameters of the notification configuration.

body

optional

Body format

Request parameters JSON model

The NotificationConfig object

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

Element	Type	Description	Required
id	string	The ID of the notification configuration.	optional
name	string	The name of the notification configuration.	required
alertingProfile	string	The ID of the associated alerting profile.	required
active	boolean	The configuration is enabled (`true`) or disabled (`false`).	required
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 `HIPCHAT` -> HipChatNotificationConfig `VICTOROPS` -> VictorOpsNotificationConfig `SERVICE_NOW` -> ServiceNowNotificationConfig `XMATTERS` -> XMattersNotificationConfig `ANSIBLETOWER` -> AnsibleTowerNotificationConfig `OPS_GENIE` -> OpsGenieNotificationConfig `JIRA` -> JiraNotificationConfig `TRELLO` -> TrelloNotificationConfig The element can hold these values ANSIBLETOWER EMAIL HIPCHAT JIRA OPS_GENIE PAGER_DUTY SERVICE_NOW SLACK TRELLO VICTOROPS WEBHOOK XMATTERS	required

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "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}\n"
}

Response

Response codes

Code	Description
201	Success. The new notification configuration has been created. The response contains the ID of the new notification configuration.
204	Success. The notification configuration has been updated. The response doesn't have a body.
400	Failed. The input is invalid.

Response body

Response parameters JSON model

The NotificationConfigStub object

The short representation of a notification.

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.
type	string	The type of the notification. The element can hold these values ANSIBLETOWER EMAIL HIPCHAT JIRA OPS_GENIE PAGER_DUTY SERVICE_NOW SLACK TRELLO VICTOROPS WEBHOOK XMATTERS

    
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "ANSIBLETOWER"
}

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.

The request consumes an application/json payload.

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

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code	Description
204	Validated. The submitted configuration is valid. The response doesn't have a body
400	Failed. The input is invalid.

Response body

A successful request doesn't return any content.