Edit Notification Service

Edit online

Configure edit Notification Service API.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit Notification Service API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editNotificationService.adm HTTP/1.1 Host:{manager.dsnet} enabled={true|false}

Curl method

Edit online
curl -X POST -u <USERNAME>:<PASSWORD> --header "Content-Type: application/x-www-form-urlencoded" --header "Accept: application/json" 'http://{manager.dsnet}/manager/api/json/1.0/editNotificationService.adm' -d 'action=add&name=<name>&hosts=<hosts>&topic=<topic>&usingIbmSpectrumDiscover=false&authenticated=false&tlsEnabled=false&enabled=true'

Parameters

Edit online
Table 2. Request parameters for Edit Notification Service API method
Parameter Type Usage Default Description
action String Required   Specifies the operation to be performed with Notification Service.
id Long Required   The ID of an existing Notification Service in the system.
name String Optional   The name of the Notification Service.
hosts List Optional   The list of Apache Kafka endpoints.
defaultTopic String Optional   The default topic of the Notification Service.
usingIbmSpectrumDiscover Boolean Optional   Specify "true" if using IBM Spectrum Discover.
authenticated Boolean Optional   Specify "true" if using authentication.
username String Optional   When authenticated is "true", specify username.
password String Optional   When authenticated is "true", specify password.
tlsEnabled Boolean Optional   Specify "true" TLS for encryption.
certificatePem String Optional   When tlsEnabled is "true", specify certificate.
enabled Boolean Optional   The state of Notification Service.