Use the following APIs to create, update, get, and delete notification destinations.

Create a Notification Destination

Required Permissions

You must have the Create Notification Destination permission to perform this operation.

API
/api/notification-destinations
Method
POST
Required Parameters
Name Description
name

string

Name of the notification destination. (Mandatory)
description

string

Brief description about the notification destination. (Optional)
protocol

string

  • HTTP (Mandatory)

Use the HTTP protocol to notify to an HTTP destination.

sslTlsVersion

string

  • NO_CERT: Use this option if the destination is non-TLS.
  • TLS1_2: Use this option if the destination is TLS.
(Mandatory)
certificate

string

Certificate of the destination.

Mandatory if sslTlsVersion is other than NO_CERT.

host

string

Hostname or IP address of the destination. (Mandatory)
port

string

Port number of the destination. (Mandatory)
authenticationType

string

  • NO_AUTH: Use this option if the destination does not require any authentication.
  • BASIC: Use this option if the destination requires basic authentication.
(Mandatory)
username

string

User name.

User name is mandatory if authenticationType is BASIC.

password

string

Password.

Password is mandatory if authenticationType is BASIC.

Input Example for HTTP Create Notification Destination
{  
  "name": "SampleHttpNotificationDestination",
  "description": "This is a sample Http Notification Destination",
  "protocol": "HTTP",
  "sslTlsVersion": "NO_CERT",
  "host": "10.10.10.10",
  "port": 8080,
  "authenticationType": "NO_AUTH"
}
Sample HTTP Response for Create Notification Destination
{
  "id": "5bf29d8178d80c88c25ed713"
}

Get Notification Destination

Required Permissions

You must have the View Notification Destination permission to perform this operation.

API
/api/notification-destinations/{id}
Method
GET
Required Parameters
Name Description
id

string

Notification Destination ID.
Sample HTTP Response for Get Notification Destination
{
  "id": "5bf29d8178d80c88c25ed713",
  "name": "SampleHttpNotificationDestination",
  "description": "This is a sample notification destination",
  "protocol": "HTTP",
  "sslTlsVersion": "NO_CERT",
  "host": "10.10.10.10",
  "port": 8080,
  "authenticationType": "NO_AUTH",
  "tenantId": "5beaa559a40a82f457340c4d",
  "createdTime": "1542622479525",
  "lastUpdatedTime": "1542622479525",
  "createdBy": "sysadmin@vmware.com",
  "lastUpdatedBy": "sysadmin@vmware.com",
  "updateVersion": 1
}

Update Notification Destination

Required Permissions

You must have the Edit Notification Destination permission to perform this operation.

API
/api/notification-destinations/{id}
Method
PUT
Required Parameters
Name Description
id

string

Notification destination ID. (Mandatory)
name

string

Name of the notification destination. (Optional)
description

string

Brief description about the notification destination. (Optional)
sslTlsVersion

string

  • NO_CERT: Use this option if the destination is non-TLS.
  • TLS1_2: Use this option if the destination is TLS.
(Mandatory)
certificate

string

Certificate of the destination.

Mandatory if sslTlsVersion is other than NO_CERT.

host

string

Hostname or IP address of the destination. (Optional)
port

string

Port number of the destination. (Optional)
authenticationType

string

  • NO_AUTH: Use this option if the destination does not require any authentication.
  • BASIC: Use this option if the destination requires basic authentication.
(Optional)
username

string

User name.

User name is mandatory if authenticationType is BASIC.

password

string

Password.

Password is mandatory if authenticationType is BASIC.

Input Example for HTTP Update Notification Destination
{
  "id" : "5bf29d8178d80c88c25ed713",
  "name": "SampleHttpNotificationDestination",
  "description": "This is updated sample Http Notification Destination"
}
Response
{
  "id": "string"
}

Delete Notification Destination

Required Permissions

You must have the Delete Notification Destination permission to perform this operation.

API
/api/notification-destinations/{id}
Method
DELETE
Required Parameters
Name Description
id

string

Notification destination ID. (Mandatory)
Response
{}

List All Notification Destinations

Required Permissions

You must have the View Notification Destination permission to perform this operation.

API
/api/notification-destinations
Method
GET
Required Parameters
None
Sample HTTP Response for List All Notification Destinations
{
  "notificationDestinations": [
    {
      "id": "5bf29d8178d80c88c25ed713",
      "name": "SampleHttpNotificationDestination",
      "description": "This is a sample notification destination",
      "protocol": "HTTP",
      "sslTlsVersion": "NO_CERT",
      "host": "10.10.10.10",
      "port": 8080,
      "authenticationType": "NO_AUTH",
      "tenantId": "5beaa559a40a82f457340c4d",
      "createdTime": "1542622479525",
      "lastUpdatedTime": "1542622479525",
      "createdBy": "sysadmin@vmware.com",
      "lastUpdatedBy": "sysadmin@vmware.com",
      "updateVersion": 1
    },
    {
      "id": "9as29d8178d91c88c25sx670",
      "name": "SampleSmtpNotificationDestination",
      "protocol": "SMTP",
      "tenantId": "5beaa559a40a82f457340c4d",
      "createdTime": "1542303267549",
      "lastUpdatedTime": "1542303380545",
      "createdBy": "sysadmin@vmware.com",
      "lastUpdatedBy": "sysadmin@vmware.com",
      "updateVersion": 2
    }
  ],
  "pageInfo": {
    "page": 1,
    "pageSize": 10,
    "totalElements": "2",
    "totalPages": "1"
  }
}